[Libreoffice-commits] core.git: offapi/com

[Juergen Funk]

 offapi/com/sun/star/frame/XDispatch.idl |   17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

New commits:
commit 4da8378302093dd3e3dc3e201ac5e188c55f8009
Author: Juergen Funk <juergen.funk_ml at cib.de>
Date:   Thu Jul 21 11:00:22 2016 +0200

    offapi: document SynchronMode argument
    
    Change-Id: Ie47a7f4afbfab40f172705323520d75ef4927b0a
    Reviewed-on: https://gerrit.libreoffice.org/27364
    Reviewed-by: Thorsten Behrens <Thorsten.Behrens at CIB.de>
    Tested-by: Thorsten Behrens <Thorsten.Behrens at CIB.de>

diff --git a/offapi/com/sun/star/frame/XDispatch.idl b/offapi/com/sun/star/frame/XDispatch.idl
index 6b4ca0a..c717565 100644
--- a/offapi/com/sun/star/frame/XDispatch.idl
+++ b/offapi/com/sun/star/frame/XDispatch.idl
@@ -53,7 +53,7 @@ module com {  module sun {  module star {  module frame {
  */
 published interface XDispatch: com::sun::star::uno::XInterface
 {
-    /** dispatches (executes) an URL asynchronously.
+    /** dispatches (executes) an URL
 
         <p>
         It is only allowed to dispatch URLs for which this XDispatch
@@ -64,9 +64,22 @@ published interface XDispatch: com::sun::star::uno::XInterface
             fully parsed URL describing the feature which should be dispatched (=executed)
 
         @param Arguments
-            optional arguments for this request.
+            optional arguments for this request
+            (see com::sun::star::document::MediaDescriptor)
             They depend on the real implementation of the dispatch object.
 
+            Controlling synchronous or asynchronous mode happens via
+            readonly boolean Flag SynchronMode
+
+            <p>
+            By default, and absent any arguments, "SychronMode" is
+            considered `FALSE` and the execution is performed
+            asynchronously (i.e. dispatch() returns immediately, and
+            the action is performed in the background).  But when set
+            to `TRUE`, dispatch() processes the request synchronously
+            - this call will block until it has finished.
+            </p>
+
             <i>some code for a click-handler (Java)</i>
             @code{.java}
             void myOnClick(String sURL,String sTargetFrame,