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

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