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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_RadioButton_idl__
#define __com_sun_star_form_component_RadioButton_idl__
#ifndef __com_sun_star_awt_UnoControlRadioButtonModel_idl__
#include <com/sun/star/awt/UnoControlRadioButtonModel.idl>
#endif
#ifndef __com_sun_star_form_FormControlModel_idl__
#include <com/sun/star/form/FormControlModel.idl>
#endif
#ifndef __com_sun_star_form_XReset_idl__
#include <com/sun/star/form/XReset.idl>
#endif
//=============================================================================
module com { module sun { module star { module form { module component {
//=============================================================================
/** specifies a component which acts as a radio button as needed in <type>HTMLForm</type>s.
<p>Radio buttons are controls which can be grouped together, and in every
group, only one of the controls can be check. This means if one of them
is checked by a user interaction, all other controls in the same group
are automatically unchecked</p>
<p>Like in HTML, radio buttons are grouped together if and only if they have the
same name (see <member scope="com::sun::star::form">FormComponent::Name</member>).</p>
*/
published service RadioButton
{
service com::sun::star::awt::UnoControlRadioButtonModel;
service com::sun::star::form::FormControlModel;
/** can be used to reset the control to it's default text.
@see RadioButton::DefaultState
*/
interface com::sun::star::form::XReset;
//-------------------------------------------------------------------------
/** contains a default value for the control.
<p>This value is used when the control is initially displayed, and for resetting it.</p>
<p> In a group of radio buttons only one button should be checked
by default.</p>
@see com::sun::star::awt::UnoControlRadioButtonModel::State
@see com::sun::star::form::XReset
*/
[property] short DefaultState;
//-------------------------------------------------------------------------
/** contains a reference value which is used for submission in a HTML
form.
<p>If the form the control belongs to is to be submitted (see
<type scope="com::sun::star::form">XSubmit</type>), and the control is checked, this reference
value is used for submission.</p>
*/
[property] string RefValue;
/** specifies a value which is to be associated with the control when it's <em>not</em>
selected.
<p>In various situations, the <member>RefValue</member> is associated with the control
if and only if it is selected.<br/>
<member>UncheckedRefValue</member> provides a extensions of this concept: If present,
the value should be associated with the control when it is <em>not</em> selected.</p>
*/
[optional, property] string UncheckedRefValue;
};
//=============================================================================
}; }; }; }; };
#endif
|
