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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_awt_XEventHandler_idl__
  21 #define __com_sun_star_awt_XEventHandler_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25
  26 module com { module sun { module star { module awt {
  27
  28
  29 /** This interface can be implemented by clients that need access to the
  30     toolkits window message loop.
  31 */
  32 published interface XEventHandler: com::sun::star::uno::XInterface
  33 {
  34
  35
  36     /** requests the implementor of this interface to handle a platform
  37         dependent event.
  38
  39         @returns `TRUE` if the event was handled properly and no further
  40         handling should take place, `FALSE` otherwise.
  41
  42         @param event
  43         the platform dependent event.
  44     */
  45     boolean handleEvent( [in] any event );
  46
  47 };
  48
  49
  50 }; }; }; };
  51
  52 #endif
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */