offapi/com/sun/star/awt/XDialogEventHandler.idl

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