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