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