1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_awt_XDisplayConnection_idl__
29#define __com_sun_star_awt_XDisplayConnection_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35//=============================================================================
36
37module com { module sun { module star { module awt {
38
39 published interface XEventHandler;
40
41//=============================================================================
42
43/** This interface should be implemented by toolkits that want to give access
44	to their internal message handling loop.
45*/
46published interface XDisplayConnection: com::sun::star::uno::XInterface
47{
48    //-------------------------------------------------------------------------
49
50	/** registers an event handler.
51
52		@param window
53		the platform specific window id. If empty, the handler should be
54		registered for all windows.
55
56		@param eventHandler
57		the handler to register.
58
59		@param eventMask
60		the event mask specifies the events the handler is interested in.
61	*/
62	[oneway] void addEventHandler( [in] any window, [in] XEventHandler eventHandler, [in] long eventMask );
63
64	//-------------------------------------------------------------------------
65
66	/** removes a eventHandler from the handler list.
67
68		@param window
69		the platform specific window id the handler should be deregistered for.
70		If empty, the handler should be deregistered completly.
71
72		@param eventHandler
73		the handler to remove.
74	*/
75	[oneway] void removeEventHandler( [in] any window, [in] XEventHandler eventHandler );
76
77    //-------------------------------------------------------------------------
78
79	/** register an error handler for toolkit specific errors.
80
81		@param errorHandler
82		the handler to register.
83	*/
84	[oneway] void addErrorHandler( [in] XEventHandler errorHandler );
85
86	//-------------------------------------------------------------------------
87
88	/** remover an error handler from the handler list.
89
90		@param errorHandler
91		the handler to remove.
92	*/
93	[oneway] void removeErrorHandler( [in] XEventHandler errorhandler );
94
95	//-------------------------------------------------------------------------
96
97	/** returns a identifier.
98
99        @returns a unique platform dependend identifier for a display connection.
100	*/
101	any getIdentifier();
102
103};
104
105//=============================================================================
106
107}; }; }; };
108
109#endif
110