offapi/com/sun/star/ui/ConfigurableUIElement.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ConfigurableUIElement.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ui_ConfigurableUIElement_idl__
  32 #define __com_sun_star_ui_ConfigurableUIElement_idl__
  33
  34 #ifndef __com_sun_star_ui_UIElement_idl__
  35 #include <com/sun/star/ui/UIElement.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_ui_XUIElementSettings_idl__
  39 #include <com/sun/star/ui/XUIElementSettings.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_beans_XPropertySet_idl__
  43 #include <com/sun/star/beans/XPropertySet.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_ui_UIElementType_idl__
  47 #include <com/sun/star/ui/UIElementType.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_ui_XUIConfigurationManager_idl__
  51 #include <com/sun/star/ui/XUIConfigurationManager.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_frame_XFrame_idl__
  55 #include <com/sun/star/frame/XFrame.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_lang_XInitialization_idl__
  59 #include <com/sun/star/lang/XInitialization.idl>
  60 #endif
  61
  62 //=============================================================================
  63
  64 module com { module sun { module star { module ui {
  65
  66 //=============================================================================
  67
  68 /** specifies a configurable user interface element that supports persistence.
  69
  70     <p>
  71     Configurable user interface elements are:
  72     <ul>
  73         <li>menubar</li>
  74         <li>popupmenu<li>
  75         <li>toolbar</li>
  76         <li>statusbar</li>
  77     </ul>
  78     </p>
  79
  80     @since OOo 2.0.0
  81 */
  82
  83 service ConfigurableUIElement
  84 {
  85     /** provides properties and functions to initialize and identify a user
  86         interface element.
  87
  88         <p>
  89         A configurable user interface element must be initialized using
  90         <member scope=com::sun::star::lang>XInitialization::initialize</member> before
  91         it can be used. The following properties must be provided:
  92         <ul>
  93             <li><b>ResourceURL</b><br>specifies the user interface name.</li>
  94             <li><b>Frame</b><br>specifies to which frame instance the user interface belongs to.</li>
  95             <li><b>ConfigurationSource</b><br>specifies to which configuration manager a user interface
  96             element instance is bound to.</li>
  97         </ul>
  98         </p>
  99
 100         A user interface element factory creates and initializes every user interface element
 101         correctly.
 102
 103         @see com::sun::star::ui::UIElementFactory
 104     */
 105     service UIElement;
 106
 107     /** provides functions to retrieve and change the user interface element structure data and to
 108         update its visible representation.
 109     */
 110     interface com::sun::star::ui::XUIElementSettings;
 111
 112     /** specifies if the user interface element stores changes of its structure to its creator
 113         source defined by the property <member>ConfigurationSource</member>. */
 114     [property] boolean Persistent;
 115
 116     /** specifies the configuration source of this user interface element.
 117
 118         <p>
 119         If the property <member>Persistent</member> is <TRUE/> changes on the structure of
 120         the user interface element are written back to configuration source. When this property is
 121         changed, afterwards <member>XUIElementSettings::updateSettings</member>  must be called so
 122         the user interface element tries to retrieve its settings from the new user interface
 123         configuration manager.
 124         </p>
 125     */
 126     [property] com::sun::star::ui::XUIConfigurationManager ConfigurationSource;
 127 };
 128
 129 }; }; }; };
 130
 131 #endif