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 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_form_component_HiddenControl_idl__
  28 #define __com_sun_star_form_component_HiddenControl_idl__
  29
  30 #ifndef __com_sun_star_form_FormComponent_idl__
  31 #include <com/sun/star/form/FormComponent.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module form {  module component {
  38
  39 //=============================================================================
  40
  41 /** This service specifies the model of a hidden control.
  42
  43     <p>The only sense of a hidden control is to store data in the form which is
  44     not visible to the user.</p>
  45
  46     <p>Usually, hidden controls are used in <type scope="com::sun::star::form::component">HTMLForm</type>s,
  47     where they contain data which is to be submitted.<br/>
  48     Nevertheless, you can use them in your own forms for storing any data, for instance
  49     to evaluate it in some scripting macro.</p>
  50  */
  51 published service HiddenControl
  52 {
  53     service com::sun::star::form::FormComponent;
  54
  55     /** specifies the value of the component.
  56      */
  57     [property] string HiddenValue;
  58
  59 };
  60
  61 //=============================================================================
  62
  63 }; }; }; }; };
  64
  65 #endif