diff options
| author | Juergen Funk <juergen.funk_ml@cib.de> | 2016-07-21 11:00:22 +0200 |
|---|---|---|
| committer | Thorsten Behrens <Thorsten.Behrens@CIB.de> | 2016-07-22 13:29:56 +0000 |
| commit | 4da8378302093dd3e3dc3e201ac5e188c55f8009 (patch) | |
| tree | 21ddaeb2071f71c6ab7c48ea10634e175a450451 /offapi/com/sun/star | |
| parent | a911b96bb10b41a7f97ad40c423d84388d6b7d96 (diff) | |
offapi: document SynchronMode argument
Change-Id: Ie47a7f4afbfab40f172705323520d75ef4927b0a
Reviewed-on: https://gerrit.libreoffice.org/27364
Reviewed-by: Thorsten Behrens <Thorsten.Behrens@CIB.de>
Tested-by: Thorsten Behrens <Thorsten.Behrens@CIB.de>
Diffstat (limited to 'offapi/com/sun/star')
| -rw-r--r-- | offapi/com/sun/star/frame/XDispatch.idl | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/offapi/com/sun/star/frame/XDispatch.idl b/offapi/com/sun/star/frame/XDispatch.idl index 6b4ca0a4993e..c717565f3d17 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, |