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