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