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
113
114
115
116
117
118
119
|
/*************************************************************************
*
* 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: CommandButton.idl,v $
* $Revision: 1.11 $
*
* 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_CommandButton_idl__
#define __com_sun_star_form_component_CommandButton_idl__
#include <com/sun/star/form/FormControlModel.idl>
#include <com/sun/star/awt/UnoControlButtonModel.idl>
#include <com/sun/star/form/XImageProducerSupplier.idl>
#include <com/sun/star/form/XApproveActionBroadcaster.idl>
#include <com/sun/star/form/FormButtonType.idl>
#include <com/sun/star/form/XReset.idl>
//=============================================================================
module com { module sun { module star { module form { module component {
//=============================================================================
/** specifies the control model for a clickable button which is part of a form
component hierarchy.
@see ImageButton
*/
published service CommandButton
{
service com::sun::star::awt::UnoControlButtonModel;
service com::sun::star::form::FormControlModel;
/** supplies the image producer when the button is to display an image.
<p>If the <member scope="com::sun::star::awt">UnoControlButtonModel::ImageURL</member> points to the location of an
image to be displayed on the button, this interface can be used to retrieve an image
producer, which itself will supply the image.</p>
<p>Usually, a control belonging to the model will use this interface to obtain the
image to be painted</p>
*/
interface com::sun::star::form::XImageProducerSupplier;
//-------------------------------------------------------------------------
/** describes the action to be executed by the button when pressed.
*/
[property] com::sun::star::form::FormButtonType ButtonType;
/** describes the frame, where to open the document specified by the TargetURL.
<p>This property is evaluated if the button is of type URL.</p>
<p>As always, there is a number of target names which have a special meaning, and force
a special <type scope="com::sun::star::frame">Frame</type> to be used.</p>
*/
[property] string TargetFrame;
/** specifies the URL, which should be opened if the button was clicked.
<p>This property is evaluated if the button is of type URL.</p>
@see com::sun::star::form::FormButtonType
*/
[property] string TargetURL;
/** specifies the default toggle state for the button, used when it is reset.
<p>This property is meaningful only when <member scope="com::sun::star::awt">UnoControlButtonModel::Toggle</member>
is <TRUE/>. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will
be reset.</p>
<p>For a given implementation of the interface, if this (optional) property is present, then also the optional
interface <type scope="com::sun::star::form">XReset</type> must be present.</p>
*/
[optional, property] boolean DefaultState;
/** allows resetting the button
<p>This property is meaningful only when <member scope="com::sun::star::awt">UnoControlButtonModel::Toggle</member>
is <TRUE/>. In this case, the <code>DefaultState</code> controls to which <code>State</code> the button will
be reset, when <member scope="com::sun::star::form">XReset::reset</member> is invoked.</p>
<p>For a given implementation of the interface, if this (optional) interface is present, then also the optional
property <member>DefaultState</member> must be present.</p>
*/
[optional] interface ::com::sun::star::form::XReset;
};
//=============================================================================
}; }; }; }; };
#endif
|
