offapi/com/sun/star/awt/XEventHandler.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_XEventHandler_idl__
  30 #define __com_sun_star_awt_XEventHandler_idl__
  31
  32 #include <com/sun/star/uno/XInterface.idl>
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module awt {
  37
  38 //=============================================================================
  39
  40 /** This interface can be implemented by clients that need access to the
  41     toolkits window message loop.
  42 */
  43 published interface XEventHandler: com::sun::star::uno::XInterface
  44 {
  45
  46     //-------------------------------------------------------------------------
  47
  48     /** requests the implementor of this interface to handle a platform
  49         dependent event.
  50
  51         @returns <TRUE/> if the event was handled properly and no further
  52         handling should take place, <FALSE/> otherwise.
  53
  54         @param event
  55         the platform dependent event.
  56     */
  57     boolean handleEvent( [in] any event );
  58
  59 };
  60
  61 //=============================================================================
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */