offapi/com/sun/star/ui/UIElement.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: UIElement.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_UIElement_idl__
  32 #define __com_sun_star_ui_UIElement_idl__
  33
  34 #ifndef __com_sun_star_frame_XFrame_idl__
  35 #include <com/sun/star/frame/XFrame.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_ui_XUIElement_idl__
  39 #include <com/sun/star/ui/XUIElement.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_lang_XInitialization_idl__
  51 #include <com/sun/star/lang/XInitialization.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_lang_XComponent_idl__
  55 #include <com/sun/star/lang/XComponent.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_util_XUpdatable_idl__
  59 #include <com/sun/star/util/XUpdatable.idl>
  60 #endif
  61
  62 //=============================================================================
  63
  64 module com { module sun { module star { module ui {
  65
  66 //=============================================================================
  67
  68 /** specifies a user interface element.
  69
  70     <p>
  71     A user interface element consists of a unique identifier and a type specifier. It
  72     provides an interface to retrieve a special purpose interface which depends on
  73     the specific user interface element type. Every user interface must be initialized
  74     before it can be used.
  75     </p>
  76
  77     @since OOo 2.0.0
  78 */
  79
  80 service UIElement
  81 {
  82     /** provides a function to retrieve a special purpose interface which depends on
  83         the specific user interface element type.
  84     */
  85     interface ::com::sun::star::ui::XUIElement;
  86
  87     /** interface to initialize a user interface element instance.
  88
  89         A 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 property must be provided:
  92         <ul>
  93             <li><b>ResourceURL</b>specifies a string property which is the unique identifier of
  94             the user interface element.</li>
  95         </ul>
  96
  97         A user interface element factory creates and initializes every user interface element
  98         correctly.
  99
 100         @see com::sun::star::ui::UIElementFactoryManager;
 101         @see com::sun::star::ui::UIElementFactory
 102     */
 103     interface ::com::sun::star::lang::XInitialization;
 104
 105     /** used to notify an implementation that it needs to update its visual representation.
 106
 107         <p>
 108         A user interface element implementation should check if it has to update its visual
 109         representation. It is up to the implementation if it ignores notifications.
 110         </p>
 111     */
 112     interface com::sun::star::util::XUpdatable;
 113
 114     /** controls the life-time of the object.
 115     */
 116     interface ::com::sun::star::lang::XComponent;
 117
 118     /** determines the frame to which this element is bound to.
 119
 120         <p>
 121         The life time of a user interface element does not explicitly depend on the
 122         frame itself but on the visible component attached to the frame. It is possible
 123         to exchange the visible component of a frame and that will lead to the end of
 124         life of all user interface elements.
 125     */
 126     [readonly, property] com::sun::star::frame::XFrame Frame;
 127
 128     /** a resource URL which is a unique identifier of a user interface element.
 129     */
 130     [readonly, property] string ResourceURL;
 131
 132     /** determines the real type of the user interface element.
 133
 134         @see UIElementType
 135     */
 136     [readonly, property] short  Type;
 137 };
 138
 139 }; }; }; };
 140
 141 //=============================================================================
 142
 143 #endif