1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_frame_XModuleManager_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_frame_XModuleManager_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 36*cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 37*cdf0e10cSrcweir#endif 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir#ifndef __com_sun_star_frame_UnknownModuleException_idl__ 40*cdf0e10cSrcweir#include <com/sun/star/frame/UnknownModuleException.idl> 41*cdf0e10cSrcweir#endif 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir//=============================================== 44*cdf0e10cSrcweir 45*cdf0e10cSrcweirmodule com { module sun { module star { module frame { 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir//=============================================== 48*cdf0e10cSrcweir/** can be used to identify office modules. 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir @since OOo 2.0 51*cdf0e10cSrcweir */ 52*cdf0e10cSrcweirpublished interface XModuleManager : com::sun::star::uno::XInterface 53*cdf0e10cSrcweir{ 54*cdf0e10cSrcweir //------------------------------------------- 55*cdf0e10cSrcweir /** 56*cdf0e10cSrcweir @short identifies the given module. 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir @descr This identifier can then be used at the service <type>ModuleManager</type> 59*cdf0e10cSrcweir to get more information about this module. 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir For identification the interface <type scope="com::sun::star::lang">XServiceInfo</type> 62*cdf0e10cSrcweir is requested on the given module. Because all module service registrations must be unique 63*cdf0e10cSrcweir this value can be queried and checked against the configuration. 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir Since OOo 2.3.0 also the optional interface <type>XModule</type> will be used. 66*cdf0e10cSrcweir If its exists it will be preferred. 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir @param Module 69*cdf0e10cSrcweir Possible objects for this parameter can be the following one: 70*cdf0e10cSrcweir <ul> 71*cdf0e10cSrcweir <li> 72*cdf0e10cSrcweir <b><type scope="com::sun::star::frame">XFrame</type></b><br> 73*cdf0e10cSrcweir A frame contains (against a component window) a controller. 74*cdf0e10cSrcweir Such controller represent the module (in case no model exists). 75*cdf0e10cSrcweir </li> 76*cdf0e10cSrcweir <li> 77*cdf0e10cSrcweir <b><type scope="com::sun::star::frame">XController</type></b><br> 78*cdf0e10cSrcweir A controller can be bound to a model. Then the model represent the module. 79*cdf0e10cSrcweir If no model exists - the controller is used for identification. 80*cdf0e10cSrcweir </li> 81*cdf0e10cSrcweir <li> 82*cdf0e10cSrcweir <b><type scope="com::sun::star::frame">XModel</type></b><br> 83*cdf0e10cSrcweir A model represent a module everytimes and can be used for 84*cdf0e10cSrcweir identification directly. 85*cdf0e10cSrcweir </li> 86*cdf0e10cSrcweir </ul> 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> 89*cdf0e10cSrcweir if the parameter Module is: 90*cdf0e10cSrcweir <ul> 91*cdf0e10cSrcweir <li>an empty one</li> 92*cdf0e10cSrcweir <li>or does not provide one of the needed interface 93*cdf0e10cSrcweir XFrame, XControllerm, XModel</li> 94*cdf0e10cSrcweir <li>or does not provide the needed interface XServiceInfo.</li> 95*cdf0e10cSrcweir </ul> 96*cdf0e10cSrcweir 97*cdf0e10cSrcweir @throws <type>UnknownModuleException</type> 98*cdf0e10cSrcweir if the given module could not be identified. 99*cdf0e10cSrcweir Note: If the module represent a XFrame instance with does not contain 100*cdf0e10cSrcweir a document, this exception is thrown too! 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir @return An identifier for the given module. 103*cdf0e10cSrcweir Note: This value is valie everytimes. Error will be transported 104*cdf0e10cSrcweir by thrown exceptions! 105*cdf0e10cSrcweir */ 106*cdf0e10cSrcweir string identify( [in] ::com::sun::star::uno::XInterface Module ) 107*cdf0e10cSrcweir raises(::com::sun::star::lang::IllegalArgumentException, 108*cdf0e10cSrcweir UnknownModuleException ); 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir}; 112*cdf0e10cSrcweir 113*cdf0e10cSrcweir}; }; }; }; 114*cdf0e10cSrcweir 115*cdf0e10cSrcweir#endif 116