offapi/com/sun/star/awt/UnoControlFixedTextModel.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: UnoControlFixedTextModel.idl,v $
  10  * $Revision: 1.15 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_UnoControlFixedTextModel_idl__
  31 #define __com_sun_star_awt_UnoControlFixedTextModel_idl__
  32
  33 #ifndef __com_sun_star_awt_FontDescriptor_idl__
  34 #include <com/sun/star/awt/FontDescriptor.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_UnoControlModel_idl__
  38 #include <com/sun/star/awt/UnoControlModel.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_style_VerticalAlignment_idl__
  42 #include <com/sun/star/style/VerticalAlignment.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_util_Color_idl__
  46 #include <com/sun/star/util/Color.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module awt {
  53
  54 //=============================================================================
  55
  56 /** specifies the standard model of an <type>UnoControlFixedText</type>.
  57  */
  58 published service UnoControlFixedTextModel
  59 {
  60     service com::sun::star::awt::UnoControlModel;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** specifies the horiztonal alignment of the text in the control.
  65
  66         <pre>
  67         0: left
  68         1: center
  69         2: right
  70         </pre>
  71      */
  72     [property] short Align;
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** specifies the background color (RGB) of the control.
  77      */
  78     [property] com::sun::star::util::Color BackgroundColor;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** specifies the border style of the control.
  83
  84         <pre>
  85         0: No border
  86         1: 3D border
  87         2: simple border
  88         </pre>
  89      */
  90     [property] short Border;
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** specifies the color of the border, if present
  95
  96         <p>Not every border style (see <member>Border</member>) may support coloring.
  97         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  98
  99         @since OOo 2.0.0
 100      */
 101     [optional, property] long BorderColor;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** determines whether the control is enabled or disabled.
 106      */
 107     [property] boolean Enabled;
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** specifies the font attributes of the text in the control.
 112      */
 113     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
 118         value of the text in the control.
 119      */
 120     [property] short FontEmphasisMark;
 121
 122     //-------------------------------------------------------------------------
 123
 124     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 125         value of the text in the control.
 126      */
 127     [property] short FontRelief;
 128
 129     //-------------------------------------------------------------------------
 130
 131     /** specifies the help text of the control.
 132      */
 133     [property] string HelpText;
 134
 135     //-------------------------------------------------------------------------
 136
 137     /** specifies the help URL of the control.
 138      */
 139     [property] string HelpURL;
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** specifies the label of the control.
 144      */
 145     [property] string Label;
 146
 147     //-------------------------------------------------------------------------
 148
 149     /** specifies that the text may be displayed on more than one line.
 150      */
 151     [property] boolean MultiLine;
 152
 153     //-------------------------------------------------------------------------
 154
 155     /** specifies that the control will be printed with the document.
 156      */
 157     [property] boolean Printable;
 158
 159     //-------------------------------------------------------------------------
 160
 161     /** specifies the text color (RGB) of the control.
 162      */
 163     [property] com::sun::star::util::Color TextColor;
 164
 165     //-------------------------------------------------------------------------
 166
 167     /** specifies the text line color (RGB) of the control.
 168      */
 169     [property] com::sun::star::util::Color TextLineColor;
 170
 171     //-------------------------------------------------------------------------
 172
 173     /** specifies the vertical alignment of the text in the control.
 174
 175         @since OOo 2.0.0
 176      */
 177     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 178
 179 };
 180
 181 //=============================================================================
 182
 183 }; }; }; };
 184
 185 #endif