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
- Description
- stops the recording process
Must be called in pairs with XDispatchRecorder::startRecording().
@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.
- See also
- getRecordedMacro()
|
|
recordDispatch
void |
recordDispatch( |
[in] ::com::sun::star::util::URL |
URL, |
| [in] sequence< ::com::sun::star::beans::PropertyValue > |
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 |
URL, |
| [in] sequence< ::com::sun::star::beans::PropertyValue > |
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
This method must be used before endRecording() is called!
Otherwhise the macro will be relased.
- Returns
- the recorded data as a string which can be interpreted as a script
|
|
Top of Page
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.