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