offapi/com/sun/star/awt/UnoControlRadioButtonModel.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_UnoControlRadioButtonModel_idl__
  20 #define __com_sun_star_awt_UnoControlRadioButtonModel_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
  30  module com {  module sun {  module star {  module awt {
  31
  32
  33 /** specifies the standard model of an <type>UnoControlRadioButton</type>.
  34  */
  35 published service UnoControlRadioButtonModel
  36 {
  37     service com::sun::star::awt::UnoControlModel;
  38
  39
  40     /** specifies the horizontal alignment of the text in the control.
  41
  42         <pre>
  43         0: left
  44         1: center
  45         2: right
  46         </pre>
  47
  48         @since OOo 2.0
  49      */
  50     [optional, property] short Align;
  51
  52
  53     /** specifies the background color (RGB) of the control.
  54      */
  55     [optional, property] long BackgroundColor;
  56
  57
  58     /** determines whether the control is enabled or disabled.
  59      */
  60     [property] boolean Enabled;
  61
  62
  63     /** specifies the font attributes of the text in the control.
  64      */
  65     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  66
  67
  68     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
  69         value of the text in the control.
  70      */
  71     [property] short FontEmphasisMark;
  72
  73
  74     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
  75         value of the text in the control.
  76      */
  77     [property] short FontRelief;
  78
  79
  80     /** specifies the help text of the control.
  81      */
  82     [property] string HelpText;
  83
  84
  85     /** specifies the help URL of the control.
  86      */
  87     [property] string HelpURL;
  88
  89
  90     /** specifies the position of the image, if any, relative to the text, if any
  91
  92         <p>Valid values of this property are specified with <type>ImagePosition</type>.</p>
  93     */
  94     [optional, property] short ImagePosition;
  95
  96
  97     /** specifies an URL to an image to display besides the label of the control
  98         @see Graphic
  99      */
 100     [optional, property] string ImageURL;
 101
 102
 103     /** specifies a graphic to be displayed besides the label of the control
 104
 105         <p>If this property is present, it interacts with the <member>ImageURL</member>in the
 106         following way:
 107         <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
 108             to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
 109             does not point to a valid image file.</li>
 110             <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
 111             to an empty string.</li>
 112         </ul></p>
 113
 114         @since OOo 2.1
 115      */
 116     [optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
 117
 118
 119     /** specifies the label of the control.
 120      */
 121     [property] string Label;
 122
 123
 124     /** specifies that the text may be displayed on more than one line.
 125
 126         @since OOo 2.0
 127      */
 128     [optional, property] boolean MultiLine;
 129
 130
 131     /** specifies that the control will be printed with the document.
 132      */
 133     [property] boolean Printable;
 134
 135
 136     /** specifies the state of the control.
 137
 138         <pre>
 139         0: not checked
 140         1: checked
 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 the vertical alignment of the text in the control.
 162
 163         @since OOo 2.0
 164      */
 165     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 166
 167
 168     /** specifies a visual effect to apply to the radio button control.
 169
 170         <p>Possible values for this property are <type>VisualEffect</type>::FLAT and
 171         <type>VisualEffect</type>::LOOK3D.</p>
 172
 173         @see com::sun::star::awt::VisualEffect
 174
 175         @since OOo 2.0
 176      */
 177     [optional, property] short VisualEffect;
 178
 179     /** denotes the writing mode used in the control, as specified in the
 180         <type scope="com::sun::star::text">WritingMode2</type> constants group.
 181
 182         <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
 183         <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
 184
 185         @since OOo 3.1
 186     */
 187     [optional, property] short WritingMode;
 188 };
 189
 190
 191 }; }; }; };
 192
 193 #endif
 194
 195 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */