INTEGRATION: CWS removedrafts (1.1.2); FILE ADDED

2005/02/17 13:16:05 cd 1.1.2.1: #i42557# move UNOIDL types from drafts to com

1 files changed, 101 insertions, 0 deletions

diff --git a/offapi/com/sun/star/ui/ConfigurableUIElement.idl b/offapi/com/sun/star/ui/ConfigurableUIElement.idl
new file mode 100644
index 000000000..754fe3e01
--- /dev/null
+++ b/offapi/com/sun/star/ui/ConfigurableUIElement.idl
@@ -0,0 +1,101 @@
+#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
+
+//============================================================================= 
+
+/** 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 OOo 2.0.0
+*/
+
+module com { module sun { module star { module ui {
+
+//============================================================================= 
+
+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