1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_XDialogEventHandler_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_awt_XDialogEventHandler_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_XDialog_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/XDialog.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 34*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/WrappedTargetException.idl> 35*b1cdbd2cSJim Jagielski#endif 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski//============================================================================= 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module awt { 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski//============================================================================= 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski/** Handles events fired by dialogs represented by a 45*b1cdbd2cSJim Jagielski <type scope="com::sun::star::awt">XDialog</type> interface. 46*b1cdbd2cSJim Jagielski */ 47*b1cdbd2cSJim Jagielskipublished interface XDialogEventHandler : ::com::sun::star::uno::XInterface { 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski /** Handles an event generated by a dialog. 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski The implementation must be aware that the EventObject argument contains types 54*b1cdbd2cSJim Jagielski which it is not prepared to handle. Similarly this applies for the MethodName 55*b1cdbd2cSJim Jagielski argument. In this case the method should simply return false. 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski @param xDialog 58*b1cdbd2cSJim Jagielski the dialog instance that generated the event. This is the same dialog instance 59*b1cdbd2cSJim Jagielski that was returned by the <type scope="com::sun::star::awt">XDialogProvider2</type> 60*b1cdbd2cSJim Jagielski createDialogWithHandler method when passing the XDialogEventHandler instance 61*b1cdbd2cSJim Jagielski receiving the event as handler parameter. 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski @param EventObject 64*b1cdbd2cSJim Jagielski an object describing the event which occurred in the dialog or anything else that 65*b1cdbd2cSJim Jagielski provides additional information for the event. 66*b1cdbd2cSJim Jagielski If the event was caused by the dialog or any of the controls which it contains 67*b1cdbd2cSJim Jagielski then the any should contain an object derived from 68*b1cdbd2cSJim Jagielski <type scope="com::sun::star::lang">EventObject</type>. Typically this would be one 69*b1cdbd2cSJim Jagielski of the several com::sun::star::awt::*Event types. 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski @param MethodName 72*b1cdbd2cSJim Jagielski the name of the function which is to be called. 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski @returns 75*b1cdbd2cSJim Jagielski true if the event was handled, otherwise false. 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski @throws com::sun::star::lang::WrappedTargetException 78*b1cdbd2cSJim Jagielski if the implementation of the method, which is determined by the argument MethodName, 79*b1cdbd2cSJim Jagielski throws an exception. This exception is then wrapped into a 80*b1cdbd2cSJim Jagielski <type scope="com::sun::star::lang">WrappedTargetException</type>. 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski boolean callHandlerMethod( 84*b1cdbd2cSJim Jagielski [in] com::sun::star::awt::XDialog xDialog, 85*b1cdbd2cSJim Jagielski [in] any EventObject, 86*b1cdbd2cSJim Jagielski [in] string MethodName) 87*b1cdbd2cSJim Jagielski raises(com::sun::star::lang::WrappedTargetException); 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** returns a sequence of supported method names 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @returns 93*b1cdbd2cSJim Jagielski all method names that will be accepted in calls to callHandlerMethod. 94*b1cdbd2cSJim Jagielski */ 95*b1cdbd2cSJim Jagielski sequence<string> getSupportedMethodNames(); 96*b1cdbd2cSJim Jagielski}; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski//============================================================================= 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski}; }; }; }; 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski#endif 103