Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: document ::

interface XUndoManagerListener
Base Interfaces
XUndoManagerListener
┗ ::com::sun::star::lang::XEventListener

::com::sun::star::lang::XEventListener
(referenced interface's summary:)
base interface for all event listeners interfaces.
Description
implemented by components which want to be notified of changes in the Undo/Redo stacks of an Undo manager.
See also
XUndoManager

Methods' Summary
undoActionAdded is called when an undo action is added to the undo stack.  
actionUndone is called when the top-most action of the undo stack has been undone.  
actionRedone is called when the top-most action of the Redo stack has been re-applied.  
allActionsCleared is called when both the Undo and the Redo stack have been cleared from all Undo actions.  
redoActionsCleared is called when the the Redo stack has been cleared.  
resetAll called when the complete undo manager has been reset  
enteredContext is called when a new Undo context has been entered.  
enteredHiddenContext is called when a new hidden Undo context has been entered.  
leftContext is called when an Undo context has been left.  
leftHiddenContext is calledn when a hidden Undo context has been left.  
cancelledContext is called when an Undo context has been left, but no actions have been added within this context.  
Methods' Details
undoActionAdded
void
undoActionAdded( [in] UndoManagerEvent  i_event );

Description
is called when an undo action is added to the undo stack.

Note that the action must not necessarily be the new top element of the stack: In case there's an open Undo context, UndoManagerEvent::UndoContextDepth will be greater 0, and the newly added action will be subordinate of the context action.

See also
XUndoManager::addUndoAction
actionUndone
void
actionUndone( [in] UndoManagerEvent  i_event );

Description
is called when the top-most action of the undo stack has been undone.
See also
XUndoManager::undo
actionRedone
void
actionRedone( [in] UndoManagerEvent  i_event );

Description
is called when the top-most action of the Redo stack has been re-applied.
See also
XUndoManager::redo
allActionsCleared
void
allActionsCleared( [in] ::com::sun::star::lang::EventObject  i_event );

Description
is called when both the Undo and the Redo stack have been cleared from all Undo actions.
See also
XUndoManager::clear
redoActionsCleared
void
redoActionsCleared( [in] ::com::sun::star::lang::EventObject  i_event );

Description
is called when the the Redo stack has been cleared.
See also
XUndoManager::clearRedo
resetAll
void
resetAll( [in] ::com::sun::star::lang::EventObject  i_event );

Description
called when the complete undo manager has been reset
enteredContext
void
enteredContext( [in] UndoManagerEvent  i_event );

Description
is called when a new Undo context has been entered.

UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and UndoManagerEvent::UndoContextDepth the number of open Undo contexts, including the one just entered.

See also
XUndoManager::enterUndoContext
enteredHiddenContext
void
enteredHiddenContext( [in] UndoManagerEvent  i_event );

Description
is called when a new hidden Undo context has been entered.

UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and UndoManagerEvent::UndoContextDepth the number of open Undo contexts, including the one just entered.

See also
XUndoManager::enterUndoContext
leftContext
void
leftContext( [in] UndoManagerEvent  i_event );

Description
is called when an Undo context has been left.

UndoManagerEvent::UndoActionTitle carries the title of the Undo context, and UndoManagerEvent::UndoContextDepth the number of open Undo contexts, exluding the one just left.

See also
XUndoManager::leaveUndoContext, leftHiddenUndocontext, cancelledContext
leftHiddenContext
void
leftHiddenContext( [in] UndoManagerEvent  i_event );

Description
is calledn when a hidden Undo context has been left.

UndoManagerEvent::UndoActionTitle is empty, as hidden Undo contexts don't have a title.

See also
XUndoManager::leaveHiddenUndoContext, leftContext, cancelledContext
cancelledContext
void
cancelledContext( [in] UndoManagerEvent  i_event );

Description
is called when an Undo context has been left, but no actions have been added within this context.

In such a case, the context which has just been left will not contribute to the undo stack, but instead be silently removed. Consequently, the UndoManagerEvent::UndoActionTitle is empty.

See also
XUndoManager::leaveUndoContext, leftContext, leftHiddenContext
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.