xref: /aoo41x/main/offapi/com/sun/star/ui/UIElement.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_ui_UIElement_idl__
25#define __com_sun_star_ui_UIElement_idl__
26
27#ifndef __com_sun_star_ui_XUIElement_idl__
28#include <com/sun/star/ui/XUIElement.idl>
29#endif
30
31#ifndef __com_sun_star_beans_XPropertySet_idl__
32#include <com/sun/star/beans/XPropertySet.idl>
33#endif
34
35#ifndef __com_sun_star_lang_XInitialization_idl__
36#include <com/sun/star/lang/XInitialization.idl>
37#endif
38
39#ifndef __com_sun_star_lang_XComponent_idl__
40#include <com/sun/star/lang/XComponent.idl>
41#endif
42
43#ifndef __com_sun_star_util_XUpdatable_idl__
44#include <com/sun/star/util/XUpdatable.idl>
45#endif
46
47//=============================================================================
48
49module com { module sun { module star { module ui {
50
51//=============================================================================
52
53/** specifies a user interface element.
54
55    <p>
56    A user interface element consists of a unique identifier and a type specifier. It
57    provides an interface to retrieve a special purpose interface which depends on
58    the specific user interface element type. Every user interface must be initialized
59    before it can be used.
60    </p>
61
62    @since OOo 2.0
63*/
64
65service UIElement
66{
67    /** provides a function to retrieve a special purpose interface which depends on
68        the specific user interface element type.
69    */
70    interface ::com::sun::star::ui::XUIElement;
71
72    /** interface to initialize a user interface element instance.
73
74        A user interface element must be initialized using
75        <member scope=com::sun::star::lang>XInitialization::initialize</member> before
76        it can be used. The following property must be provided:
77        <ul>
78            <li><b>ResourceURL</b>specifies a string property which is the unique identifier of
79            the user interface element.</li>
80        </ul>
81
82        A user interface element factory creates and initializes every user interface element
83        correctly.
84
85        @see com::sun::star::ui::UIElementFactoryManager;
86        @see com::sun::star::ui::UIElementFactory
87    */
88    [optional] interface ::com::sun::star::lang::XInitialization;
89
90    /** used to notify an implementation that it needs to update its visual representation.
91
92        <p>
93        A user interface element implementation should check if it has to update its visual
94        representation. It is up to the implementation if it ignores notifications.
95        </p>
96    */
97    [optional] interface com::sun::star::util::XUpdatable;
98
99    /** controls the life-time of the object.
100    */
101    interface ::com::sun::star::lang::XComponent;
102};
103
104}; }; }; };
105
106//=============================================================================
107
108#endif
109