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