xref: /AOO41X/main/offapi/com/sun/star/util/XModeChangeBroadcaster.idl (revision 34c958ab2597dc3f66146be0dc1758f0ba5d93f5)
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_util_XModeChangeBroadcaster_idl__
25#define __com_sun_star_util_XModeChangeBroadcaster_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_lang_NoSupportException_idl__
32#include <com/sun/star/lang/NoSupportException.idl>
33#endif
34
35#ifndef __com_sun_star_util_XModeChangeListener_idl__
36#include <com/sun/star/util/XModeChangeListener.idl>
37#endif
38
39#ifndef __com_sun_star_util_XModeChangeApproveListener_idl__
40#include <com/sun/star/util/XModeChangeApproveListener.idl>
41#endif
42
43//=============================================================================
44
45module com {  module sun {  module star {  module util {
46
47//=============================================================================
48
49/** broadcasts changes in an object's internal mode.
50
51    @see XModeSelector
52    @see XModeChangeListener
53    @see XModeChangeApproveListener
54
55    @since OpenOffice 1.1.2
56*/
57published interface XModeChangeBroadcaster : com::sun::star::uno::XInterface
58{
59    /** adds the given listener to the list of components to be notified when the mode
60        changes.
61    */
62    void addModeChangeListener( [in] XModeChangeListener _rxListener );
63
64    /** removes the given listener from the list of components to be notified when the mode
65        changes.
66    */
67    void removeModeChangeListener( [in] XModeChangeListener _rxListener );
68
69    /** adds the given listener to the list of components to be notified when the mode
70        is about to change.
71
72        @throws com::sun::star::lang::NoSupportException
73            if the component does not allow vetoing mode changes
74    */
75    void addModeChangeApproveListener( [in] XModeChangeApproveListener _rxListener )
76        raises( com::sun::star::lang::NoSupportException );
77
78    /** remove the given listener from the list of components to be notified when the mode
79        is about to change.
80
81        @throws com::sun::star::lang::NoSupportException
82            if the component does not allow vetoing mode changes
83    */
84    void removeModeChangeApproveListener( [in] XModeChangeApproveListener _rxListener )
85        raises( com::sun::star::lang::NoSupportException );
86};
87
88//=============================================================================
89
90}; }; }; };
91
92#endif
93
94