offapi/com/sun/star/text/textfield/ConditionalText.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_ConditionalText_idl__
  21 #define __com_sun_star_text_textfield_ConditionalText_idl_
  22
  23 #include <com/sun/star/text/TextField.idl>
  24
  25
  26 module com { module sun { module star { module text { module textfield {
  27
  28 /** specifies service of a conditional text field.
  29     @see com::sun::star::text::TextField
  30 */
  31 published service ConditionalText
  32 {
  33     service  com::sun::star::text::TextField;
  34
  35     /** contains the text that is displayed if the condition evaluates to `TRUE`.
  36      */
  37     [property] string TrueContent;
  38     /** contains the text that is displayed if the condition evaluates to `FALSE`.
  39      */
  40     [property] string FalseContent;
  41     /** contains the condition.
  42      */
  43     [property] string Condition;
  44     /** contains the result of the last evaluation of the condition.
  45      <p>This property has to be read/written in file export/import to save and
  46      restore the result without initiation of a new evaluation.</p>
  47      */
  48     [property] boolean IsConditionTrue;
  49     /** contains the current content of the text field.
  50                 <p> This property is especially useful for import/export purposes. </p>
  51          */
  52     [optional, property]string CurrentPresentation;
  53 };
  54
  55
  56 }; }; }; }; };
  57
  58 #endif
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */