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