xref: /trunk/main/offapi/com/sun/star/awt/UnoControlCheckBoxModel.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_UnoControlCheckBoxModel_idl__
28#define __com_sun_star_awt_UnoControlCheckBoxModel_idl__
29
30#ifndef __com_sun_star_awt_FontDescriptor_idl__
31#include <com/sun/star/awt/FontDescriptor.idl>
32#endif
33#ifndef __com_sun_star_awt_UnoControlModel_idl__
34#include <com/sun/star/awt/UnoControlModel.idl>
35#endif
36#ifndef __com_sun_star_style_VerticalAlignment_idl__
37#include <com/sun/star/style/VerticalAlignment.idl>
38#endif
39#ifndef __com_sun_star_util_Color_idl__
40#include <com/sun/star/util/Color.idl>
41#endif
42#ifndef com_sun_star_graphic_XGraphic_idl
43#include <com/sun/star/graphic/XGraphic.idl>
44#endif
45
46//=============================================================================
47
48 module com {  module sun {  module star {  module awt {
49
50//=============================================================================
51
52/** specifies the standard model of an <type>UnoControlCheckBox</type>.
53 */
54published service UnoControlCheckBoxModel
55{
56    service com::sun::star::awt::UnoControlModel;
57
58    //-------------------------------------------------------------------------
59
60    /** specifies the horizontal alignment of the text in the control.
61
62        <pre>
63        0: left
64        1: center
65        2: right
66        </pre>
67
68        @since OOo 2.0
69     */
70    [optional, property] short Align;
71
72    //-------------------------------------------------------------------------
73
74    /** specifies the background color (RGB) of the control.
75     */
76    [optional, property] long BackgroundColor;
77
78    //-------------------------------------------------------------------------
79
80    /** determines whether the control is enabled or disabled.
81     */
82    [property] boolean Enabled;
83
84    //-------------------------------------------------------------------------
85
86    /** specifies the font attributes of the text in the control.
87     */
88    [property] com::sun::star::awt::FontDescriptor FontDescriptor;
89
90    //-------------------------------------------------------------------------
91
92    /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
93        value of the text in the control.
94     */
95    [property] short FontEmphasisMark;
96
97    //-------------------------------------------------------------------------
98
99    /** specifies the <type scope="com::sun::star::text">FontRelief</type>
100        value of the text in the control.
101     */
102    [property] short FontRelief;
103
104    //-------------------------------------------------------------------------
105
106    /** specifies the help text of the control.
107     */
108    [property] string HelpText;
109
110    //-------------------------------------------------------------------------
111
112    /** specifies the help URL of the control.
113     */
114    [property] string HelpURL;
115
116    //-------------------------------------------------------------------------
117
118    /** specifies the position of the image, if any, relative to the text, if any
119
120        <p>Valid values of this property are specified with <type>ImagePosition</type>.</p>
121     */
122    [optional, property] short ImagePosition;
123
124    //-------------------------------------------------------------------------
125
126    /** specifies an URL to an image to display besides the label of the control
127        @see Graphic
128     */
129    [optional, property] string ImageURL;
130
131    //-------------------------------------------------------------------------
132
133    /** specifies a graphic to be displayed besides the label of the control
134
135        <p>If this property is present, it interacts with the <member>ImageURL</member>in the
136        following way:
137        <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
138            to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
139            does not point to a valid image file.</li>
140            <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
141            to an empty string.</li>
142        </ul></p>
143
144        @since OOo 2.1
145     */
146    [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
147
148    //-------------------------------------------------------------------------
149
150    /** specifies the label of the control.
151     */
152    [property] string Label;
153
154    //-------------------------------------------------------------------------
155
156    /** specifies that the text may be displayed on more than one line.
157
158        @since OOo 2.0
159     */
160    [optional, property] boolean MultiLine;
161
162    //-------------------------------------------------------------------------
163
164    /** specifies that the control will be printed with the document.
165     */
166    [property] boolean Printable;
167
168    //-------------------------------------------------------------------------
169
170    /** specifies the state of the control.
171
172        <pre>
173        0: not checked
174        1: checked
175        2: don't know
176        </pre>
177     */
178    [property] short State;
179
180    //-------------------------------------------------------------------------
181
182    /** specifies that the control can be reached with the TAB key.
183     */
184    [property] boolean Tabstop;
185
186    //-------------------------------------------------------------------------
187
188    /** specifies the text color (RGB) of the control.
189     */
190    [property] com::sun::star::util::Color TextColor;
191
192    //-------------------------------------------------------------------------
193
194    /** specifies the text line color (RGB) of the control.
195     */
196    [property] com::sun::star::util::Color TextLineColor;
197
198    //-------------------------------------------------------------------------
199
200    /** specifies that the control may have the state "don't know".
201     */
202    [property] boolean TriState;
203
204    //-------------------------------------------------------------------------
205
206    /** specifies the vertical alignment of the text in the control.
207
208        @since OOo 2.0
209     */
210    [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
211
212    //-------------------------------------------------------------------------
213
214    /** specifies a visual effect to apply to the check box control
215
216        <p>Possible values for this property are <type>VisualEffect</type>::FLAT and
217        <type>VisualEffect</type>::LOOK3D.</p>
218
219        @see com::sun::star::awt::VisualEffect
220
221        @since OOo 2.0
222     */
223    [optional, property] short VisualEffect;
224
225    /** denotes the writing mode used in the control, as specified in the
226        <type scope="com::sun::star::text">WritingMode2</type> constants group.
227
228        <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
229        <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
230
231        @since OOo 3.1
232    */
233    [optional, property] short WritingMode;
234};
235
236//=============================================================================
237
238}; }; }; };
239
240#endif
241