1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_awt_UnoControlFormattedFieldModel_idl__ 24cdf0e10cSrcweir#define __com_sun_star_awt_UnoControlFormattedFieldModel_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_awt_FontDescriptor_idl__ 27cdf0e10cSrcweir#include <com/sun/star/awt/FontDescriptor.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_awt_UnoControlModel_idl__ 31cdf0e10cSrcweir#include <com/sun/star/awt/UnoControlModel.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_util_Color_idl__ 35cdf0e10cSrcweir#include <com/sun/star/util/Color.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__ 39cdf0e10cSrcweir#include <com/sun/star/util/XNumberFormatsSupplier.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_style_VerticalAlignment_idl__ 43cdf0e10cSrcweir#include <com/sun/star/style/VerticalAlignment.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir//============================================================================= 47cdf0e10cSrcweir 48cdf0e10cSrcweir module com { module sun { module star { module awt { 49cdf0e10cSrcweir 50cdf0e10cSrcweir//============================================================================= 51cdf0e10cSrcweir 52cdf0e10cSrcweir/** specifies the standard model of an <type>UnoControlFormattedField </type>. 53cdf0e10cSrcweir */ 54cdf0e10cSrcweirpublished service UnoControlFormattedFieldModel 55cdf0e10cSrcweir{ 56cdf0e10cSrcweir service com::sun::star::awt::UnoControlModel; 57cdf0e10cSrcweir 58cdf0e10cSrcweir //------------------------------------------------------------------------- 59cdf0e10cSrcweir 60cdf0e10cSrcweir /** specifies the horiztonal alignment of the text in the control. 61cdf0e10cSrcweir 62cdf0e10cSrcweir <pre> 63cdf0e10cSrcweir 0: left 64cdf0e10cSrcweir 1: center 65cdf0e10cSrcweir 2: right 66cdf0e10cSrcweir </pre> 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir [property] short Align; 69cdf0e10cSrcweir 70cdf0e10cSrcweir //------------------------------------------------------------------------- 71cdf0e10cSrcweir 72cdf0e10cSrcweir /** specifies the background color (RGB) of the control. 73cdf0e10cSrcweir */ 74cdf0e10cSrcweir [property] com::sun::star::util::Color BackgroundColor; 75cdf0e10cSrcweir 76cdf0e10cSrcweir //------------------------------------------------------------------------- 77cdf0e10cSrcweir 78cdf0e10cSrcweir /** specifies the border style of the control. 79cdf0e10cSrcweir 80cdf0e10cSrcweir <pre> 81cdf0e10cSrcweir 0: No border 82cdf0e10cSrcweir 1: 3D border 83cdf0e10cSrcweir 2: simple border 84cdf0e10cSrcweir </pre> 85cdf0e10cSrcweir */ 86cdf0e10cSrcweir [property] short Border; 87cdf0e10cSrcweir 88cdf0e10cSrcweir //------------------------------------------------------------------------- 89cdf0e10cSrcweir 90cdf0e10cSrcweir /** specifies the color of the border, if present 91cdf0e10cSrcweir 92cdf0e10cSrcweir <p>Not every border style (see <member>Border</member>) may support coloring. 93cdf0e10cSrcweir For instance, usually a border with 3D effect will ignore the BorderColor setting.</p> 94cdf0e10cSrcweir 95cdf0e10cSrcweir @since OOo 2.0 96cdf0e10cSrcweir */ 97cdf0e10cSrcweir [optional, property] long BorderColor; 98cdf0e10cSrcweir 99cdf0e10cSrcweir //------------------------------------------------------------------------- 100cdf0e10cSrcweir 101cdf0e10cSrcweir /** specifies the default value of the formatted field. 102cdf0e10cSrcweir 103cdf0e10cSrcweir <p>This may be a numeric value (double) or a string, depending on 104cdf0e10cSrcweir the formatting of the field.</p> 105cdf0e10cSrcweir */ 106cdf0e10cSrcweir [property] any EffectiveDefault; 107cdf0e10cSrcweir 108cdf0e10cSrcweir //------------------------------------------------------------------------- 109cdf0e10cSrcweir 110cdf0e10cSrcweir /** specifies the maximum value that can be entered. 111cdf0e10cSrcweir 112cdf0e10cSrcweir <p>This property is ignored if the format of the field is no numeric 113cdf0e10cSrcweir format.</p> 114cdf0e10cSrcweir */ 115cdf0e10cSrcweir [property] double EffectiveMax; 116cdf0e10cSrcweir 117cdf0e10cSrcweir //------------------------------------------------------------------------- 118cdf0e10cSrcweir 119cdf0e10cSrcweir /** specifies the minimum value that can be entered. 120cdf0e10cSrcweir 121cdf0e10cSrcweir <p>This property is ignored if the format of the field is no numeric 122cdf0e10cSrcweir format.</p> 123cdf0e10cSrcweir */ 124cdf0e10cSrcweir [property] double EffectiveMin; 125cdf0e10cSrcweir 126cdf0e10cSrcweir //------------------------------------------------------------------------- 127cdf0e10cSrcweir 128cdf0e10cSrcweir /** specifies the current value of the formatted field. 129cdf0e10cSrcweir 130cdf0e10cSrcweir <p>This may be a numeric value (double) or a string, depending on 131cdf0e10cSrcweir the formatting of the field.</p> 132cdf0e10cSrcweir */ 133cdf0e10cSrcweir [property] double EffectiveValue; 134cdf0e10cSrcweir 135cdf0e10cSrcweir //------------------------------------------------------------------------- 136cdf0e10cSrcweir 137cdf0e10cSrcweir /** determines whether the control is enabled or disabled. 138cdf0e10cSrcweir */ 139cdf0e10cSrcweir [property] boolean Enabled; 140cdf0e10cSrcweir 141cdf0e10cSrcweir //------------------------------------------------------------------------- 142cdf0e10cSrcweir 143cdf0e10cSrcweir /** specifies the font attributes of the text in the control. 144cdf0e10cSrcweir */ 145cdf0e10cSrcweir [property] com::sun::star::awt::FontDescriptor FontDescriptor; 146cdf0e10cSrcweir 147cdf0e10cSrcweir //------------------------------------------------------------------------- 148cdf0e10cSrcweir 149cdf0e10cSrcweir /** specifies the <type scope="com::sun::star::text">FontEmphasis</type> 150cdf0e10cSrcweir value of the text in the control. 151cdf0e10cSrcweir */ 152cdf0e10cSrcweir [property] short FontEmphasisMark; 153cdf0e10cSrcweir 154cdf0e10cSrcweir //------------------------------------------------------------------------- 155cdf0e10cSrcweir 156cdf0e10cSrcweir /** specifies the <type scope="com::sun::star::text">FontRelief</type> 157cdf0e10cSrcweir value of the text in the control. 158cdf0e10cSrcweir */ 159cdf0e10cSrcweir [property] short FontRelief; 160cdf0e10cSrcweir 161cdf0e10cSrcweir //------------------------------------------------------------------------- 162cdf0e10cSrcweir 163cdf0e10cSrcweir /** specifies the format to be used when formatting the field input 164cdf0e10cSrcweir and output. 165cdf0e10cSrcweir 166cdf0e10cSrcweir <p>This value is meaningful relative to the FormatsSupplier property 167cdf0e10cSrcweir only.</p> 168cdf0e10cSrcweir */ 169cdf0e10cSrcweir [property] long FormatKey; 170cdf0e10cSrcweir 171cdf0e10cSrcweir //------------------------------------------------------------------------- 172cdf0e10cSrcweir 173cdf0e10cSrcweir /** supplies the formats the field should work with. 174cdf0e10cSrcweir */ 175cdf0e10cSrcweir [property] com::sun::star::util::XNumberFormatsSupplier FormatsSupplier; 176cdf0e10cSrcweir 177cdf0e10cSrcweir //------------------------------------------------------------------------- 178cdf0e10cSrcweir 179cdf0e10cSrcweir /** specifies the help text of the control. 180cdf0e10cSrcweir */ 181cdf0e10cSrcweir [property] string HelpText; 182cdf0e10cSrcweir 183cdf0e10cSrcweir //------------------------------------------------------------------------- 184cdf0e10cSrcweir 185cdf0e10cSrcweir /** specifies the help URL of the control. 186cdf0e10cSrcweir */ 187cdf0e10cSrcweir [property] string HelpURL; 188cdf0e10cSrcweir 189cdf0e10cSrcweir 190cdf0e10cSrcweir //------------------------------------------------------------------------- 191cdf0e10cSrcweir 192cdf0e10cSrcweir /** specifies whether the selection in the control should be hidden when 193cdf0e10cSrcweir the control is not active (focused). 194cdf0e10cSrcweir 195cdf0e10cSrcweir @since OOo 2.0 196cdf0e10cSrcweir */ 197cdf0e10cSrcweir [optional, property] boolean HideInactiveSelection; 198cdf0e10cSrcweir 199cdf0e10cSrcweir //------------------------------------------------------------------------- 200cdf0e10cSrcweir 201cdf0e10cSrcweir /** specifies the maximum character count. 202cdf0e10cSrcweir 203cdf0e10cSrcweir <p>There's no limitation, if set to 0.</p> 204cdf0e10cSrcweir */ 205cdf0e10cSrcweir [property] short MaxTextLen; 206cdf0e10cSrcweir 207cdf0e10cSrcweir //------------------------------------------------------------------------- 208cdf0e10cSrcweir 209cdf0e10cSrcweir /** specifies that the control will be printed with the document. 210cdf0e10cSrcweir */ 211cdf0e10cSrcweir [property] boolean Printable; 212cdf0e10cSrcweir 213cdf0e10cSrcweir //------------------------------------------------------------------------- 214cdf0e10cSrcweir 215cdf0e10cSrcweir /** specifies that the content of the control cannot be modified by the 216cdf0e10cSrcweir user. 217cdf0e10cSrcweir */ 218cdf0e10cSrcweir [property] boolean ReadOnly; 219cdf0e10cSrcweir 220cdf0e10cSrcweir //------------------------------------------------------------------------- 221cdf0e10cSrcweir 222cdf0e10cSrcweir /** specifies whether the mouse should show repeating behaviour, i.e. 223cdf0e10cSrcweir repeatedly trigger an action when keeping pressed. 224cdf0e10cSrcweir 225cdf0e10cSrcweir @since OOo 2.0 226cdf0e10cSrcweir */ 227cdf0e10cSrcweir [optional, property] boolean Repeat; 228cdf0e10cSrcweir 229cdf0e10cSrcweir //------------------------------------------------------------------------- 230cdf0e10cSrcweir 231cdf0e10cSrcweir /** specifies the mouse repeat delay, in milliseconds. 232cdf0e10cSrcweir 233cdf0e10cSrcweir <p>When the user presses a mouse in a control area where this triggers 234cdf0e10cSrcweir an action (such as spinning the value), then usual control implementations 235cdf0e10cSrcweir allow to repeatedly trigger this action, without the need to release the 236cdf0e10cSrcweir mouse button and to press it again. The delay between two such triggers 237cdf0e10cSrcweir is specified with this property.</p> 238cdf0e10cSrcweir 239cdf0e10cSrcweir @since OOo 2.0 240cdf0e10cSrcweir */ 241cdf0e10cSrcweir [optional, property] long RepeatDelay; 242cdf0e10cSrcweir 243cdf0e10cSrcweir //------------------------------------------------------------------------- 244cdf0e10cSrcweir 245cdf0e10cSrcweir /** specifies that the control has a spin button. 246cdf0e10cSrcweir */ 247cdf0e10cSrcweir [property] boolean Spin; 248cdf0e10cSrcweir 249cdf0e10cSrcweir //------------------------------------------------------------------------- 250cdf0e10cSrcweir 251cdf0e10cSrcweir /** specifies that the text is checked during the user input. 252cdf0e10cSrcweir 253cdf0e10cSrcweir <p>This property is optional - not every component implementing this 254cdf0e10cSrcweir service is required to provide it, as real-time input checking on a 255cdf0e10cSrcweir formatted field may be pretty expensive.</p> 256cdf0e10cSrcweir */ 257cdf0e10cSrcweir [optional, property] boolean StrictFormat; 258cdf0e10cSrcweir 259cdf0e10cSrcweir //------------------------------------------------------------------------- 260cdf0e10cSrcweir 261cdf0e10cSrcweir /** specifies that the control can be reached with the TAB key. 262cdf0e10cSrcweir */ 263cdf0e10cSrcweir [property] boolean Tabstop; 264cdf0e10cSrcweir 265cdf0e10cSrcweir //------------------------------------------------------------------------- 266cdf0e10cSrcweir 267cdf0e10cSrcweir /** specifies the text displayed in the control. 268cdf0e10cSrcweir */ 269cdf0e10cSrcweir [property] string Text; 270cdf0e10cSrcweir 271cdf0e10cSrcweir //------------------------------------------------------------------------- 272cdf0e10cSrcweir 273cdf0e10cSrcweir /** specifies the text color (RGB) of the control. 274cdf0e10cSrcweir */ 275cdf0e10cSrcweir [property] com::sun::star::util::Color TextColor; 276cdf0e10cSrcweir 277cdf0e10cSrcweir //------------------------------------------------------------------------- 278cdf0e10cSrcweir 279cdf0e10cSrcweir /** specifies the text line color (RGB) of the control. 280cdf0e10cSrcweir */ 281cdf0e10cSrcweir [property] com::sun::star::util::Color TextLineColor; 282cdf0e10cSrcweir 283cdf0e10cSrcweir //------------------------------------------------------------------------- 284cdf0e10cSrcweir 285cdf0e10cSrcweir /** specifies that the text is treated as a number. 286cdf0e10cSrcweir */ 287cdf0e10cSrcweir [property] boolean TreatAsNumber; 288cdf0e10cSrcweir 289cdf0e10cSrcweir /** denotes the writing mode used in the control, as specified in the 290cdf0e10cSrcweir <type scope="com::sun::star::text">WritingMode2</type> constants group. 291cdf0e10cSrcweir 292cdf0e10cSrcweir <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and 293cdf0e10cSrcweir <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p> 294cdf0e10cSrcweir 295cdf0e10cSrcweir @since OOo 3.1 296cdf0e10cSrcweir */ 297cdf0e10cSrcweir [optional, property] short WritingMode; 298cdf0e10cSrcweir 299cdf0e10cSrcweir /** defines how the mouse wheel can be used to scroll through the control's content. 300cdf0e10cSrcweir 301cdf0e10cSrcweir <p>Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, 302cdf0e10cSrcweir and one of the <type>MouseWheelBehavior</type> constants, you can control under which circumstances 303cdf0e10cSrcweir this is possible.</p> 304cdf0e10cSrcweir */ 305cdf0e10cSrcweir [optional, property] short MouseWheelBehavior; 306cdf0e10cSrcweir 307cdf0e10cSrcweir //------------------------------------------------------------------------- 308cdf0e10cSrcweir 309cdf0e10cSrcweir /** specifies the vertical alignment of the text in the control. 310cdf0e10cSrcweir 311cdf0e10cSrcweir @since OOo 3.3 312cdf0e10cSrcweir */ 313cdf0e10cSrcweir [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign; 314cdf0e10cSrcweir}; 315cdf0e10cSrcweir 316cdf0e10cSrcweir//============================================================================= 317cdf0e10cSrcweir 318cdf0e10cSrcweir}; }; }; }; 319cdf0e10cSrcweir 320cdf0e10cSrcweir#endif 321