xref: /trunk/main/offapi/com/sun/star/awt/UnoControlFileControlModel.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_UnoControlFileControlModel_idl__
28#define __com_sun_star_awt_UnoControlFileControlModel_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#ifndef __com_sun_star_style_VerticalAlignment_idl__
43#include <com/sun/star/style/VerticalAlignment.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>UnoControlFileControl</type>.
53 */
54published service UnoControlFileControlModel
55{
56    service com::sun::star::awt::UnoControlModel;
57
58    //-------------------------------------------------------------------------
59
60    /** specifies the background color (RGB) of the control.
61     */
62    [property] com::sun::star::util::Color BackgroundColor;
63
64    //-------------------------------------------------------------------------
65
66    /** specifies the border style of the control.
67
68        <pre>
69        0: No border
70        1: 3D border
71        2: simple border
72        </pre>
73     */
74    [property] short Border;
75
76    //-------------------------------------------------------------------------
77
78    /** specifies the color of the border, if present
79
80        <p>Not every border style (see <member>Border</member>) may support coloring.
81        For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
82
83        @since OOo 2.0
84     */
85    [optional, property] long BorderColor;
86
87    //-------------------------------------------------------------------------
88
89    /** determines whether a control is enabled or disabled.
90     */
91    [property] boolean Enabled;
92
93    //-------------------------------------------------------------------------
94
95    /** specifies the font attributes of the text in the control.
96     */
97    [property] com::sun::star::awt::FontDescriptor FontDescriptor;
98
99    //-------------------------------------------------------------------------
100
101    /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
102        value of the text in the control.
103     */
104    [property] short FontEmphasisMark;
105
106    //-------------------------------------------------------------------------
107
108    /** specifies the <type scope="com::sun::star::text">FontRelief</type>
109        value of the text in the control.
110     */
111    [property] short FontRelief;
112
113    //-------------------------------------------------------------------------
114
115    /** specifies the help text of the control.
116     */
117    [property] string HelpText;
118
119    //-------------------------------------------------------------------------
120
121    /** specifies the help URL of the control.
122     */
123    [property] string HelpURL;
124
125    //-------------------------------------------------------------------------
126
127    /** specifies whether the selection in the control should be hidden when
128        the control is not active (focused).
129
130        @since OOo 2.0
131    */
132    [optional, property] boolean HideInactiveSelection;
133
134    //-------------------------------------------------------------------------
135
136    /** specifies that the control will be printed with the document.
137     */
138    [property] boolean Printable;
139
140    //-------------------------------------------------------------------------
141
142    /** specifies that the content of the control cannot be modified by the user.
143
144        @since OOo 1.1.2
145     */
146    [optional, property] boolean ReadOnly;
147
148    //-------------------------------------------------------------------------
149
150    /** specifies that the control can be reached with the TAB key.
151     */
152    [property] boolean Tabstop;
153
154    //-------------------------------------------------------------------------
155
156    /** specifies the text displayed in the control.
157     */
158    [property] string Text;
159
160    //-------------------------------------------------------------------------
161
162    /** specifies the text color (RGB) of the control.
163     */
164    [property] com::sun::star::util::Color TextColor;
165
166    //-------------------------------------------------------------------------
167
168    /** specifies the text line color (RGB) of the control.
169     */
170    [property] com::sun::star::util::Color TextLineColor;
171
172    //-------------------------------------------------------------------------
173
174    /** specifies the vertical alignment of the text in the control.
175
176        @since OOo 3.3
177     */
178    [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
179};
180
181//=============================================================================
182
183}; }; }; };
184
185#endif
186