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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_ui_UIElement_idl__
  29 #define __com_sun_star_ui_UIElement_idl__
  30
  31 #ifndef __com_sun_star_ui_XUIElement_idl__
  32 #include <com/sun/star/ui/XUIElement.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_beans_XPropertySet_idl__
  36 #include <com/sun/star/beans/XPropertySet.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_lang_XInitialization_idl__
  40 #include <com/sun/star/lang/XInitialization.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_lang_XComponent_idl__
  44 #include <com/sun/star/lang/XComponent.idl>
  45 #endif
  46
  47 #ifndef __com_sun_star_util_XUpdatable_idl__
  48 #include <com/sun/star/util/XUpdatable.idl>
  49 #endif
  50
  51 //=============================================================================
  52
  53 module com { module sun { module star { module ui {
  54
  55 //=============================================================================
  56
  57 /** specifies a user interface element.
  58
  59     <p>
  60     A user interface element consists of a unique identifier and a type specifier. It
  61     provides an interface to retrieve a special purpose interface which depends on
  62     the specific user interface element type. Every user interface must be initialized
  63     before it can be used.
  64     </p>
  65
  66     @since OOo 2.0.0
  67 */
  68
  69 service UIElement
  70 {
  71     /** provides a function to retrieve a special purpose interface which depends on
  72         the specific user interface element type.
  73     */
  74     interface ::com::sun::star::ui::XUIElement;
  75
  76     /** interface to initialize a user interface element instance.
  77
  78         A user interface element must be initialized using
  79         <member scope=com::sun::star::lang>XInitialization::initialize</member> before
  80         it can be used. The following property must be provided:
  81         <ul>
  82             <li><b>ResourceURL</b>specifies a string property which is the unique identifier of
  83             the user interface element.</li>
  84         </ul>
  85
  86         A user interface element factory creates and initializes every user interface element
  87         correctly.
  88
  89         @see com::sun::star::ui::UIElementFactoryManager;
  90         @see com::sun::star::ui::UIElementFactory
  91     */
  92     [optional] interface ::com::sun::star::lang::XInitialization;
  93
  94     /** used to notify an implementation that it needs to update its visual representation.
  95
  96         <p>
  97         A user interface element implementation should check if it has to update its visual
  98         representation. It is up to the implementation if it ignores notifications.
  99         </p>
 100     */
 101     [optional] interface com::sun::star::util::XUpdatable;
 102
 103     /** controls the life-time of the object.
 104     */
 105     interface ::com::sun::star::lang::XComponent;
 106 };
 107
 108 }; }; }; };
 109
 110 //=============================================================================
 111
 112 #endif