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