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