xref: /AOO41X/main/offapi/com/sun/star/form/XApproveActionListener.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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#ifndef __com_sun_star_form_XApproveActionListener_idl__
24#define __com_sun_star_form_XApproveActionListener_idl__
25
26#ifndef __com_sun_star_lang_XEventListener_idl__
27#include <com/sun/star/lang/XEventListener.idl>
28#endif
29
30#ifndef __com_sun_star_lang_EventObject_idl__
31#include <com/sun/star/lang/EventObject.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module form {
38
39//=============================================================================
40
41/** can be implemented to listen and probably veto actions to be performed on components.
42
43    <p>An example for an action would be the click of a
44        CommandButton.</p>
45
46    @see XApproveActionBroadcaster
47    @see com::sun::star::form::component::CommandButton
48    @see com::sun::star::form::control::CommandButton
49 */
50published interface XApproveActionListener: com::sun::star::lang::XEventListener
51{
52    //-------------------------------------------------------------------------
53
54    /** is invoked when an action is performed.
55
56        @param aEvent
57            A descriptor specifying the source of the event.
58
59        @returns
60            <TRUE/> when the action is permitted, otherwise <FALSE/>.
61     */
62    boolean approveAction( [in] com::sun::star::lang::EventObject aEvent );
63
64};
65
66//=============================================================================
67
68}; }; }; };
69
70/*=============================================================================
71
72=============================================================================*/
73#endif
74