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