| /************************************************************** |
| * |
| * 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_ConfigurableUIElement_idl__ |
| #define __com_sun_star_ui_ConfigurableUIElement_idl__ |
| |
| #ifndef __com_sun_star_ui_UIElement_idl__ |
| #include <com/sun/star/ui/UIElement.idl> |
| #endif |
| |
| #ifndef __com_sun_star_ui_XUIElementSettings_idl__ |
| #include <com/sun/star/ui/XUIElementSettings.idl> |
| #endif |
| |
| #ifndef __com_sun_star_beans_XPropertySet_idl__ |
| #include <com/sun/star/beans/XPropertySet.idl> |
| #endif |
| |
| #ifndef __com_sun_star_ui_UIElementType_idl__ |
| #include <com/sun/star/ui/UIElementType.idl> |
| #endif |
| |
| #ifndef __com_sun_star_ui_XUIConfigurationManager_idl__ |
| #include <com/sun/star/ui/XUIConfigurationManager.idl> |
| #endif |
| |
| #ifndef __com_sun_star_frame_XFrame_idl__ |
| #include <com/sun/star/frame/XFrame.idl> |
| #endif |
| |
| #ifndef __com_sun_star_lang_XInitialization_idl__ |
| #include <com/sun/star/lang/XInitialization.idl> |
| #endif |
| |
| //============================================================================= |
| |
| module com { module sun { module star { module ui { |
| |
| //============================================================================= |
| |
| /** specifies a configurable user interface element that supports persistence. |
| |
| <p> |
| Configurable user interface elements are: |
| <ul> |
| <li>menubar</li> |
| <li>popupmenu<li> |
| <li>toolbar</li> |
| <li>statusbar</li> |
| </ul> |
| </p> |
| |
| @since OpenOffice 2.0 |
| */ |
| |
| service ConfigurableUIElement |
| { |
| /** provides properties and functions to initialize and identify a user |
| interface element. |
| |
| <p> |
| A configurable user interface element must be initialized using |
| <member scope=com::sun::star::lang>XInitialization::initialize</member> before |
| it can be used. The following properties must be provided: |
| <ul> |
| <li><b>ResourceURL</b><br>specifies the user interface name.</li> |
| <li><b>Frame</b><br>specifies to which frame instance the user interface belongs to.</li> |
| <li><b>ConfigurationSource</b><br>specifies to which configuration manager a user interface |
| element instance is bound to.</li> |
| </ul> |
| </p> |
| |
| A user interface element factory creates and initializes every user interface element |
| correctly. |
| |
| @see com::sun::star::ui::UIElementFactory |
| */ |
| service UIElement; |
| |
| /** provides functions to retrieve and change the user interface element structure data and to |
| update its visible representation. |
| */ |
| interface com::sun::star::ui::XUIElementSettings; |
| |
| /** specifies if the user interface element stores changes of its structure to its creator |
| source defined by the property <member>ConfigurationSource</member>. */ |
| [property] boolean Persistent; |
| |
| /** specifies the configuration source of this user interface element. |
| |
| <p> |
| If the property <member>Persistent</member> is <TRUE/> changes on the structure of |
| the user interface element are written back to configuration source. When this property is |
| changed, afterwards <member>XUIElementSettings::updateSettings</member> must be called so |
| the user interface element tries to retrieve its settings from the new user interface |
| configuration manager. |
| </p> |
| */ |
| [property] com::sun::star::ui::XUIConfigurationManager ConfigurationSource; |
| }; |
| |
| }; }; }; }; |
| |
| #endif |