offapi/com/sun/star/text/textfield/SetExpression.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 #ifndef __com_sun_star_text_textfield_SetExpression_idl__
  21 #define __com_sun_star_text_textfield_SetExpression_idl_
  22
  23 #include <com/sun/star/text/TextField.idl>
  24 #include <com/sun/star/text/DependentTextField.idl>
  25
  26
  27 module com { module sun { module star { module text { module textfield {
  28
  29 /** specifies service of an expression text field.
  30     @see com::sun::star::text::TextField
  31 */
  32 published service SetExpression
  33 {
  34     service  com::sun::star::text::DependentTextField;
  35
  36     /** contains the textual content of the field.
  37      */
  38     [property] string Content;
  39
  40     /** contains the current content of the text field.
  41         <p>This property is especially useful for import/export purposes.</p>
  42      */
  43     [property] string CurrentPresentation;
  44
  45     /** this is the number format for this field.
  46         @see com::sun::star::util::NumberFormatter
  47     */
  48     [property] long NumberFormat;
  49
  50     /** specifies the type of the numbering as
  51         com::sun::star::style::NumberingType
  52      */
  53     [property] short NumberingType;
  54
  55     /** determines whether the content is displayed or evaluated.
  56      */
  57     [property] boolean IsShowFormula;
  58
  59     /** contains an informational text that is displayed at the user
  60      interface if it's an input field.
  61       */
  62     [property] string Hint;
  63
  64     /** determines whether this field is an input field.
  65      */
  66     [property] boolean IsInput;
  67
  68     /** determines whether the field is visible.
  69      */
  70     [property] boolean IsVisible;
  71
  72     /** contains the sequence value when this field is used as sequence field.
  73      */
  74     [property] short SequenceValue;
  75
  76     /** determines the type of the variable as described in
  77         com::sun::star::text::SetVariableType
  78      */
  79     [property] short SubType;
  80
  81     /** contains the numerical value of the field.
  82      */
  83     [property]double Value;
  84
  85     /** contains the name of the set expression field master this field is
  86         connected to.
  87      */
  88     [property, readonly] string VariableName;
  89
  90     /** determines whether changes in language attributes at the position
  91         the text field is located also change the number format as appropriate
  92         for this language.
  93
  94     @since OOo 1.1.2
  95      */
  96     [optional, property] boolean IsFixedLanguage;
  97 };
  98
  99
 100 }; }; }; }; };
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */