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!
Otherwise the macro will be released.
- Returns
- the recorded data as a string which can be interpreted as a script
|
|
Top of Page
Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.
Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.