xref: /AOO41X/main/offapi/com/sun/star/awt/UnoControlListBoxModel.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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#ifndef __com_sun_star_awt_UnoControlListBoxModel_idl__
28#define __com_sun_star_awt_UnoControlListBoxModel_idl__
29
30#ifndef __com_sun_star_awt_FontDescriptor_idl__
31#include <com/sun/star/awt/FontDescriptor.idl>
32#endif
33
34#ifndef __com_sun_star_awt_UnoControlModel_idl__
35#include <com/sun/star/awt/UnoControlModel.idl>
36#endif
37
38#ifndef __com_sun_star_util_Color_idl__
39#include <com/sun/star/util/Color.idl>
40#endif
41
42#include <com/sun/star/awt/XItemList.idl>
43
44
45//=============================================================================
46
47 module com {  module sun {  module star {  module awt {
48
49//=============================================================================
50
51/** specifies the standard model of an <type>UnoControlListBox</type>.
52 */
53published service UnoControlListBoxModel
54{
55	service com::sun::star::awt::UnoControlModel;
56
57	//-------------------------------------------------------------------------
58
59	/** specifies the horiztontal alignment of the text in the control.
60
61		<pre>
62		0: left
63		1: center
64		2: right
65		</pre>
66	 */
67	[optional, property] short Align;
68
69	//-------------------------------------------------------------------------
70
71	/** specifies the background color (RGB) of the control.
72	 */
73	[property] com::sun::star::util::Color BackgroundColor;
74
75	//-------------------------------------------------------------------------
76
77	/** specifies the border style of the control.
78
79		<pre>
80		0: No border
81		1: 3D border
82		2: simple border
83		</pre>
84	 */
85	[property] short Border;
86
87	//-------------------------------------------------------------------------
88
89	/** specifies the color of the border, if present
90
91        <p>Not every border style (see <member>Border</member>) may support coloring.
92        For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
93
94        @since OOo 2.0
95	 */
96	[optional, property] long BorderColor;
97
98	//-------------------------------------------------------------------------
99
100	/** specifies if the control has a drop down button.
101	 */
102	[property] boolean Dropdown;
103
104	//-------------------------------------------------------------------------
105
106	/** determines whether the control is enabled or disabled.
107	 */
108	[property] boolean Enabled;
109
110	//-------------------------------------------------------------------------
111
112	/** specifies the font attributes of the text in the control.
113	 */
114	[property] com::sun::star::awt::FontDescriptor FontDescriptor;
115
116	//-------------------------------------------------------------------------
117
118	/** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
119        value of the text in the control.
120	 */
121	[property] short FontEmphasisMark;
122
123	//-------------------------------------------------------------------------
124
125	/** specifies the <type scope="com::sun::star::text">FontRelief</type>
126        value of the text in the control.
127	 */
128	[property] short FontRelief;
129
130	//-------------------------------------------------------------------------
131
132	/** specifies the help text of the control.
133	 */
134	[property] string HelpText;
135
136	//-------------------------------------------------------------------------
137
138	/** specifies the help URL of the control.
139	 */
140	[property] string HelpURL;
141
142	//-------------------------------------------------------------------------
143
144	/** specifies the maximum line count displayed in the drop down box.
145	 */
146	[property] short LineCount;
147
148	//-------------------------------------------------------------------------
149
150	/** specifies if more than one entry can be selected.
151	 */
152	[property] boolean MultiSelection;
153
154	//-------------------------------------------------------------------------
155
156	/** specifies that the control will be printed with the document.
157	 */
158	[property] boolean Printable;
159
160	//-------------------------------------------------------------------------
161
162	/** specifies that the content of the control cannot be modified by the user.
163	 */
164	[property] boolean ReadOnly;
165
166	//-------------------------------------------------------------------------
167
168	/** specifies the sequence of selected items, identfied by the position.
169	 */
170	[property] sequence<short> SelectedItems;
171
172	//-------------------------------------------------------------------------
173
174	/** specifies the list of items.
175	 */
176	[property] sequence<string> StringItemList;
177
178	//-------------------------------------------------------------------------
179
180	/** specifies that the control can be reached with the TAB key.
181	 */
182	[property] boolean Tabstop;
183
184	//-------------------------------------------------------------------------
185
186	/** specifies the text color (RGB) of the control.
187	 */
188	[property] com::sun::star::util::Color TextColor;
189
190	//-------------------------------------------------------------------------
191
192	/** specifies the text line color (RGB) of the control.
193	 */
194	[property] com::sun::star::util::Color TextLineColor;
195
196    /** denotes the writing mode used in the control, as specified in the
197        <type scope="com::sun::star::text">WritingMode2</type> constants group.
198
199        <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
200        <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
201
202        @since OOo 3.1
203    */
204    [optional, property] short WritingMode;
205
206    /** defines how the mouse wheel can be used to scroll through the control's content.
207
208        <p>Usually, the mouse wheel scrool through the control's entry list. Using this property,
209        and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
210        this is possible.</p>
211    */
212    [optional, property] short MouseWheelBehavior;
213
214    /** allows mmanipulating the list of items in the list box more fine-grained than the
215        <member>StringItemList</member> property.
216
217        @since OOo 3.3
218    */
219    [optional] interface XItemList;
220
221    /** specifies where an item separator - a horizontal line - is drawn.
222
223        <p>If this is not <NULL/>, then a horizontal line will be drawn between the item at the given position,
224        and the following item.</p>
225
226        @since OOo 3.3
227    */
228    [optional, property, maybevoid] short ItemSeparatorPos;
229};
230
231//=============================================================================
232
233}; }; }; };
234
235#endif
236