1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_form_control_CommandButton_idl__
25#define __com_sun_star_form_control_CommandButton_idl__
26
27#ifndef __com_sun_star_awt_UnoControlButton_idl__
28#include <com/sun/star/awt/UnoControlButton.idl>
29#endif
30
31#ifndef __com_sun_star_form_XApproveActionBroadcaster_idl__
32#include <com/sun/star/form/XApproveActionBroadcaster.idl>
33#endif
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module form {  module control {
38
39//=============================================================================
40
41/** describes a button control.
42
43	<p>The model of the control has to support the <type scope="com::sun::star::form::component">CommandButton</type>
44	service.</p>
45
46	<p>The control is clickable, the action taken upon clicking depends on the settings
47	of the model the control belongs to.</p>
48
49	@see com::sun::star::awt::UnoControl
50	@see com::sun::star::awt::UnoControlModel
51	@see com::sun::star::form::component::CommandButton::ButtonType
52*/
53published service CommandButton
54{
55	service com::sun::star::awt::UnoControlButton;
56
57	/** allows external instances to register as veto listener for the button's actions.
58
59		<p>An <type scope="com::sun::star::form">XApproveActionListener</type> returning false on
60		it's approve-method will prevent any action which would usually be triggered - this includes
61		not only submitting or resetting forms, but also calling the
62		<type scope="com::sun::star::awt">XActionListener</type>s of the super service<br/>
63		This may be interesting for e.g. forms which want to provide input validation before submitting
64		data.<br/>
65
66		@see com::sun::star::form::component::HTMLForm
67		@see com::sun::star::form::XSubmit
68		@see com::sun::star::form::XReset
69		@see com::sun::star::awt::XButton
70	*/
71	interface com::sun::star::form::XApproveActionBroadcaster;
72};
73
74//=============================================================================
75
76}; }; }; }; };
77
78/*=============================================================================
79
80=============================================================================*/
81
82#endif
83
84
85