1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28#ifndef __com_sun_star_awt_XContainerWindowEventHandler_idl__ 29#define __com_sun_star_awt_XContainerWindowEventHandler_idl__ 30 31#ifndef __com_sun_star_uno_XInterface_idl__ 32#include <com/sun/star/uno/XInterface.idl> 33#endif 34#ifndef __com_sun_star_awt_XWindow_idl__ 35#include <com/sun/star/awt/XWindow.idl> 36#endif 37#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 38#include <com/sun/star/lang/WrappedTargetException.idl> 39#endif 40 41 42//============================================================================= 43 44module com { module sun { module star { module awt { 45 46//============================================================================= 47 48/** Handles events fired by windows represented by a 49 <type scope="com::sun::star::awt">XWindow</type> interface. 50 */ 51published interface XContainerWindowEventHandler : ::com::sun::star::uno::XInterface { 52 53 //------------------------------------------------------------------------- 54 55 /** Handles an event generated by a window. 56 57 The implementation must be aware that the EventObject argument contains types 58 which it is not prepared to handle. Similarly this applies for the MethodName 59 argument. In this case the method should simply return false. 60 61 @param xWindow 62 the window instance that generated the event. If used in the scope of 63 <type scope="com::sun::star::awt">XContainerWindowProvider</type> this 64 is the same window instance that was returned by the createContainerWindow 65 method when passing the XContainerWindowEventHandler instance receiving the 66 event as handler parameter. 67 68 @param EventObject 69 an object describing the event which occurred in the window or anything else that 70 provides additional information for the event. 71 If the event was caused by the window or any of the controls which it contains 72 then the any should contain an object derived from 73 <type scope="com::sun::star::lang">EventObject</type>. Typically this would be one 74 of the several com::sun::star::awt::*Event types. 75 76 @param MethodName 77 the name of the function which is to be called. 78 79 @returns 80 true if the event was handled, otherwise false. 81 82 @throws com::sun::star::lang::WrappedTargetException 83 if the implementation of the method, which is determined by the argument MethodName, 84 throws an exception. This exception is then wrapped into a 85 <type scope="com::sun::star::lang">WrappedTargetException</type>. 86 87 */ 88 boolean callHandlerMethod( 89 [in] com::sun::star::awt::XWindow xWindow, 90 [in] any EventObject, 91 [in] string MethodName) 92 raises(com::sun::star::lang::WrappedTargetException); 93 94 95 /** returns a sequence of supported method names 96 97 @returns 98 all method names that will be accepted in calls to callHandlerMethod. 99 */ 100 sequence<string> getSupportedMethodNames(); 101}; 102 103//============================================================================= 104 105}; }; }; }; 106 107#endif 108