| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef __com_sun_star_frame_XModuleManager_idl__ |
| #define __com_sun_star_frame_XModuleManager_idl__ |
| |
| #ifndef __com_sun_star_uno_XInterface_idl__ |
| #include <com/sun/star/uno/XInterface.idl> |
| #endif |
| |
| #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ |
| #include <com/sun/star/lang/IllegalArgumentException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_frame_UnknownModuleException_idl__ |
| #include <com/sun/star/frame/UnknownModuleException.idl> |
| #endif |
| |
| //=============================================== |
| |
| module com { module sun { module star { module frame { |
| |
| //=============================================== |
| /** can be used to identify office modules. |
| |
| @since OpenOffice 2.0 |
| */ |
| published interface XModuleManager : com::sun::star::uno::XInterface |
| { |
| //------------------------------------------- |
| /** |
| @short identifies the given module. |
| |
| @descr This identifier can then be used at the service <type>ModuleManager</type> |
| to get more information about this module. |
| |
| For identification the interface <type scope="com::sun::star::lang">XServiceInfo</type> |
| is requested on the given module. Because all module service registrations must be unique |
| this value can be queried and checked against the configuration. |
| |
| Since OpenOffice 2.3.0 also the optional interface <type>XModule</type> will be used. |
| If its exists it will be preferred. |
| |
| @param Module |
| Possible objects for this parameter can be the following one: |
| <ul> |
| <li> |
| <b><type scope="com::sun::star::frame">XFrame</type></b><br> |
| A frame contains (against a component window) a controller. |
| Such controller represent the module (in case no model exists). |
| </li> |
| <li> |
| <b><type scope="com::sun::star::frame">XController</type></b><br> |
| A controller can be bound to a model. Then the model represent the module. |
| If no model exists - the controller is used for identification. |
| </li> |
| <li> |
| <b><type scope="com::sun::star::frame">XModel</type></b><br> |
| A model represent a module everytimes and can be used for |
| identification directly. |
| </li> |
| </ul> |
| |
| @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> |
| if the parameter Module is: |
| <ul> |
| <li>an empty one</li> |
| <li>or does not provide one of the needed interface |
| XFrame, XControllerm, XModel</li> |
| <li>or does not provide the needed interface XServiceInfo.</li> |
| </ul> |
| |
| @throws <type>UnknownModuleException</type> |
| if the given module could not be identified. |
| Note: If the module represent a XFrame instance with does not contain |
| a document, this exception is thrown too! |
| |
| @return An identifier for the given module. |
| Note: This value is valie everytimes. Error will be transported |
| by thrown exceptions! |
| */ |
| string identify( [in] ::com::sun::star::uno::XInterface Module ) |
| raises(::com::sun::star::lang::IllegalArgumentException, |
| UnknownModuleException ); |
| |
| |
| }; |
| |
| }; }; }; }; |
| |
| #endif |