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