xref: /AOO41X/main/offapi/com/sun/star/form/XLoadListener.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_XLoadListener_idl__
24#define __com_sun_star_form_XLoadListener_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/** receives load-related events from a loadable object.
42
43    <p>The interface is typically implemented by data-bound components,
44    which want to listen to the data source that contains their database
45    form.</p>
46
47    @see com::sun::star::form::XLoadable
48    @see DataAwareControlModel
49 */
50published interface XLoadListener: com::sun::star::lang::XEventListener
51{
52    //-------------------------------------------------------------------------
53
54    /** is invoked when the object has successfully connected to a datasource.
55
56        @param aEvent
57            the event happend.
58     */
59    [oneway] void loaded( [in] com::sun::star::lang::EventObject aEvent );
60
61    //-------------------------------------------------------------------------
62
63    /** is invoked when the object is about to be unloaded.
64        <p>Components may use this to stop any other event processing related to
65        the event source before the object is unloaded.</p>
66
67        @param aEvent
68            the event happend.
69     */
70    [oneway] void unloading( [in] com::sun::star::lang::EventObject aEvent );
71
72    //-------------------------------------------------------------------------
73
74    /** is invoked after the object has disconnected from a datasource.
75
76        @param aEvent
77            the event happend.
78     */
79    [oneway] void unloaded( [in] com::sun::star::lang::EventObject aEvent );
80
81    //-------------------------------------------------------------------------
82
83    /** is invoked when the object is about to be reloaded.
84
85        <p>Components may use this to stop any other event processing related
86        to the event source until they get the reloaded event.</p>
87
88        @param aEvent
89            the event happend.
90     */
91    [oneway] void reloading( [in] com::sun::star::lang::EventObject aEvent );
92
93    //-------------------------------------------------------------------------
94
95    /** is invoked when the object has been reloaded.
96
97        @param aEvent
98            the event happend.
99     */
100    [oneway] void reloaded( [in] com::sun::star::lang::EventObject aEvent );
101};
102
103//=============================================================================
104
105}; }; }; };
106
107/*=============================================================================
108
109=============================================================================*/
110#endif
111