xref: /AOO41X/main/offapi/com/sun/star/awt/XDisplayConnection.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
24#ifndef __com_sun_star_awt_XDisplayConnection_idl__
25#define __com_sun_star_awt_XDisplayConnection_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31//=============================================================================
32
33module com { module sun { module star { module awt {
34
35 published interface XEventHandler;
36
37//=============================================================================
38
39/** This interface should be implemented by toolkits that want to give access
40    to their internal message handling loop.
41*/
42published interface XDisplayConnection: com::sun::star::uno::XInterface
43{
44    //-------------------------------------------------------------------------
45
46    /** registers an event handler.
47
48        @param window
49        the platform specific window id. If empty, the handler should be
50        registered for all windows.
51
52        @param eventHandler
53        the handler to register.
54
55        @param eventMask
56        the event mask specifies the events the handler is interested in.
57    */
58    [oneway] void addEventHandler( [in] any window, [in] XEventHandler eventHandler, [in] long eventMask );
59
60    //-------------------------------------------------------------------------
61
62    /** removes a eventHandler from the handler list.
63
64        @param window
65        the platform specific window id the handler should be deregistered for.
66        If empty, the handler should be deregistered completly.
67
68        @param eventHandler
69        the handler to remove.
70    */
71    [oneway] void removeEventHandler( [in] any window, [in] XEventHandler eventHandler );
72
73    //-------------------------------------------------------------------------
74
75    /** register an error handler for toolkit specific errors.
76
77        @param errorHandler
78        the handler to register.
79    */
80    [oneway] void addErrorHandler( [in] XEventHandler errorHandler );
81
82    //-------------------------------------------------------------------------
83
84    /** remover an error handler from the handler list.
85
86        @param errorHandler
87        the handler to remove.
88    */
89    [oneway] void removeErrorHandler( [in] XEventHandler errorhandler );
90
91    //-------------------------------------------------------------------------
92
93    /** returns a identifier.
94
95        @returns a unique platform dependend identifier for a display connection.
96    */
97    any getIdentifier();
98
99};
100
101//=============================================================================
102
103}; }; }; };
104
105#endif
106