offapi/com/sun/star/form/component/HiddenControl.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: HiddenControl.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 #ifndef __com_sun_star_form_component_HiddenControl_idl__
  31 #define __com_sun_star_form_component_HiddenControl_idl__
  32
  33 #ifndef __com_sun_star_form_FormComponent_idl__
  34 #include <com/sun/star/form/FormComponent.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module form {  module component {
  41
  42 //=============================================================================
  43
  44 /** This service specifies the model of a hidden control.
  45
  46     <p>The only sense of a hidden control is to store data in the form which is
  47     not visible to the user.</p>
  48
  49     <p>Usually, hidden controls are used in <type scope="com::sun::star::form::component">HTMLForm</type>s,
  50     where they contain data which is to be submitted.<br/>
  51     Nevertheless, you can use them in your own forms for storing any data, for instance
  52     to evaluate it in some scripting macro.</p>
  53  */
  54 published service HiddenControl
  55 {
  56     service com::sun::star::form::FormComponent;
  57
  58     /** specifies the value of the component.
  59      */
  60     [property] string HiddenValue;
  61
  62 };
  63
  64 //=============================================================================
  65
  66 }; }; }; }; };
  67
  68 #endif