Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: frame ::
interface XDispatchRecorderSupplier
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XDispatchRecorderSupplier
Description provides access to the record mechanism of dispatches With a XDispatchRecorder it's possible to record calls of XDispatch::dispatch() . The recorded data (may a script) can be used to automate recorded dispatch and start it at later time again. This supplier provides access to the recorder and supports some functionality to work with the mcaro recording mechanism in an easy manner. See also XDispatchRecorder Since version OpenOffice.org 1.1.1

Methods' Summary
setDispatchRecorder | set a dispatch recorder on this supplier
getDispatchRecorder | provides access on the recorder of this supplier
dispatchAndRecord | dispatch given URL and record it if recording is enabled

Methods' Details
setDispatchRecorder
void setDispatchRecorder( | [in] XDispatchRecorder | Recorder );
Description set a dispatch recorder on this supplier Setting of a new recorder make it possible to change recording mode. May there can exist different implementations of a recorder (e.g. to generate Java, Basic or other formats). Changing between local recording inside one Frame or global one by using more then ones can be forced too. Parameter Recorder the new recorder for this supplier
getDispatchRecorder
XDispatchRecorder getDispatchRecorder(); |  |
Description provides access on the recorder of this supplier Returned recorder can be used to record dispatches manualy or to get recorded data for further using e.g. saving. He is internaly used too due to the method XDispatchRecorderSupplier::dispatchAndRecord() . Returns the dispatch recorder of this supplier See also XDispatchRecorder
dispatchAndRecord
void dispatchAndRecord( | [in] ::com::sun::star::util::URL [in] sequence< ::com::sun::star::beans::PropertyValue > [in] XDispatch | URL, Arguments, Dispatcher );
Description dispatch given URL and record it if recording is enabled Parameter Dispatcher is used internaly to make the dispatch. If recording isn't enabled it will be a normal XDispatch::dispatch() call. Otherwise follow algorithm is used: If Dispatcher doesn't support the interface XRecordableDispatch a normal dispatch() call will be made and depend from the result state of that the request will be recorded. In this case it's possible to record the incoming parameter ( URL and Arguments ) only. Parameters of internal processes can't be recorded then and will be lost. If Dispatcher support the interface XRecordableDispatch it will be used to dispatch and record all neccessary parameters of the whole process. See also XRecordableDispatch

Top of Page

Copyright © 2003 Sun Microsystems, Inc.