offapi/com/sun/star/awt/UnoControlRadioButtonModel.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: UnoControlRadioButtonModel.idl,v $
  10  * $Revision: 1.14 $
  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_UnoControlRadioButtonModel_idl__
  31 #define __com_sun_star_awt_UnoControlRadioButtonModel_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
  52  module com {  module sun {  module star {  module awt {
  53
  54 //=============================================================================
  55
  56 /** specifies the standard model of an <type>UnoControlRadioButton</type>.
  57  */
  58 published service UnoControlRadioButtonModel
  59 {
  60     service com::sun::star::awt::UnoControlModel;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** specifies the horizontal alignment of the text in the control.
  65
  66         <pre>
  67         0: left
  68         1: center
  69         2: right
  70         </pre>
  71
  72         @since OOo 2.0.0
  73      */
  74     [optional, property] short Align;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** specifies the background color (RGB) of the control.
  79      */
  80     [optional, property] long BackgroundColor;
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** determines whether the control is enabled or disabled.
  85      */
  86     [property] boolean Enabled;
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** specifies the font attributes of the text in the control.
  91      */
  92     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
  97         value of the text in the control.
  98      */
  99     [property] short FontEmphasisMark;
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 104         value of the text in the control.
 105      */
 106     [property] short FontRelief;
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** specifies the help text of the control.
 111      */
 112     [property] string HelpText;
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** specifies the help URL of the control.
 117      */
 118     [property] string HelpURL;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** specifies the position of the image, if any, relative to the text, if any
 123
 124         <p>Valid values of this property are specified with <type>ImagePosition</type>.</p>
 125     */
 126     [optional, property] short ImagePosition;
 127
 128     //-------------------------------------------------------------------------
 129
 130     /** specifies an URL to an image to display besides the label of the control
 131         @see Graphic
 132      */
 133     [optional, property] string ImageURL;
 134
 135     //-------------------------------------------------------------------------
 136
 137     /** specifies a graphic to be displayed besides the label of the control
 138
 139         <p>If this property is present, it interacts with the <member>ImageURL</member>in the
 140         following way:
 141         <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
 142             to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
 143             does not point to a valid image file.</li>
 144             <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
 145             to an empty string.</li>
 146         </ul></p>
 147
 148         @since OOo 2.1
 149      */
 150     [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
 151
 152     //-------------------------------------------------------------------------
 153
 154     /** specifies the label of the control.
 155      */
 156     [property] string Label;
 157
 158     //-------------------------------------------------------------------------
 159
 160     /** specifies that the text may be displayed on more than one line.
 161
 162         @since OOo 2.0.0
 163      */
 164     [optional, property] boolean MultiLine;
 165
 166     //-------------------------------------------------------------------------
 167
 168     /** specifies that the control will be printed with the document.
 169      */
 170     [property] boolean Printable;
 171
 172     //-------------------------------------------------------------------------
 173
 174     /** specifies the state of the control.
 175
 176         <pre>
 177         0: not checked
 178         1: checked
 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 the vertical alignment of the text in the control.
 204
 205         @since OOo 2.0.0
 206      */
 207     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 208
 209     //-------------------------------------------------------------------------
 210
 211     /** specifies a visual effect to apply to the radio button control.
 212
 213         <p>Possible values for this property are <type>VisualEffect</type>::FLAT and
 214         <type>VisualEffect</type>::LOOK3D.</p>
 215
 216         @see com::sun::star::awt::VisualEffect
 217
 218         @since OOo 2.0.0
 219      */
 220     [optional, property] short VisualEffect;
 221
 222     /** denotes the writing mode used in the control, as specified in the
 223         <type scope="com::sun::star::text">WritingMode2</type> constants group.
 224
 225         <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
 226         <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
 227
 228         @since OOo 3.1
 229     */
 230     [optional, property] short WritingMode;
 231 };
 232
 233 //=============================================================================
 234
 235 }; }; }; };
 236
 237 #endif