:: com :: sun :: star :: chart2 ::

unpublished interface XUndoManager
Description
An interface for undo functionality based on passing frame::XModel objects.

Methods' Summary
preAction call this before you change the xCurrentModel  
preActionWithArguments call this before you change the xCurrentModel. You can pass parameters to refine the undo action.  
postAction call this after you successfully did changes to your current model  
cancelAction call this if you aborted the current action.  
cancelActionWithUndo same as cancelAction() but restores the given model to the state set in preAction. This is useful for cancellation in live-preview dialogs.  
undo give the current model to be put into the redo-stack  
redo give the current model to be put into the undo-stack  
undoPossible  
redoPossible  
getCurrentUndoString Retrieves the undo string for the most recent undo step  
getCurrentRedoString Retrieves the redo string for the most recent undo step  
getAllUndoStrings Retrieves the undo strings of all stored undo actions in chronological order starting with the most recent.  
getAllRedoStrings Retrieves the redo strings of all stored undo actions in chronological order starting with the most recent.  
Methods' Details
preAction
void
preAction( [in] ::com::sun::star::frame::XModel  xModelBeforeChange );

Description
call this before you change the xCurrentModel
preActionWithArguments
void
preActionWithArguments( [in] ::com::sun::star::frame::XModel  xModelBeforeChange,
[in] sequence< ::com::sun::star::beans::PropertyValue >  aArguments );

Description
call this before you change the xCurrentModel. You can pass parameters to refine the undo action.
postAction
void
postAction( [in] string  aUndoText );

Description
call this after you successfully did changes to your current model
cancelAction
void
cancelAction();

Description
call this if you aborted the current action.
cancelActionWithUndo
void
cancelActionWithUndo( [inout] ::com::sun::star::frame::XModel  xModelToRestore );

Description
same as cancelAction() but restores the given model to the state set in preAction. This is useful for cancellation in live-preview dialogs.
undo
void
undo( [inout] ::com::sun::star::frame::XModel  xCurrentModel );

Description
give the current model to be put into the redo-stack
redo
void
redo( [inout] ::com::sun::star::frame::XModel  xCurrentModel );

Description
give the current model to be put into the undo-stack
undoPossible
boolean
undoPossible();

Returns
if the undo stack is not empty, i.e. a call to undo() will succeed
redoPossible
boolean
redoPossible();

Returns
if the redo stack is not empty, i.e. a call to redo() will succeed
getCurrentUndoString
string
getCurrentUndoString();

Description
Retrieves the undo string for the most recent undo step
getCurrentRedoString
string
getCurrentRedoString();

Description
Retrieves the redo string for the most recent undo step
getAllUndoStrings
sequence< string >
getAllUndoStrings();

Description
Retrieves the undo strings of all stored undo actions in chronological order starting with the most recent.
getAllRedoStrings
sequence< string >
getAllRedoStrings();

Description
Retrieves the redo strings of all stored undo actions in chronological order starting with the most recent.
Top of Page