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