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