Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: frame ::
interface XDispatchRecorder
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XDispatchRecorder
Description provides recording functionality of dispatches With such recorder it will be possible to record requests of type XDispatch by using additional interface XRecordableDispatch . 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 XDispatchRecorderSupplier which is provided by the Frame service. See also Frame See also XDispatchRecorderSupplier Since version OpenOffice.org 1.1.1

Methods' Summary
startRecording | initializes the recorder by passing the frame for which all macro statements shall be recorded
endRecording | stops the recording process
recordDispatch | records a single dispatch call identified by its command URL
recordDispatchAsComment | records a single dispatch call identified by its command URL, but comments it out
getRecordedMacro | returns the recorded source code

Methods' Details
startRecording
void startRecording( | [in] XFrame | Frame );
Description initializes the recorder by passing the frame for which all macro statements shall be recorded Parameter Frame it includes the document on which such requests shall be recorded
endRecording
void endRecording(); |  |
Description stops the recording process Must be called in pairs with XDispatchRecorder::startRecording() . It's not allowed for the recorder to clear recorded data here - because the must be provided later at method XDispatchRecorder::getRecordedMacro() .
recordDispatch
void recordDispatch( | [in] ::com::sun::star::util::URL [in] sequence< ::com::sun::star::beans::PropertyValue > | URL, Arguments );
Description records a single dispatch call identified by its command URL Parameter URL the full parsed command URL Parameter Arguments optional arguments for the command URL (see ::com::sun::star::document::MediaDescriptor for further informations)
recordDispatchAsComment
void recordDispatchAsComment( | [in] ::com::sun::star::util::URL [in] sequence< ::com::sun::star::beans::PropertyValue > | URL, Arguments );
Description records a single dispatch call identified by its command URL, but comments it out This way calls that failed on execution can be documented. Parameter URL the full parsed command URL Parameter Arguments optional arguments for the command URL (see ::com::sun::star::document::MediaDescriptor for further informations)
getRecordedMacro
string getRecordedMacro(); |  |
Description returns the recorded source code The result of calling this method before calling XDispatchRecorder::endRecording () is undefined. Returns the recorded data as a string which can be interpreted as a script

Top of Page

Copyright © 2003 Sun Microsystems, Inc.