offapi/com/sun/star/awt/UnoControlPatternFieldModel.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_UnoControlPatternFieldModel_idl__
  29 #define __com_sun_star_awt_UnoControlPatternFieldModel_idl__
  30
  31 #include <com/sun/star/awt/FontDescriptor.idl>
  32 #include <com/sun/star/awt/UnoControlModel.idl>
  33
  34 #include <com/sun/star/util/Color.idl>
  35
  36 #include <com/sun/star/style/VerticalAlignment.idl>
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** specifies the standard model of an <type>UnoControlPatternField</type>.
  45  */
  46 published service UnoControlPatternFieldModel
  47 {
  48     service com::sun::star::awt::UnoControlModel;
  49
  50     //-------------------------------------------------------------------------
  51
  52     /** specifies the background color (RGB) of the control.
  53      */
  54     [property] com::sun::star::util::Color BackgroundColor;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** specifies the border style of the control.
  59
  60         <pre>
  61         0: No border
  62         1: 3D border
  63         2: simple border
  64         </pre>
  65      */
  66     [property] short Border;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** specifies the color of the border, if present
  71
  72         <p>Not every border style (see <member>Border</member>) may support coloring.
  73         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  74
  75         @since OOo 2.0
  76      */
  77     [optional, property] long BorderColor;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** specifies the edit mask.
  82      */
  83     [property] string EditMask;
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** determines whether the control is enabled or disabled.
  88      */
  89     [property] boolean Enabled;
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** specifies the font attributes of the text in the control.
  94      */
  95     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
 100         value of the text in the control.
 101      */
 102     [property] short FontEmphasisMark;
 103
 104     //-------------------------------------------------------------------------
 105
 106     /** specifies the <type scope="com::sun::star::text">FontRelief</type>
 107         value of the text in the control.
 108      */
 109     [property] short FontRelief;
 110
 111     //-------------------------------------------------------------------------
 112
 113     /** specifies the help text of the control.
 114      */
 115     [property] string HelpText;
 116
 117     //-------------------------------------------------------------------------
 118
 119     /** specifies the help URL of the control.
 120      */
 121     [property] string HelpURL;
 122
 123     //-------------------------------------------------------------------------
 124
 125     /** specifies whether the selection in the control should be hidden when
 126         the control is not active (focused).
 127
 128         @since OOo 2.0
 129      */
 130     [optional, property] boolean HideInactiveSelection;
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** specifies the literal mask.
 135      */
 136     [property] string LiteralMask;
 137
 138     //-------------------------------------------------------------------------
 139
 140     /** specifies the maximum character count.
 141      */
 142     [property] short MaxTextLen;
 143
 144     //-------------------------------------------------------------------------
 145
 146     /** specifies that the control will be printed with the document.
 147      */
 148     [property] boolean Printable;
 149
 150     //-------------------------------------------------------------------------
 151
 152     /** specifies that the content of the control cannot be modified by the
 153         user.
 154      */
 155     [property] boolean ReadOnly;
 156
 157     //-------------------------------------------------------------------------
 158
 159     /** specifies that the text is checked during the user input.
 160      */
 161     [property] boolean StrictFormat;
 162
 163     //-------------------------------------------------------------------------
 164
 165     /** specifies that the control can be reached with the TAB key.
 166      */
 167     [property] boolean Tabstop;
 168
 169     //-------------------------------------------------------------------------
 170
 171     /** specifies the text displayed in the control.
 172      */
 173     [property] string Text;
 174
 175     //-------------------------------------------------------------------------
 176
 177     /** specifies the text color (RGB) of the control.
 178      */
 179     [property] com::sun::star::util::Color TextColor;
 180
 181     //-------------------------------------------------------------------------
 182
 183     /** specifies the text line color (RGB) of the control.
 184      */
 185     [property] com::sun::star::util::Color TextLineColor;
 186
 187     /** denotes the writing mode used in the control, as specified in the
 188         <type scope="com::sun::star::text">WritingMode2</type> constants group.
 189
 190         <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
 191         <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>
 192
 193         @since OOo 3.1
 194     */
 195     [optional, property] short WritingMode;
 196
 197     /** defines how the mouse wheel can be used to scroll through the control's content.
 198
 199         <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property,
 200         and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances
 201         this is possible.</p>
 202     */
 203     [optional, property] short MouseWheelBehavior;
 204
 205     //-------------------------------------------------------------------------
 206
 207     /** specifies the vertical alignment of the text in the control.
 208
 209         @since OOo 3.3
 210      */
 211     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 212 };
 213
 214 //=============================================================================
 215
 216 }; }; }; };
 217
 218 #endif
 219
 220 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */