xref: /AOO41X/main/offapi/com/sun/star/form/XUpdateBroadcaster.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_XUpdateBroadcaster_idl__
24#define __com_sun_star_form_XUpdateBroadcaster_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_form_XUpdateListener_idl__
31#include <com/sun/star/form/XUpdateListener.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module form {
38
39//=============================================================================
40
41/** is the broadcaster interface for sending "approveUpdate" and "updated" events.
42
43    <p>The component supporting this interface must do approval calls
44    (<member>XUpdateListener::approveUpdate</member>) immediately
45    before the data is updated, and notification calls
46    (<member>XUpdateListener::updated</member>) immediately afterwards.</p>
47
48    @see XUpdateListener
49 */
50published interface XUpdateBroadcaster: com::sun::star::uno::XInterface
51{
52    //-------------------------------------------------------------------------
53
54    /** adds the specified listener to receive the events "approveUpdate"
55        and "updated".
56        @param aListener
57            the listener to add.
58        @see com::sun::star::form::XUpdateListener
59     */
60    [oneway] void addUpdateListener( [in] com::sun::star::form::XUpdateListener aListener );
61
62    //-------------------------------------------------------------------------
63
64    /** removes the specified listener.
65        @param aListener
66            the listener to remove.
67        @see com::sun::star::form::XUpdateListener
68     */
69    [oneway] void removeUpdateListener( [in] com::sun::star::form::XUpdateListener aListener );
70
71};
72
73//=============================================================================
74
75}; }; }; };
76
77/*=============================================================================
78
79=============================================================================*/
80#endif
81