summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/XLoadListener.idl
blob: e831f54c455378a3090741656a517ea78e335cfd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*************************************************************************
 *
 *  $RCSfile: XLoadListener.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: mi $ $Date: 2000-12-21 08:35:08 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_form_XLoadListener_idl__
#define __com_sun_star_form_XLoadListener_idl__

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif

#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module form {

//=============================================================================

// DocMerge from xml: interface com::sun::star::form::XLoadListener
/** receives "loaded" and
    "unloaded" events posted by a loadable object.



    <p>The interface is typically implemented by data-bound components,
    which want to listen to the data source that contains their database
    form.  </p>@see com::sun::star::form::component::XLoadable
 */
[ uik(E2281709-33D6-11D1-AABE00A0-249D5590), ident( "XLoadListener", 1.0 ) ]
interface XLoadListener: com::sun::star::lang::XEventListener
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::form::XLoadListener::loaded
    /** is invoked when the object has successfully connected to
        a datasource.@see XLoadable
     */
    [oneway] void loaded( [in] com::sun::star::lang::EventObject aEvent );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::form::XLoadListener::unloading
    /** is invoked when the object is about to be unloaded. Components may use
        this to stop any other event processing related to the event source before
        the object is unloaded.@see XLoadable
     */
    [oneway] void unloading( [in] com::sun::star::lang::EventObject aEvent );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::form::XLoadListener::unloaded
    /** is invoked after the object has disconnected from a datasource.@see XLoadable
     */
    [oneway] void unloaded( [in] com::sun::star::lang::EventObject aEvent );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::form::XLoadListener::reloading
    /** is invoked when the object is about to be reloaded. Components may use
        this to stop any other event processing related to the event source until
        they get the reloaded event.@see XLoadable
     */
    [oneway] void reloading( [in] com::sun::star::lang::EventObject aEvent );

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::form::XLoadListener::reloaded
    /** is invoked when the object has been reloaded.@see XLoadable
     */
    [oneway] void reloaded( [in] com::sun::star::lang::EventObject aEvent );
};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.3  2000/11/08 12:42:52  mi
    moved from api

    Revision 1.2  2000/10/09 14:24:55  mi
    #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)

    Revision 1.1.1.1  2000/09/18 23:35:17  hjs
    initial import

    Revision 1.5  2000/09/11 11:52:25  mi
    documentation merged from XML

    Revision 1.3  2000/01/06 19:10:15  dg
    #70278# unloading new

    Revision 1.2  1999/12/22 07:11:06  fs
    #70278# added reloading/reloaded

    Revision 1.1.1.1  1999/11/11 09:48:42  jsc
    new


=============================================================================*/
#endif