offapi/com/sun/star/awt/XDisplayConnection.idl

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