offapi/com/sun/star/awt/UnoControlEditModel.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_UnoControlEditModel_idl__
  20 #define __com_sun_star_awt_UnoControlEditModel_idl__
  21
  22 #include <com/sun/star/awt/FontDescriptor.idl>
  23 #include <com/sun/star/awt/UnoControlModel.idl>
  24
  25 #include <com/sun/star/util/Color.idl>
  26
  27 #include <com/sun/star/style/VerticalAlignment.idl>
  28
  29
  30  module com {  module sun {  module star {  module awt {
  31
  32
  33 /** specifies the standard model of an UnoControlEdit.
  34  */
  35 published service UnoControlEditModel
  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     [property] short Align;
  49
  50
  51     /** If set to true an horizontal scrollbar will be added automatically
  52         when needed.
  53
  54         @since OOo 2.3
  55      */
  56     [optional, property] boolean AutoHScroll;
  57
  58
  59     /** If set to true an vertical scrollbar will be added automatically
  60         when needed.
  61
  62         @since OOo 2.3
  63      */
  64     [optional, property] boolean AutoVScroll;
  65
  66
  67     /** specifies the background color (RGB) of the control.
  68      */
  69     [property] com::sun::star::util::Color BackgroundColor;
  70
  71
  72     /** specifies the border style of the control.
  73
  74         <pre>
  75         0: No border
  76         1: 3D border
  77         2: simple border
  78         </pre>
  79      */
  80     [property] short Border;
  81
  82
  83     /** specifies the color of the border, if present
  84
  85         <p>Not every border style (see #Border) may support coloring.
  86         For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>
  87
  88         @since OOo 2.0
  89      */
  90     [optional, property] long BorderColor;
  91
  92
  93     /** specifies the echo character for a password edit field.
  94      */
  95     [optional, property] short EchoChar;
  96
  97
  98     /** determines whether the control is enabled or disabled.
  99      */
 100     [property] boolean Enabled;
 101
 102
 103     /** specifies the font attributes of the text in the control.
 104      */
 105     [property] com::sun::star::awt::FontDescriptor FontDescriptor;
 106
 107
 108     /** specifies the com::sun::star::text::FontEmphasis
 109         value of the text in the control.
 110      */
 111     [property] short FontEmphasisMark;
 112
 113
 114     /** specifies the com::sun::star::text::FontRelief
 115         value of the text in the control.
 116      */
 117     [property] short FontRelief;
 118
 119
 120     /** specifies if hard line breaks will be returned in the
 121         XTextComponent::getText() method.
 122      */
 123     [property] boolean HardLineBreaks;
 124
 125
 126     /** specifies the help text of the control.
 127      */
 128     [property] string HelpText;
 129
 130
 131     /** specifies the help URL of the control.
 132      */
 133     [property] string HelpURL;
 134
 135
 136     /** specifies whether the selection in the control should be hidden when
 137         the control is not active (focused).
 138
 139         @since OOo 2.0
 140      */
 141     [optional, property] boolean HideInactiveSelection;
 142
 143
 144     /** specifies if the content of the control can be scrolled in
 145         the horizontal direction.
 146      */
 147     [property] boolean HScroll;
 148
 149
 150     /** specifies which line end type should be used for multi line text
 151
 152         <p>Controls working with this model care for this setting when the user enters
 153         text. Every line break entered into the control will be treated according to this
 154         setting, so that the #Text property always contains only
 155         line ends in the format specified.</p>
 156
 157         <p>Possible values are all constants from the LineEndFormat group.</p>
 158
 159         <p>Note that this setting is usually not relevant when you set new text via the API.
 160         No matter which line end format is used in this new text then, usual control implementations
 161         should recognize all line end formats and display them properly.</p>
 162
 163         @since OOo 2.0
 164      */
 165     [optional, property] short LineEndFormat;
 166
 167
 168     /** specifies the maximum character count.
 169
 170         <p>There's no limitation, if set to 0.</p>
 171      */
 172     [property] short MaxTextLen;
 173
 174
 175     /** specifies that the control may have more than one line.
 176      */
 177     [property] boolean MultiLine;
 178
 179
 180     /** specifies whether the control paints it background or not.
 181
 182         @since OOo 2.3
 183      */
 184     [optional, property] boolean PaintTransparent;
 185
 186
 187     /** specifies that the control will be printed with the document.
 188      */
 189     [property] boolean Printable;
 190
 191
 192     /** specifies that the content of the control cannot be modified by the user.
 193      */
 194     [property] boolean ReadOnly;
 195
 196
 197     /** specifies that the control can be reached with the TAB key.
 198      */
 199     [property] boolean Tabstop;
 200
 201
 202     /** specifies the text displayed in the control.
 203      */
 204     [property] string Text;
 205
 206
 207     /** specifies the text color (RGB) of the control.
 208      */
 209     [property] com::sun::star::util::Color TextColor;
 210
 211
 212     /** specifies the text line color (RGB) of the control.
 213      */
 214     [property] com::sun::star::util::Color TextLineColor;
 215
 216
 217     /** specifies if the content of the control can be scrolled in
 218         the vertical direction.
 219      */
 220     [property] boolean VScroll;
 221
 222     /** denotes the writing mode used in the control, as specified in the
 223         com::sun::star::text::WritingMode2 constants group.
 224
 225         <p>Only com::sun::star::text::WritingMode2::LR_TB and
 226         com::sun::star::text::WritingMode2::RL_TB are supported at the moment.</p>
 227
 228         @since OOo 3.1
 229     */
 230     [optional, property] short WritingMode;
 231
 232
 233     /** specifies the vertical alignment of the text in the control.
 234
 235         @since OOo 3.3
 236      */
 237     [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
 238 };
 239
 240
 241 }; }; }; };
 242
 243 #endif
 244
 245 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */