xref: /AOO41X/main/offapi/com/sun/star/awt/UnoControlRadioButtonModel.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_UnoControlRadioButtonModel_idl__
28#define __com_sun_star_awt_UnoControlRadioButtonModel_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
49 module com {  module sun {  module star {  module awt {
50
51//=============================================================================
52
53/** specifies the standard model of an <type>UnoControlRadioButton</type>.
54 */
55published service UnoControlRadioButtonModel
56{
57	service com::sun::star::awt::UnoControlModel;
58
59	//-------------------------------------------------------------------------
60
61	/** specifies the horizontal alignment of the text in the control.
62
63		<pre>
64		0: left
65		1: center
66		2: right
67		</pre>
68
69        @since OOo 2.0
70	 */
71	[optional, property] short Align;
72
73	//-------------------------------------------------------------------------
74
75	/** specifies the background color (RGB) of the control.
76	 */
77	[optional, property] long BackgroundColor;
78
79	//-------------------------------------------------------------------------
80
81	/** determines whether the control is enabled or disabled.
82	 */
83	[property] boolean Enabled;
84
85	//-------------------------------------------------------------------------
86
87	/** specifies the font attributes of the text in the control.
88	 */
89	[property] com::sun::star::awt::FontDescriptor FontDescriptor;
90
91	//-------------------------------------------------------------------------
92
93	/** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
94        value of the text in the control.
95	 */
96	[property] short FontEmphasisMark;
97
98	//-------------------------------------------------------------------------
99
100	/** specifies the <type scope="com::sun::star::text">FontRelief</type>
101        value of the text in the control.
102	 */
103	[property] short FontRelief;
104
105	//-------------------------------------------------------------------------
106
107	/** specifies the help text of the control.
108	 */
109	[property] string HelpText;
110
111	//-------------------------------------------------------------------------
112
113	/** specifies the help URL of the control.
114	 */
115	[property] string HelpURL;
116
117	//-------------------------------------------------------------------------
118
119    /** specifies the position of the image, if any, relative to the text, if any
120
121        <p>Valid values of this property are specified with <type>ImagePosition</type>.</p>
122    */
123    [optional, property] short ImagePosition;
124
125	//-------------------------------------------------------------------------
126
127	/** specifies an URL to an image to display besides the label of the control
128        @see Graphic
129	 */
130	[optional, property] string ImageURL;
131
132	//-------------------------------------------------------------------------
133
134	/** specifies a graphic to be displayed besides the label of the control
135
136        <p>If this property is present, it interacts with the <member>ImageURL</member>in the
137        following way:
138        <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
139            to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
140            does not point to a valid image file.</li>
141            <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
142            to an empty string.</li>
143        </ul></p>
144
145        @since OOo 2.1
146	 */
147    [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
148
149	//-------------------------------------------------------------------------
150
151	/** specifies the label of the control.
152	 */
153	[property] string Label;
154
155	//-------------------------------------------------------------------------
156
157	/** specifies that the text may be displayed on more than one line.
158
159        @since OOo 2.0
160	 */
161	[optional, property] boolean MultiLine;
162
163	//-------------------------------------------------------------------------
164
165	/** specifies that the control will be printed with the document.
166	 */
167	[property] boolean Printable;
168
169	//-------------------------------------------------------------------------
170
171	/** specifies the state of the control.
172
173		<pre>
174		0: not checked
175		1: checked
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 the vertical alignment of the text in the control.
201
202        @since OOo 2.0
203	 */
204    [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
205
206	//-------------------------------------------------------------------------
207
208    /** specifies a visual effect to apply to the radio button control.
209
210        <p>Possible values for this property are <type>VisualEffect</type>::FLAT and
211        <type>VisualEffect</type>::LOOK3D.</p>
212
213        @see com::sun::star::awt::VisualEffect
214
215        @since OOo 2.0
216     */
217    [optional, property] short VisualEffect;
218
219    /** denotes the writing mode used in the control, as specified in the
220        <type scope="com::sun::star::text">WritingMode2</type> constants group.
221
222        <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
223        <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
224
225        @since OOo 3.1
226    */
227    [optional, property] short WritingMode;
228};
229
230//=============================================================================
231
232}; }; }; };
233
234#endif
235