blob: 4edb6774a8ef415575520d0d2437d9449b8378fd (
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
|
/*************************************************************************
*
* 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_UIElementSettings_idl__
#define __com_sun_star_ui_UIElementSettings_idl__
#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif
#ifndef __com_sun_star_lang_XSingleComponentFactory_idl__
#include <com/sun/star/lang/XSingleComponentFactory.idl>
#endif
//=============================================================================
module com { module sun { module star { module ui {
//=============================================================================
/**
describes the internal structure of a configurable user interface element.
<p>
No assumption is made about any graphical representation:
You could have a menu or a toolbar working with the same UIElementSettings
although limitations based on the real user interface element may be visible.
</p>
@since OOo 2.0.0
*/
service UIElementSettings
{
/** provides access to the structure of the user interface element.
<p>
The container contains the items of the user interface element. Every
item is stored as a sequence of <type scope="com::sun::star::beans">PropertyValue</type>.
The properties insides the sequence are defined by the service <type scope="com::sun::star::ui">ItemDescriptor</type>.
It depends on the function which provides these service if the container is shareable read-only or exclusive writeable.
@see com::sun::star::ui::ItemDescriptor
@see com::sun::star::ui::ItemType
@see com::sun::star::ui::ItemStyle
</p>
*/
interface ::com::sun::star::container::XIndexAccess;
/** provides access to an optional factory interface to create sub container.
<p>
The factory should be used to create sub container within this user interface element settings. This interface is only
available if the container is exclusive writable.
</p>
*/
[optional] interface ::com::sun::star::lang::XSingleComponentFactory;
/** determine an optional user interface name of the user interface element.
<p>
A toolbar can show a its user interface name on the window title, when it is in floating mode.
</p>
*/
[optional, property] string UIName;
};
}; }; }; };
#endif
|
