summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/frame
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2013-04-30 00:15:22 +0200
committerMichael Stahl <mstahl@redhat.com>2013-06-04 12:01:06 +0200
commit73d568408a150875b5c6046680f38e6db287c8fa (patch)
tree3c6d87ae03cc8193ef1d418d7a1ff7272bbbae53 /offapi/com/sun/star/frame
parentb84bffc86a913383bb3fa7f9f3d963d32681f778 (diff)
*api: convert <listing> and @example
<listing> is called @code / @endcode in doxygen. @example requires a file name in doxygen. Also adapt various silly examples that use tools String in C++ or manual syntax highlighting in Java etc. Change-Id: I23cff1b688001f438526a6a1364cc5f754b504f7
Diffstat (limited to 'offapi/com/sun/star/frame')
-rw-r--r--offapi/com/sun/star/frame/XDispatch.idl32
-rw-r--r--offapi/com/sun/star/frame/XRecordableDispatch.idl20
2 files changed, 27 insertions, 25 deletions
diff --git a/offapi/com/sun/star/frame/XDispatch.idl b/offapi/com/sun/star/frame/XDispatch.idl
index 84a614c7804e..6b4ca0a4993e 100644
--- a/offapi/com/sun/star/frame/XDispatch.idl
+++ b/offapi/com/sun/star/frame/XDispatch.idl
@@ -67,27 +67,29 @@ published interface XDispatch: com::sun::star::uno::XInterface
optional arguments for this request.
They depend on the real implementation of the dispatch object.
- @example
- <listing>
- <i><font COLOR="#949494">// some code for a click-handler (Java)</font></i>
- void <strong>myOnClick</strong>(<em>String</em> sURL,<em>String</em> sTargetFrame,<em>com.sun.star.beans.PropertyValue[]</em> lArguments)
+ <i>some code for a click-handler (Java)</i>
+ @code{.java}
+ void myOnClick(String sURL,String sTargetFrame,
+ com.sun.star.beans.PropertyValue[] lArguments)
{
- &nbsp;&nbsp;com.sun.star.util.URL[] aURL = new com.sun.star.util.URL[1];
- &nbsp;&nbsp;aURL[0] = new com.sun.star.util.URL();
- &nbsp;&nbsp;aURL[0].Complete = sURL;
+ com.sun.star.util.URL[] aURL = new com.sun.star.util.URL[1];
+ aURL[0] = new com.sun.star.util.URL();
+ aURL[0].Complete = sURL;
- &nbsp;&nbsp;com.sun.star.util.XURLTransformer xParser = (com.sun.star.util.XURLTransformer)UnoRuntime.queryInterface(
- &nbsp;&nbsp;&nbsp;&nbsp;com.sun.star.util.XURLTransformer.class,
- &nbsp;&nbsp;&nbsp;&nbsp;mxServiceManager.createInstance("com.sun.star.util.URLTransformer"));
+ com.sun.star.util.XURLTransformer xParser =
+ (com.sun.star.util.XURLTransformer)UnoRuntime.queryInterface(
+ com.sun.star.util.XURLTransformer.class,
+ mxServiceManager.createInstance("com.sun.star.util.URLTransformer"));
- &nbsp;&nbsp;xParser.parseStrict(aURL);
+ xParser.parseStrict(aURL);
- &nbsp;&nbsp;com.sun.star.frame.XDispatch xDispatcher = mxFrame.queryDispatch(aURL[0], sTargetFrame, com.sun.star.frame.FrameSearchFlag.GLOBAL);
+ com.sun.star.frame.XDispatch xDispatcher =
+ mxFrame.queryDispatch(aURL[0], sTargetFrame, com.sun.star.frame.FrameSearchFlag.GLOBAL);
- &nbsp;&nbsp;if(xDispatcher!=null)
- &nbsp;&nbsp;&nbsp;&nbsp;xDispatcher.dispatch(aURL[0], lArguments);
+ if(xDispatcher!=null)
+ xDispatcher.dispatch(aURL[0], lArguments);
}
- </listing>
+ @endcode
*/
void dispatch(
[in] com::sun::star::util::URL URL,
diff --git a/offapi/com/sun/star/frame/XRecordableDispatch.idl b/offapi/com/sun/star/frame/XRecordableDispatch.idl
index 364f5836a954..211dacf63229 100644
--- a/offapi/com/sun/star/frame/XRecordableDispatch.idl
+++ b/offapi/com/sun/star/frame/XRecordableDispatch.idl
@@ -45,22 +45,22 @@
is used transparently there.
</p>
- @example
- <listing>
- <i>XDispatch</i> xDispatcher = xFrame.queryDispatch(aURL,"",0);
- <i>XRecordableDispatch</i> xRecordable = (<i>XRecordableDispatch</i>)UnoRuntime.queryInterface(
- &nbsp;&nbsp;XRecordableDispatch.class,
- &nbsp;&nbsp;xDispatcher);
+ @code{.java}
+ XDispatch xDispatcher = xFrame.queryDispatch(aURL,"",0);
+ XRecordableDispatch xRecordable =
+ (XRecordableDispatch)UnoRuntime.queryInterface(
+ XRecordableDispatch.class,
+ xDispatcher);
xDispatcher.addStatusListener(this,aURL);
- <b>if</b> (xRecordable!=<b>null</b>)
- &nbsp;&nbsp;xRecordable.dispatchAndRecord(aURL,lArguments,xRecorder);
+ if (xRecordable != null)
+ xRecordable.dispatchAndRecord(aURL,lArguments,xRecorder);
else
- &nbsp;&nbsp;xDispatcher.dispatch(aURL,lArguments);
+ xDispatcher.dispatch(aURL,lArguments);
...
xDispatcher.removeStatusListener(this,aURL);
- </listing>
+ @endcode
@see XDispatchRecorderSupplier
@see XDispatch