offapi/com/sun/star/awt/XUserInputInterception.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_XUserInputInterception_idl__
  21 #define __com_sun_star_awt_XUserInputInterception_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/awt/XKeyHandler.idl>
  25 #include <com/sun/star/awt/XMouseClickHandler.idl>
  26
  27 module com {  module sun {  module star {  module awt {
  28
  29 /** Interface to add handlers for key and mouse events. A handler is not a passive
  30    listener, it can even consume the event.
  31
  32     @since OOo 1.1.2
  33  */
  34 published interface XUserInputInterception : ::com::sun::star::uno::XInterface
  35 {
  36     /** Add a new listener that is called on ::com::sun::star::awt::KeyEvent.
  37         Every listener is
  38         given the opportunity to consume the event, i.e. prevent the not yet
  39         called listeners from being called.
  40         @param xHandler
  41             If this is a valid reference it is inserted into the list of
  42             handlers.  It is the task of the caller to not register the
  43             same handler twice (otherwise that listener will be called
  44             twice.)
  45     */
  46     void addKeyHandler (
  47         [in] ::com::sun::star::awt::XKeyHandler xHandler);
  48
  49
  50     /** Remove the specified listener from the list of listeners.
  51         @param xHandler
  52             If the reference is empty then nothing will be changed.  If the
  53             handler has been registered twice (or more) then all references
  54             will be removed.
  55     */
  56     void removeKeyHandler (
  57         [in] ::com::sun::star::awt::XKeyHandler xHandler);
  58
  59     /** Add a new listener that is called on ::com::sun::star::awt::MouseEvent.
  60         Every listener is
  61         given the opportunity to consume the event, i.e. prevent the not yet
  62         called listeners from being called.
  63         @param xHandler
  64             If this is a valid reference it is inserted into the list of
  65             handlers.  It is the task of the caller to not register the
  66             same handler twice (otherwise that listener will be called
  67             twice.)
  68     */
  69     void addMouseClickHandler (
  70         [in] ::com::sun::star::awt::XMouseClickHandler xHandler);
  71
  72     /** Remove the specified listener from the list of listeners.
  73         @param xHandler
  74             If the reference is empty then nothing will be changed.  If the
  75             handler has been registered twice (or more) then all references
  76             will be removed.
  77     */
  78     void removeMouseClickHandler (
  79         [in] ::com::sun::star::awt::XMouseClickHandler xHandler);
  80 };
  81
  82 }; }; }; };
  83
  84 #endif
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */