| /************************************************************** |
| * |
| * 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_ui_XModuleUIConfigurationManager_idl__ |
| #define __com_sun_star_ui_XModuleUIConfigurationManager_idl__ |
| |
| #ifndef __com_sun_star_container_XIndexContainer_idl__ |
| #include <com/sun/star/container/XIndexContainer.idl> |
| #endif |
| |
| #ifndef __com_sun_star_container_XIndexAccess_idl__ |
| #include <com/sun/star/container/XIndexAccess.idl> |
| #endif |
| |
| #ifndef __com_sun_star_container_NoSuchElementException_idl__ |
| #include <com/sun/star/container/NoSuchElementException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ |
| #include <com/sun/star/lang/IllegalArgumentException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_lang_IllegalAccessException_idl__ |
| #include <com/sun/star/lang/IllegalAccessException.idl> |
| #endif |
| |
| module com { module sun { module star { module ui { |
| |
| /** specifies specific functions of a module based user interface |
| configuration manager interface. |
| |
| <p> |
| A module user interface configuration manager supports, unlike a |
| document based ui configration manager, two layers of configuration |
| settings data:<br/> |
| 1. Layer: A module default user interface configuration which |
| describe all user interface elements settings that are |
| used by OpenOffice. It is not possible to insert, remove |
| or changeelements settings in this layer through the |
| interfaces.</br> |
| 2. Layer: A module user interface configuration which only contains |
| customized user interface elements and user-defined ones. |
| All changes on user interface element settings are done on |
| this layer. This layer is the same as the document ui |
| configuration manager uses.</br> |
| </p> |
| |
| @since OpenOffice 2.0 |
| */ |
| |
| interface XModuleUIConfigurationManager : ::com::sun::star::uno::XInterface |
| { |
| /** determine if the settings of a user interface element is part |
| of the default layer of the user interface configuration manager. |
| |
| @param ResourceURL |
| a resource URL which identifies the user interface element. A |
| resourcce URL must meet the following syntax: |
| "private:resource/$type/$name. It is only allowed to use ascii |
| characters for type and name. |
| |
| @return |
| <TRUE/> if settings have been found in the default layer, |
| otherwise <FALSE/>. |
| */ |
| boolean isDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::lang::IllegalArgumentException ); |
| |
| /** retrieves the settings from the default layer of the user interface |
| configuration manager if it has a default layer. |
| |
| @param ResourceURL |
| a resource URL which identifies the user interface element. A |
| resourcce URL must meet the following syntax: |
| "private:resource/$type/$name. It is only allowed to use ascii |
| characters for type and name. |
| |
| @return |
| <TRUE/> if default settings have been found in the default layer, |
| otherwise <FALSE/>. |
| */ |
| ::com::sun::star::container::XIndexAccess getDefaultSettings( [in] string ResourceURL ) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException ); |
| |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |