/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XDisplayConnection.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 21:39:31 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/

#ifndef __com_sun_star_awt_XDisplayConnection_idl__
#define __com_sun_star_awt_XDisplayConnection_idl__

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

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

module com { module sun { module star { module awt {

 published interface XEventHandler;

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

/** This interface should be implemented by toolkits that want to give access
    to their internal message handling loop.
*/
published interface XDisplayConnection: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** registers an event handler.

        @param window
        the platform specific window id. If empty, the handler should be
        registered for all windows.

        @param eventHandler
        the handler to register.

        @param eventMask
        the event mask specifies the events the handler is interested in.
    */
    [oneway] void addEventHandler( [in] any window, [in] XEventHandler eventHandler, [in] long eventMask );

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

    /** removes a eventHandler from the handler list.

        @param window
        the platform specific window id the handler should be deregistered for.
        If empty, the handler should be deregistered completly.

        @param eventHandler
        the handler to remove.
    */
    [oneway] void removeEventHandler( [in] any window, [in] XEventHandler eventHandler );

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

    /** register an error handler for toolkit specific errors.

        @param errorHandler
        the handler to register.
    */
    [oneway] void addErrorHandler( [in] XEventHandler errorHandler );

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

    /** remover an error handler from the handler list.

        @param errorHandler
        the handler to remove.
    */
    [oneway] void removeErrorHandler( [in] XEventHandler errorhandler );

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

    /** returns a identifier.

        @returns a unique platform dependend identifier for a display connection.
    */
    any getIdentifier();

};

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

}; }; }; };

#endif
