1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_awt_UnoControlEditModel_idl__ 28#define __com_sun_star_awt_UnoControlEditModel_idl__ 29 30#ifndef __com_sun_star_awt_FontDescriptor_idl__ 31#include <com/sun/star/awt/FontDescriptor.idl> 32#endif 33 34#ifndef __com_sun_star_awt_UnoControlModel_idl__ 35#include <com/sun/star/awt/UnoControlModel.idl> 36#endif 37 38#ifndef __com_sun_star_util_Color_idl__ 39#include <com/sun/star/util/Color.idl> 40#endif 41 42#ifndef __com_sun_star_style_VerticalAlignment_idl__ 43#include <com/sun/star/style/VerticalAlignment.idl> 44#endif 45 46//============================================================================= 47 48 module com { module sun { module star { module awt { 49 50//============================================================================= 51 52/** specifies the standard model of an <type>UnoControlEdit</type>. 53 */ 54published service UnoControlEditModel 55{ 56 service com::sun::star::awt::UnoControlModel; 57 58 //------------------------------------------------------------------------- 59 60 /** specifies the horizontal alignment of the text in the control. 61 62 <pre> 63 0: left 64 1: center 65 2: right 66 </pre> 67 */ 68 [property] short Align; 69 70 //------------------------------------------------------------------------- 71 72 /** If set to true an horizontal scrollbar will be added automaticly 73 when needed. 74 75 @since OOo 2.3 76 */ 77 [optional, property] boolean AutoHScroll; 78 79 //------------------------------------------------------------------------- 80 81 /** If set to true an vertical scrollbar will be added automaticly 82 when needed. 83 84 @since OOo 2.3 85 */ 86 [optional, property] boolean AutoVScroll; 87 88 //------------------------------------------------------------------------- 89 90 /** specifies the background color (RGB) of the control. 91 */ 92 [property] com::sun::star::util::Color BackgroundColor; 93 94 //------------------------------------------------------------------------- 95 96 /** specifies the border style of the control. 97 98 <pre> 99 0: No border 100 1: 3D border 101 2: simple border 102 </pre> 103 */ 104 [property] short Border; 105 106 //------------------------------------------------------------------------- 107 108 /** specifies the color of the border, if present 109 110 <p>Not every border style (see <member>Border</member>) may support coloring. 111 For instance, usually a border with 3D effect will ignore the BorderColor setting.</p> 112 113 @since OOo 2.0 114 */ 115 [optional, property] long BorderColor; 116 117 //------------------------------------------------------------------------- 118 119 /** specifies the echo character for a password edit field. 120 */ 121 [optional, property] short EchoChar; 122 123 //------------------------------------------------------------------------- 124 125 /** determines whether the control is enabled or disabled. 126 */ 127 [property] boolean Enabled; 128 129 //------------------------------------------------------------------------- 130 131 /** specifies the font attributes of the text in the control. 132 */ 133 [property] com::sun::star::awt::FontDescriptor FontDescriptor; 134 135 //------------------------------------------------------------------------- 136 137 /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> 138 value of the text in the control. 139 */ 140 [property] short FontEmphasisMark; 141 142 //------------------------------------------------------------------------- 143 144 /** specifies the <type scope="com::sun::star::text">FontRelief</type> 145 value of the text in the control. 146 */ 147 [property] short FontRelief; 148 149 //------------------------------------------------------------------------- 150 151 /** specifies if hard line breaks will be returned in the 152 <member>XTextComponent::getText</member> method. 153 */ 154 [property] boolean HardLineBreaks; 155 156 //------------------------------------------------------------------------- 157 158 /** specifies the help text of the control. 159 */ 160 [property] string HelpText; 161 162 //------------------------------------------------------------------------- 163 164 /** specifies the help URL of the control. 165 */ 166 [property] string HelpURL; 167 168 //------------------------------------------------------------------------- 169 170 /** specifies whether the selection in the control should be hidden when 171 the control is not active (focused). 172 173 @since OOo 2.0 174 */ 175 [optional, property] boolean HideInactiveSelection; 176 177 //------------------------------------------------------------------------- 178 179 /** specifies if the content of the control can be scrolled in 180 the horizontal direction. 181 */ 182 [property] boolean HScroll; 183 184 //------------------------------------------------------------------------- 185 186 /** specifies which line end type should be used for multi line text 187 188 <p>Controls working with this model care for this setting when the user enters 189 text. Every line break entered into the control will be treated according to this 190 setting, so that the <member>Text</member> property always contains only 191 line ends in the format specified.</p> 192 193 <p>Possible values are all constants from the <type>LineEndFormat</type> group.</p> 194 195 <p>Note that this setting is usually not relevant when you set new text via the API. 196 No matter which line end format is used in this new text then, usual control implementations 197 should recognize all line end formats and display them properly.</p> 198 199 @since OOo 2.0 200 */ 201 [optional, property] short LineEndFormat; 202 203 //------------------------------------------------------------------------- 204 205 /** specifies the maximum character count. 206 207 <p>There's no limitation, if set to 0.</p> 208 */ 209 [property] short MaxTextLen; 210 211 //------------------------------------------------------------------------- 212 213 /** specifies that the control may have more than one line. 214 */ 215 [property] boolean MultiLine; 216 217 //------------------------------------------------------------------------- 218 219 /** specifies whether the control paints it background or not. 220 221 @since OOo 2.3 222 */ 223 [optional, property] boolean PaintTransparent; 224 225 //------------------------------------------------------------------------- 226 227 /** specifies that the control will be printed with the document. 228 */ 229 [property] boolean Printable; 230 231 //------------------------------------------------------------------------- 232 233 /** specifies that the content of the control cannot be modified by the user. 234 */ 235 [property] boolean ReadOnly; 236 237 //------------------------------------------------------------------------- 238 239 /** specifies that the control can be reached with the TAB key. 240 */ 241 [property] boolean Tabstop; 242 243 //------------------------------------------------------------------------- 244 245 /** specifies the text displayed in the control. 246 */ 247 [property] string Text; 248 249 //------------------------------------------------------------------------- 250 251 /** specifies the text color (RGB) of the control. 252 */ 253 [property] com::sun::star::util::Color TextColor; 254 255 //------------------------------------------------------------------------- 256 257 /** specifies the text line color (RGB) of the control. 258 */ 259 [property] com::sun::star::util::Color TextLineColor; 260 261 //------------------------------------------------------------------------- 262 263 /** specifies if the content of the control can be scrolled in 264 the vertical direction. 265 */ 266 [property] boolean VScroll; 267 268 /** denotes the writing mode used in the control, as specified in the 269 <type scope="com::sun::star::text">WritingMode2</type> constants group. 270 271 <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and 272 <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p> 273 274 @since OOo 3.1 275 */ 276 [optional, property] short WritingMode; 277 278 //------------------------------------------------------------------------- 279 280 /** specifies the vertical alignment of the text in the control. 281 282 @since OOo 3.3 283 */ 284 [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign; 285}; 286 287//============================================================================= 288 289}; }; }; }; 290 291#endif 292