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