summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/script/XEventAttacher.idl
blob: dd4289cf52173f2ac90d060af9115e9da26ee2fc (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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
/*************************************************************************
 *
 *  $RCSfile: XEventAttacher.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: mi $ $Date: 2001-11-16 15:09:06 $
 *
 *  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_script_XEventAttacher_idl__
#define __com_sun_star_script_XEventAttacher_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

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

#ifndef __com_sun_star_script_XAllListener_idl__
#include <com/sun/star/script/XAllListener.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_beans_IntrospectionException_idl__
#include <com/sun/star/beans/IntrospectionException.idl>
#endif

#ifndef __com_sun_star_script_CannotCreateAdapterException_idl__
#include <com/sun/star/script/CannotCreateAdapterException.idl>
#endif

#ifndef __com_sun_star_lang_ServiceNotRegisteredException_idl__
#include <com/sun/star/lang/ServiceNotRegisteredException.idl>
#endif


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

 module com {  module sun {  module star {  module script {

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

// DocMerge from xml: interface com::sun::star::script::XEventAttacher
/** makes it possible to attach script events given by a sequence of
    <type>ScriptEventDescriptor</type> structures to a given interface.
 */
interface XEventAttacher: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::script::XEventAttacher::attachListener
    /** registers the given "AllListener" object as a listener at the
        given interface by creating a suitable listener adapter and
        calling the "addListener" method corresponding to the
        "ListenerType".
     */
    com::sun::star::lang::XEventListener attachListener( [in] com::sun::star::uno::XInterface xTarget,
             [in] com::sun::star::script::XAllListener xAllListener,
             [in] any aHelper,
             [in] string aListenerType,
             [in] string aAddListenerParam )
            raises( com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::beans::IntrospectionException,
                    com::sun::star::script::CannotCreateAdapterException,
                    com::sun::star::lang::ServiceNotRegisteredException );

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

    // DocMerge from xml: method com::sun::star::script::XEventAttacher::attachSingleEventListener
    /** registers an object as a listener at the given interface by
        creating a suitable listener adapter and calling the method

<!-- jrh: Why all the empty space?  -->



        which corresponds to the
        listener type.



        <p>Only the event corresponding to the given event method
        will be delegated to <var>xAllListener</var>.

        </p>
     */
    com::sun::star::lang::XEventListener attachSingleEventListener( [in] com::sun::star::uno::XInterface xTarget,
             [in] com::sun::star::script::XAllListener xAllListener,
             [in] any aHelper,
             [in] string aListenerType,
             [in] string aAddListenerParam,
             [in] string aEventMethod )
            raises( com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::beans::IntrospectionException,
                    com::sun::star::script::CannotCreateAdapterException,
                    com::sun::star::lang::ServiceNotRegisteredException );

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

    // DocMerge from xml: method com::sun::star::script::XEventAttacher::removeListener
    /** removes a listener object as a listener from the given interface.



        <p> This method can and should be used as a contrary method
        to the two attach methods.

        </p>
     */
    void removeListener( [in] com::sun::star::uno::XInterface xTarget,
             [in] string aListenerType,
             [in] string aRemoveListenerParam,
             [in] com::sun::star::lang::XEventListener xToRemoveListener )
            raises( com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::beans::IntrospectionException );

};

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

}; }; }; };

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

    $Log: not supported by cvs2svn $
    Revision 1.5  2001/03/16 15:10:40  jsc
    remove interfaceheader with uik and remove [const] in method definitions

    Revision 1.4  2000/11/08 12:28:52  mi
    moved from api

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

    Revision 1.4  2000/09/11 11:52:38  mi
    documentation merged from XML

    Revision 1.2  2000/02/23 11:41:17  mi
    results from proofreading in layouted version

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


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