offapi/com/sun/star/text/textfield/SetExpression.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SetExpression.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_text_textfield_SetExpression_idl__
  32 #define __com_sun_star_text_textfield_SetExpression_idl_
  33
  34 #include <com/sun/star/text/TextField.idl>
  35 #include <com/sun/star/text/DependentTextField.idl>
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module text { module textfield {
  40
  41 //=============================================================================
  42 /** specifies service of an expression text field.
  43     @see com::sun::star::text::TextField
  44 */
  45 published service SetExpression
  46 {
  47     service  com::sun::star::text::DependentTextField;
  48
  49     /** contains the textual content of the field.
  50      */
  51     [property]string Content;
  52     /** contains the current content of the text field.
  53         <p> This property is escpecially usefull for import/export purposes. </p>
  54      */
  55     [property]string CurrentPresentation;
  56
  57     /** this is the number format for this field.
  58         @see com::sun::star::util::NumberFormatter
  59     */
  60     [property]long NumberFormat;
  61     /** specifies the type of the numbering as
  62         <type scope="com::sun::star::style">NumberingType</type>
  63      */
  64     [property]short NumberingType;
  65     /** determins whether the content is displayed or evaluated.
  66      */
  67     [property]boolean IsShowFormula;
  68     /** contains an informational text that is displayed at the user
  69      interface if it's an input field.
  70       */
  71     [property]string Hint;
  72     /** determines whether this field is an input field.
  73      */
  74     [property]boolean IsInput;
  75     /** determines whether the field is visible.
  76      */
  77     [property]boolean IsVisible;
  78     /** contains the sequence value when this field is used as sequence field.
  79      */
  80     [property]short SequenceValue;
  81     /** determins the type of the variable as described in
  82         <type scope="com::sun::star::text">SetVariableType</type>
  83      */
  84     [property]short SubType;
  85     /** contains the numerical value of the field.
  86      */
  87     [property]double Value;
  88     /** contains the name of the set expression field master this field is connected to.
  89      */
  90     [property]string VariableName;
  91     /** determines whether changes in language attributes at the position the text field
  92         is located also change the number format as appropriate for this language.
  93
  94     @since OOo 1.1.2
  95      */
  96     [optional, property] boolean IsFixedLanguage;
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; }; };
 102
 103 #endif
 104