<html> <head> <title>Interface XDispatchRecorder</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XDispatchRecorder-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">frame</a> :: </p> </td> </tr> <tr> <td class="title">interface XDispatchRecorder</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides recording functionality of dispatches </dd> <dd><p> With such recorder it will be possible to record requests of type <a href="XDispatch.html">XDispatch</a> by using additional interface <a href="XRecordableDispatch.html">XRecordableDispatch</a>. The result of that will be a a script which can be used to start the dispatch at later time again. Such recorder objects are available on a <a href="XDispatchRecorderSupplier.html">XDispatchRecorderSupplier</a> which is provided by the <a href="Frame.html">Frame</a> service. </p> </dd> <dt><b/></dt> <dd/><dt><b>See also</b></dt> <dd><a href="Frame.html">Frame</a>, <a href="XDispatchRecorderSupplier.html">XDispatchRecorderSupplier</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#startRecording">startRecording</a></td> <td class="imsum_right">initializes the recorder by passing the frame for which all macro statements shall be recorded </td> </tr> <tr> <td class="imsum_left"><a href="#endRecording">endRecording</a></td> <td class="imsum_right">stops the recording process </td> </tr> <tr> <td class="imsum_left"><a href="#recordDispatch">recordDispatch</a></td> <td class="imsum_right">records a single dispatch call identified by its command URL </td> </tr> <tr> <td class="imsum_left"><a href="#recordDispatchAsComment">recordDispatchAsComment</a></td> <td class="imsum_right">records a single dispatch call identified by its command URL, but comments it out </td> </tr> <tr> <td class="imsum_left"><a href="#getRecordedMacro">getRecordedMacro</a></td> <td class="imsum_right">returns the recorded source code </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="startRecording" class="membertitle">startRecording</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>startRecording</b>(</td> <td valign="top">[in] <a href="XFrame.html">XFrame</a></td> <td valign="bottom"> Frame );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>initializes the recorder by passing the frame for which all macro statements shall be recorded </dd> <dt><b>Parameter Frame</b></dt> <dd>it includes the document on which such requests shall be recorded </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endRecording" class="membertitle">endRecording</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>endRecording</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>stops the recording process </dd> <dd><p> Must be called in pairs with <a href="XDispatchRecorder.html">XDispatchRecorder</a>::<a href="XDispatchRecorder.html#startRecording">startRecording()</a>. </p> @attention The recorder uses this method to control the lifetime of its internal used macro buffer. It will be cleared here. So the macro must be fetched before endRecording() is called. </dd> <dt><b>See also</b></dt> <dd><a href="#getRecordedMacro()">getRecordedMacro()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="recordDispatch" class="membertitle">recordDispatch</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>recordDispatch</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/URL.html">URL</a></td> <td valign="bottom"> URL,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Arguments );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>records a single dispatch call identified by its command URL </dd> <dt><b>Parameter URL</b></dt> <dd>the full parsed command URL </dd> <dt><b>Parameter Arguments</b></dt> <dd>optional arguments for the command URL <br> (see ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/MediaDescriptor.html">MediaDescriptor</a> for further informations) </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="recordDispatchAsComment" class="membertitle">recordDispatchAsComment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>recordDispatchAsComment</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/URL.html">URL</a></td> <td valign="bottom"> URL,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Arguments );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>records a single dispatch call identified by its command URL, but comments it out </dd> <dd><p> This way calls that failed on execution can be documented. </p> </dd> <dt><b>Parameter URL</b></dt> <dd>the full parsed command URL </dd> <dt><b>Parameter Arguments</b></dt> <dd>optional arguments for the command URL <br> (see ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/MediaDescriptor.html">MediaDescriptor</a> for further informations) </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRecordedMacro" class="membertitle">getRecordedMacro</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getRecordedMacro</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the recorded source code </dd> <dd><p> This method must be used before <a href="#endRecording()">endRecording()</a> is called! Otherwhise the macro will be relased. </p> </dd> <dt><b>Returns</b></dt> <dd>the recorded data as a string which can be interpreted as a script </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
3478
