| LibreOffice
    LibreOffice 25.2 SDK API Reference | 
provides recording functionality of dispatches More...
import "XDispatchRecorder.idl";
 
  
| Public Member Functions | |
| void | startRecording ([in] com::sun::star::frame::XFrame Frame) | 
| initializes the recorder by passing the frame for which all macro statements shall be recorded | |
| void | endRecording () | 
| stops the recording process | |
| void | recordDispatch ([in] com::sun::star::util::URL URL, [in] sequence< com::sun::star::beans::PropertyValue > Arguments) | 
| records a single dispatch call identified by its command URL | |
| void | recordDispatchAsComment ([in] com::sun::star::util::URL URL, [in] sequence< com::sun::star::beans::PropertyValue > Arguments) | 
| records a single dispatch call identified by its command URL, but comments it out | |
| string | getRecordedMacro () | 
| returns the recorded source code | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
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.
| void endRecording | ( | ) | 
stops the recording process
Must be called in pairs with XDispatchRecorder::startRecording().
| string getRecordedMacro | ( | ) | 
returns the recorded source code
This method must be used before endRecording() is called! Otherwise the macro will be released.
| void recordDispatch | ( | [in] com::sun::star::util::URL | URL, | 
| [in] sequence< com::sun::star::beans::PropertyValue > | Arguments ) | 
records a single dispatch call identified by its command URL
| URL | the full parsed command URL | 
| Arguments | optional arguments for the command URL (see com::sun::star::document::MediaDescriptor for further information) | 
| void recordDispatchAsComment | ( | [in] com::sun::star::util::URL | URL, | 
| [in] sequence< com::sun::star::beans::PropertyValue > | Arguments ) | 
records a single dispatch call identified by its command URL, but comments it out
This way calls that failed on execution can be documented.
| URL | the full parsed command URL | 
| Arguments | optional arguments for the command URL (see com::sun::star::document::MediaDescriptor for further information) | 
| void startRecording | ( | [in] com::sun::star::frame::XFrame | Frame | ) | 
initializes the recorder by passing the frame for which all macro statements shall be recorded
| Frame | it includes the document on which such requests shall be recorded |