INTEGRATION: CWS jl61 (1.2.168); FILE MERGED

2007/05/07 11:04:15 jl 1.2.168.2: #i75869# callHandlerMethod now throws a WrappedTargetException
2007/05/03 14:48:36 jl 1.2.168.1: #i75869# Updated documentation. The EventObject can now contain arbitrary event information.

1 files changed, 28 insertions, 10 deletions

diff --git a/offapi/com/sun/star/awt/XDialogEventHandler.idl b/offapi/com/sun/star/awt/XDialogEventHandler.idl
index 057910436384..def559d422d9 100644
--- a/offapi/com/sun/star/awt/XDialogEventHandler.idl
+++ b/offapi/com/sun/star/awt/XDialogEventHandler.idl
@@ -4,9 +4,9 @@
  *
  *  $RCSfile: XDialogEventHandler.idl,v $
  *
- *  $Revision: 1.2 $
+ *  $Revision: 1.3 $
  *
- *  last change: $Author: obo $ $Date: 2006-07-14 07:13:33 $
+ *  last change: $Author: kz $ $Date: 2007-06-20 10:32:15 $
  *
  *  The Contents of this file are made available subject to
  *  the terms of GNU Lesser General Public License Version 2.1.
@@ -42,6 +42,9 @@
 #ifndef __com_sun_star_awt_XDialog_idl__
 #include <com/sun/star/awt/XDialog.idl>
 #endif
+#ifndef __com_sun_star_lang_WrappedTargetException_idl__
+#include <com/sun/star/lang/WrappedTargetException.idl>
+#endif
 
 
 //=============================================================================
@@ -59,6 +62,10 @@ interface XDialogEventHandler : ::com::sun::star::uno::XInterface {
 
     /** Handles an event generated by a dialog.
 
+        The implementation must be aware that the EventObject argument contains types
+        which it is not prepared to handle. Similarly this applies for the MethodName
+        argument. In this case the method should simply return false.
+
         @param xDialog
             the dialog instance that generated the event. This is the same dialog instance
             that was returned by the <type scope="com::sun::star::awt">XDialogProvider2</type>
@@ -66,20 +73,31 @@ interface XDialogEventHandler : ::com::sun::star::uno::XInterface {
             receiving the event as handler parameter.
 
         @param EventObject
-            an object describing the event passed by the dialog respectively control firing
-            the event. The type of EventObject depends on the dialog or control event this
-            handler is bound to. This can be any com::sun::star::awt::*Event type.
-            In any case it is derived from <type scope="com::sun::star::lang">EventObject</type>.
+            an object describing the event which occurred in the dialog or anything else that
+            provides additional information for the event.
+            If the event was caused by the dialog or any of the controls which it contains
+            then the any should contain an object derived from
+            <type scope="com::sun::star::lang">EventObject</type>. Typically this would be one
+            of the several com::sun::star::awt::*Event types.
+
+        @param MethodName
+            the name of the function which is to be called.
 
         @returns
             true if the event was handled, otherwise false.
+
+        @throws com::sun::star::lang::WrappedTargetException
+            if the implementation of the method, which is determined by the argument MethodName,
+            throws an exception. This exception is then wrapped into a
+            <type scope="com::sun::star::lang">WrappedTargetException</type>.
+
      */
-    boolean callHandlerMethod
-    (
+    boolean callHandlerMethod(
         [in] com::sun::star::awt::XDialog xDialog,
         [in] any EventObject,
-        [in] string MethodName
-    );
+        [in] string MethodName)
+        raises(com::sun::star::lang::WrappedTargetException);
+
 
     /** returns a sequence of supported method names