1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_awt_XUserInputInterception_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_awt_XUserInputInterception_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir#ifndef __com_sun_star_awt_XKeyHandler_idl__ 36*cdf0e10cSrcweir#include <com/sun/star/awt/XKeyHandler.idl> 37*cdf0e10cSrcweir#endif 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir#ifndef __com_sun_star_awt_XMouseClickHandler_idl__ 40*cdf0e10cSrcweir#include <com/sun/star/awt/XMouseClickHandler.idl> 41*cdf0e10cSrcweir#endif 42*cdf0e10cSrcweir 43*cdf0e10cSrcweirmodule com { module sun { module star { module awt { 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir/** Interface to add handlers for key and mouse events. A handler is not a passive 46*cdf0e10cSrcweir listener, it can even consume the event. 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir @since OOo 1.1.2 49*cdf0e10cSrcweir */ 50*cdf0e10cSrcweirpublished interface XUserInputInterception : ::com::sun::star::uno::XInterface 51*cdf0e10cSrcweir{ 52*cdf0e10cSrcweir /** Add a new listener that is called on <type 53*cdf0e10cSrcweir scope="::com::sun::star::awt">KeyEvent</type>s. Every listener is 54*cdf0e10cSrcweir given the opportunity to consume the event, i.e. prevent the not yet 55*cdf0e10cSrcweir called listeners from being called. 56*cdf0e10cSrcweir @param xHandler 57*cdf0e10cSrcweir If this is a valid reference it is inserted into the list of 58*cdf0e10cSrcweir handlers. It is the task of the caller to not register the 59*cdf0e10cSrcweir same handler twice (otherwise that listener will be called 60*cdf0e10cSrcweir twice.) 61*cdf0e10cSrcweir */ 62*cdf0e10cSrcweir [oneway] void addKeyHandler ( 63*cdf0e10cSrcweir [in] ::com::sun::star::awt::XKeyHandler xHandler); 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir /** Remove the specified listener from the list of listeners. 67*cdf0e10cSrcweir @param xHandler 68*cdf0e10cSrcweir If the reference is empty then nothing will be changed. If the 69*cdf0e10cSrcweir handler has been registered twice (or more) then all refrences 70*cdf0e10cSrcweir will be removed. 71*cdf0e10cSrcweir */ 72*cdf0e10cSrcweir [oneway] void removeKeyHandler ( 73*cdf0e10cSrcweir [in] ::com::sun::star::awt::XKeyHandler xHandler); 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir /** Add a new listener that is called on <type 76*cdf0e10cSrcweir scope="::com::sun::star::awt">MouseEvent</type>s. Every listener is 77*cdf0e10cSrcweir given the opportunity to consume the event, i.e. prevent the not yet 78*cdf0e10cSrcweir called listeners from being called. 79*cdf0e10cSrcweir @param xHandler 80*cdf0e10cSrcweir If this is a valid reference it is inserted into the list of 81*cdf0e10cSrcweir handlers. It is the task of the caller to not register the 82*cdf0e10cSrcweir same handler twice (otherwise that listener will be called 83*cdf0e10cSrcweir twice.) 84*cdf0e10cSrcweir */ 85*cdf0e10cSrcweir [oneway] void addMouseClickHandler ( 86*cdf0e10cSrcweir [in] ::com::sun::star::awt::XMouseClickHandler xHandler); 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir /** Remove the specified listener from the list of listeners. 89*cdf0e10cSrcweir @param xHandler 90*cdf0e10cSrcweir If the reference is empty then nothing will be changed. If the 91*cdf0e10cSrcweir handler has been registered twice (or more) then all refrences 92*cdf0e10cSrcweir will be removed. 93*cdf0e10cSrcweir */ 94*cdf0e10cSrcweir [oneway] void removeMouseClickHandler ( 95*cdf0e10cSrcweir [in] ::com::sun::star::awt::XMouseClickHandler xHandler); 96*cdf0e10cSrcweir}; 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir}; }; }; }; 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir#endif 101