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

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