INTEGRATION: CWS fwk03 (1.2.20); FILE MERGED

2003/05/22 15:59:51 mba 1.2.20.2: #109650#: XUserInputInterception.idl
2003/05/16 08:38:21 mba 1.2.20.1: #109650#: documentation added

1 files changed, 22 insertions, 3 deletions

diff --git a/offapi/com/sun/star/awt/XUserInputInterception.idl b/offapi/com/sun/star/awt/XUserInputInterception.idl
index a9efdd316c04..11e40a126807 100644
--- a/offapi/com/sun/star/awt/XUserInputInterception.idl
+++ b/offapi/com/sun/star/awt/XUserInputInterception.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: XUserInputInterception.idl,v $
  *
- *  $Revision: 1.2 $
+ *  $Revision: 1.3 $
  *
- *  last change: $Author: vg $ $Date: 2003-04-24 17:42:27 $
+ *  last change: $Author: vg $ $Date: 2003-05-26 08:33:11 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -75,7 +75,9 @@
 #endif
 
 module com {  module sun {  module star {  module awt {
-
+/** Interface to add handlers for key and mouse events. A handler is not a passive
+   listener, it can even consume the event.
+ */
 interface XUserInputInterception : ::com::sun::star::uno::XInterface
 {
     /** Add a new listener that is called on <type
@@ -101,8 +103,25 @@ interface XUserInputInterception : ::com::sun::star::uno::XInterface
     [oneway] void removeKeyHandler (
         [in] ::com::sun::star::awt::XKeyHandler xHandler);
 
+    /** Add a new listener that is called on <type
+        scope="::com::sun::star::awt">MouseEvent</type>s.  Every listener is
+        given the opportunity to consume the event, i.e. prevent the not yet
+        called listeners from being called.
+        @param xHandler
+            If this is a valid reference it is inserted into the list of
+            handlers.  It is the task of the caller to not register the
+            same handler twice (otherwise that listener will be called
+            twice.)
+    */
     [oneway] void addMouseClickHandler (
         [in] ::com::sun::star::awt::XMouseClickHandler xHandler);
+
+    /** Remove the specified listener from the list of listeners.
+        @param xHandler
+            If the reference is empty then nothing will be changed.  If the
+            handler has been registered twice (or more) then all refrences
+            will be removed.
+    */
     [oneway] void removeMouseClickHandler (
         [in] ::com::sun::star::awt::XMouseClickHandler xHandler);
 };