offapi/com/sun/star/text/textfield/HiddenText.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: HiddenText.idl,v $
  10  * $Revision: 1.8 $
  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_HiddenText_idl__
  32 #define __com_sun_star_text_textfield_HiddenText_idl_
  33
  34 #include <com/sun/star/text/TextField.idl>
  35
  36 //=============================================================================
  37
  38 module com { module sun { module star { module text { module textfield {
  39
  40 //=============================================================================
  41 /**     specifies service of a hidden text field.
  42     @see com::sun::star::text::TextField
  43 */
  44 published service HiddenText
  45 {
  46     service  com::sun::star::text::TextField;
  47
  48     /** contains the text content of the hidden text field.
  49         <p> The content is displayed if the condition evaluates to <FALSE/>.</p>
  50      */
  51     [property] string Content;
  52     /** contains the condition.
  53      */
  54     [property] string Condition;
  55     /** contains the result of the last evaluation of the condition.
  56      <p>This property has to be read/written in file export/import to save and
  57      restore the result without initiation of a new evaluation.</p>
  58      */
  59     [property] boolean IsHidden;
  60 };
  61
  62 //=============================================================================
  63
  64 }; }; }; }; };
  65
  66 #endif
  67