1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_awt_XUserInputInterception_idl__ 25cdf0e10cSrcweir#define __com_sun_star_awt_XUserInputInterception_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_awt_XKeyHandler_idl__ 32cdf0e10cSrcweir#include <com/sun/star/awt/XKeyHandler.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_awt_XMouseClickHandler_idl__ 36cdf0e10cSrcweir#include <com/sun/star/awt/XMouseClickHandler.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweirmodule com { module sun { module star { module awt { 40cdf0e10cSrcweir 41cdf0e10cSrcweir/** Interface to add handlers for key and mouse events. A handler is not a passive 42cdf0e10cSrcweir listener, it can even consume the event. 43cdf0e10cSrcweir 44*d1e7efc3SJürgen Schmidt @since OpenOffice 1.1.2 45cdf0e10cSrcweir */ 46cdf0e10cSrcweirpublished interface XUserInputInterception : ::com::sun::star::uno::XInterface 47cdf0e10cSrcweir{ 48cdf0e10cSrcweir /** Add a new listener that is called on <type 49cdf0e10cSrcweir scope="::com::sun::star::awt">KeyEvent</type>s. Every listener is 50cdf0e10cSrcweir given the opportunity to consume the event, i.e. prevent the not yet 51cdf0e10cSrcweir called listeners from being called. 52cdf0e10cSrcweir @param xHandler 53cdf0e10cSrcweir If this is a valid reference it is inserted into the list of 54cdf0e10cSrcweir handlers. It is the task of the caller to not register the 55cdf0e10cSrcweir same handler twice (otherwise that listener will be called 56cdf0e10cSrcweir twice.) 57cdf0e10cSrcweir */ 58cdf0e10cSrcweir [oneway] void addKeyHandler ( 59cdf0e10cSrcweir [in] ::com::sun::star::awt::XKeyHandler xHandler); 60cdf0e10cSrcweir 61cdf0e10cSrcweir 62cdf0e10cSrcweir /** Remove the specified listener from the list of listeners. 63cdf0e10cSrcweir @param xHandler 64cdf0e10cSrcweir If the reference is empty then nothing will be changed. If the 65cdf0e10cSrcweir handler has been registered twice (or more) then all refrences 66cdf0e10cSrcweir will be removed. 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir [oneway] void removeKeyHandler ( 69cdf0e10cSrcweir [in] ::com::sun::star::awt::XKeyHandler xHandler); 70cdf0e10cSrcweir 71cdf0e10cSrcweir /** Add a new listener that is called on <type 72cdf0e10cSrcweir scope="::com::sun::star::awt">MouseEvent</type>s. Every listener is 73cdf0e10cSrcweir given the opportunity to consume the event, i.e. prevent the not yet 74cdf0e10cSrcweir called listeners from being called. 75cdf0e10cSrcweir @param xHandler 76cdf0e10cSrcweir If this is a valid reference it is inserted into the list of 77cdf0e10cSrcweir handlers. It is the task of the caller to not register the 78cdf0e10cSrcweir same handler twice (otherwise that listener will be called 79cdf0e10cSrcweir twice.) 80cdf0e10cSrcweir */ 81cdf0e10cSrcweir [oneway] void addMouseClickHandler ( 82cdf0e10cSrcweir [in] ::com::sun::star::awt::XMouseClickHandler xHandler); 83cdf0e10cSrcweir 84cdf0e10cSrcweir /** Remove the specified listener from the list of listeners. 85cdf0e10cSrcweir @param xHandler 86cdf0e10cSrcweir If the reference is empty then nothing will be changed. If the 87cdf0e10cSrcweir handler has been registered twice (or more) then all refrences 88cdf0e10cSrcweir will be removed. 89cdf0e10cSrcweir */ 90cdf0e10cSrcweir [oneway] void removeMouseClickHandler ( 91cdf0e10cSrcweir [in] ::com::sun::star::awt::XMouseClickHandler xHandler); 92cdf0e10cSrcweir}; 93cdf0e10cSrcweir 94cdf0e10cSrcweir}; }; }; }; 95cdf0e10cSrcweir 96cdf0e10cSrcweir#endif 97