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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_UnoControlCheckBoxModel_idl__
  20 #define __com_sun_star_awt_UnoControlCheckBoxModel_idl__
  21
  22 #include <com/sun/star/awt/FontDescriptor.idl>
  23 #include <com/sun/star/awt/UnoControlModel.idl>
  24 #include <com/sun/star/style/VerticalAlignment.idl>
  25 #include <com/sun/star/util/Color.idl>
  26 #include <com/sun/star/graphic/XGraphic.idl>
  27
  28
  29  module com {  module sun {  module star {  module awt {
  30
  31
  32 /** specifies the standard model of an UnoControlCheckBox.
  33  */
  34 published service UnoControlCheckBoxModel
  35 {
  36     service com::sun::star::awt::UnoControlModel;
  37
  38
  39     /** specifies the horizontal alignment of the text in the control.
  40
  41         <pre>
  42         0: left
  43         1: center
  44         2: right
  45         </pre>
  46
  47         @since OOo 2.0
  48      */
  49     [optional, property] short Align;
  50
  51
  52     /** specifies the background color (RGB) of the control.
  53      */
  54     [optional, property] long BackgroundColor;
  55
  56
  57     /** determines whether the control is enabled or disabled.
  58      */
  59     [property] boolean Enabled;
  60
  61
  62     /** specifies the font attributes of the text in the control.
  63      */
  64     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  65
  66
  67     /** specifies the com::sun::star::text::FontEmphasis
  68         value of the text in the control.
  69      */
  70     [property] short FontEmphasisMark;
  71
  72
  73     /** specifies the com::sun::star::text::FontRelief
  74         value of the text in the control.
  75      */
  76     [property] short FontRelief;
  77
  78
  79     /** specifies the help text of the control.
  80      */
  81     [property] string HelpText;
  82
  83
  84     /** specifies the help URL of the control.
  85      */
  86     [property] string HelpURL;
  87
  88
  89     /** specifies the position of the image, if any, relative to the text, if any
  90
  91         <p>Valid values of this property are specified with ImagePosition.</p>
  92      */
  93     [optional, property] short ImagePosition;
  94
  95
  96     /** specifies an URL to an image to display besides the label of the control
  97         @see Graphic
  98      */
  99     [optional, property] string ImageURL;
 100
 101
 102     /** specifies a graphic to be displayed besides the label of the control
 103
 104         <p>If this property is present, it interacts with the #ImageURL in the
 105         following way:
 106         <ul><li>If #ImageURL is set, #Graphic will be reset
 107             to an object as loaded from the given image URL, or `NULL` if #ImageURL
 108             does not point to a valid image file.</li>
 109             <li>If #Graphic is set, #ImageURL will be reset
 110             to an empty string.</li>
 111         </ul></p>
 112
 113         @since OOo 2.1
 114      */
 115     [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
 116
 117
 118     /** specifies the label of the control.
 119      */
 120     [property] string Label;
 121
 122
 123     /** specifies that the text may be displayed on more than one line.
 124
 125         @since OOo 2.0
 126      */
 127     [optional, property] boolean MultiLine;
 128
 129
 130     /** specifies that the control will be printed with the document.
 131      */
 132     [property] boolean Printable;
 133
 134
 135     /** specifies the state of the control.
 136
 137         <pre>
 138         0: not checked
 139         1: checked
 140         2: don't know
 141         </pre>
 142      */
 143     [property] short State;
 144
 145
 146     /** specifies that the control can be reached with the TAB key.
 147      */
 148     [property] boolean Tabstop;
 149
 150
 151     /** specifies the text color (RGB) of the control.
 152      */
 153     [property] com::sun::star::util::Color TextColor;
 154
 155
 156     /** specifies the text line color (RGB) of the control.
 157      */
 158     [property] com::sun::star::util::Color TextLineColor;
 159
 160
 161     /** specifies that the control may have the state "don't know".
 162      */
 163     [property] boolean TriState;
 164
 165
 166     /** specifies the vertical alignment of the text in the control.
 167
 168         @since OOo 2.0
 169      */
 170     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 171
 172
 173     /** specifies a visual effect to apply to the check box control
 174
 175         <p>Possible values for this property are VisualEffect::FLAT and
 176         VisualEffect::LOOK3D.</p>
 177
 178         @see com::sun::star::awt::VisualEffect
 179
 180         @since OOo 2.0
 181      */
 182     [optional, property] short VisualEffect;
 183
 184     /** denotes the writing mode used in the control, as specified in the
 185         com::sun::star::text::WritingMode2 constants group.
 186
 187         <p>Only com::sun::star::text::WritingMode2::LR_TB and
 188         com::sun::star::text::WritingMode2::RL_TB are supported at the moment.</p>
 189
 190         @since OOo 3.1
 191     */
 192     [optional, property] short WritingMode;
 193 };
 194
 195
 196 }; }; }; };
 197
 198 #endif
 199
 200 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */