summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/component/HiddenControl.idl
blob: 1951cc1fe68816310efdf4d188ce3c3ccefff60b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: HiddenControl.idl,v $
 * $Revision: 1.10 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_form_component_HiddenControl_idl__
#define __com_sun_star_form_component_HiddenControl_idl__

#ifndef __com_sun_star_form_FormComponent_idl__
#include <com/sun/star/form/FormComponent.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module form {  module component {

//=============================================================================

/** This service specifies the model of a hidden control.

    <p>The only sense of a hidden control is to store data in the form which is
    not visible to the user.</p>

    <p>Usually, hidden controls are used in <type scope="com::sun::star::form::component">HTMLForm</type>s,
    where they contain data which is to be submitted.<br/>
    Nevertheless, you can use them in your own forms for storing any data, for instance
    to evaluate it in some scripting macro.</p>
 */
published service HiddenControl
{
    service com::sun::star::form::FormComponent;

    /** specifies the value of the component.
     */
    [property] string HiddenValue;

};

//=============================================================================

}; }; }; }; };

#endif