API 0.9.5
CPUndoManager Class Reference

A general mechanism for user action "undo". More...

#import <CPUndoManager.h>

Inheritance diagram for CPUndoManager:

List of all members.

Instance Methods

(void) - beginUndoGrouping
(BOOL) - canRedo
(BOOL) - canUndo
(void) - disableUndoRegistration
(void) - enableUndoRegistration
(void) - encodeWithCoder:
(void) - endUndoGrouping
(unsigned) - groupingLevel
(BOOL) - groupsByEvent
(id) - init
(id) - initWithCoder:
(BOOL) - isRedoing
(BOOL) - isUndoing
(BOOL) - isUndoRegistrationEnabled
(void) - observeChangesForKeyPath:ofObject:
(void) - observeValueForKeyPath:ofObject:change:context:
(id) - prepareWithInvocationTarget:
(void) - redo
(CPString- redoActionName
(CPString- redoMenuItemTitle
(CPString- redoMenuTitleForUndoActionName:
(void) - registerUndoWithTarget:selector:object:
(void) - removeAllActions
(void) - removeAllActionsWithTarget:
(CPArray- runLoopModes
(void) - setActionName:
(void) - setGroupsByEvent:
(void) - setRunLoopModes:
(void) - stopObservingChangesForKeyPath:ofObject:
(void) - undo
(CPString- undoActionName
(CPString- undoMenuItemTitle
(CPString- undoMenuTitleForUndoActionName:
(void) - undoNestedGroup

Detailed Description

A general mechanism for user action "undo".

CPUndoManager provides a general mechanism supporting implementation of user action "undo" in applications. Essentially, it allows you to store sequences of messages and receivers that need to be invoked to undo or redo an action. The various methods in this class provide for grouping of sets of actions, execution of undo or redo actions, and tuning behavior parameters such as the size of the undo stack. Each application entity with its own editing history (e.g., a document) should have its own undo manager instance. Obtain an instance through a simple [[CPUndoManager alloc] init] message.

Definition at line 2 of file CPUndoManager.h.


Method Documentation

- (void) beginUndoGrouping

Starts a new grouping of undo tasks, and makes it the current grouping.

Definition at line 427 of file CPUndoManager.j.

- (BOOL) canRedo

Returns YES if the user can perform a redo operation.

Definition at line 314 of file CPUndoManager.j.

- (BOOL) canUndo

Returns YES if the user can perform an undo operation.

Definition at line 326 of file CPUndoManager.j.

- (void) disableUndoRegistration

Disables undo registrations.

Definition at line 556 of file CPUndoManager.j.

- (void) enableUndoRegistration

Enables undo registrations. Calls to this method must be balanced with calls to disableUndoRegistration. So, if two disable calls were made, two enable calls are required to actually enable undo registration again.

Definition at line 504 of file CPUndoManager.j.

- (void) encodeWithCoder: (CPCoder aCoder

Definition at line 860 of file CPUndoManager.j.

- (void) endUndoGrouping

Closes the current undo grouping.

Exceptions:
CPInternalInconsistencyExceptionif no undo group is open

Definition at line 459 of file CPUndoManager.j.

- (unsigned) groupingLevel

Returns the number of undo/redo groups.

Definition at line 541 of file CPUndoManager.j.

- (BOOL) groupsByEvent

Returns YES if the manager groups undo operations at every iteration of the run loop.

Definition at line 516 of file CPUndoManager.j.

- (id) init

Initializes the undo manager

Returns:
the initialized undo manager

Definition at line 203 of file CPUndoManager.j.

- (id) initWithCoder: (CPCoder aCoder

Definition at line 838 of file CPUndoManager.j.

- (BOOL) isRedoing

Returns YES if the manager is currently performing a redo.

Definition at line 581 of file CPUndoManager.j.

- (BOOL) isUndoing

Returns YES if the manager is currently performing an undo.

Definition at line 573 of file CPUndoManager.j.

- (BOOL) isUndoRegistrationEnabled

Returns YES if undo registration is enabled.

Definition at line 564 of file CPUndoManager.j.

- (void) observeChangesForKeyPath: (CPString aKeyPath
ofObject: (id)  anObject 

Definition at line 795 of file CPUndoManager.j.

- (void) observeValueForKeyPath: (CPString aKeyPath
ofObject: (id)  anObject
change: (CPDictionary aChange
context: (id)  aContext 

Definition at line 808 of file CPUndoManager.j.

- (id) prepareWithInvocationTarget: (id)  aTarget

Prepares the specified target for the undo action.

Parameters:
aTargetthe target to receive the action
Returns:
the undo manager

Definition at line 268 of file CPUndoManager.j.

- (void) redo

Performs the redo operation using the last grouping on the redo stack.

Definition at line 384 of file CPUndoManager.j.

- (CPString) redoActionName

If the receiver can perform a redo, this method returns the action name previously associated with the top grouping with -setActionName:. This name should identify the action to be redone.

Returns:
the redo action's name, or nil if no there's no redo on the stack.

Definition at line 656 of file CPUndoManager.j.

- (CPString) redoMenuItemTitle

Returns the full localized title of the actions to be displayed as a menu item. This method first invokes [-redoActionName] and passes it to [-redoMenuTitleForUndoActionName:] and returns the result.

Definition at line 669 of file CPUndoManager.j.

- (CPString) redoMenuTitleForUndoActionName: (CPString anActionName

Returns the localized title of the actions to be displayed as a menu item identified by actionName, by appending a localized command string like "Redo <localized(actionName)>".

Definition at line 679 of file CPUndoManager.j.

- (void) registerUndoWithTarget: (id)  aTarget
selector: (SEL)  aSelector
object: (id)  anObject 

Registers an undo operation. You invoke this method with the target of the undo action providing the selector which can perform the undo with the provided object. The object is often a dictionary of the identifying the attribute and their values before the change. The invocation will be added to the current grouping. If the registrations have been disabled through -disableUndoRegistration, this method does nothing.

Parameters:
aTargetthe target for the undo invocation
aSelectorthe selector for the action message
anObjectthe argument for the action message
Exceptions:
CPInternalInconsistencyExceptionif no undo group is currently open

Definition at line 247 of file CPUndoManager.j.

- (void) removeAllActions

Clears all redo and undo operations and enables undo registrations.

Definition at line 590 of file CPUndoManager.j.

- (void) removeAllActionsWithTarget: (id)  aTarget

Removes any redo and undo operations that use the specified target.

Parameters:
aTargetthe target for which operations should be removed.

Definition at line 609 of file CPUndoManager.j.

- (CPArray) runLoopModes

Returns the CPRunLoopModes in which the receiver registers the -endUndoGrouping processing when it -groupsByEvent.

Definition at line 737 of file CPUndoManager.j.

- (void) setActionName: (CPString anActionName

Sets the name associated with the actions of the current group. Typically, you can call this method while registering the actions for the current group.

Parameters:
anActionNamethe new name for the current group

Definition at line 644 of file CPUndoManager.j.

- (void) setGroupsByEvent: (BOOL)  aFlag

Sets whether the manager should group undo operations at every iteration of the run loop.

Parameters:
aFlagYES groups undo operations

Definition at line 525 of file CPUndoManager.j.

- (void) setRunLoopModes: (CPArray modes

Sets the modes in which the receiver registers the calls with the current run loop to invoke -endUndoGrouping when it -groupsByEvent. This method first cancels any pending registrations in the old modes and registers the invocation in the new modes.

Parameters:
modesthe modes in which calls are registered

Definition at line 750 of file CPUndoManager.j.

- (void) stopObservingChangesForKeyPath: (CPString aKeyPath
ofObject: (id)  anObject 

Definition at line 803 of file CPUndoManager.j.

- (void) undo

Ends the current grouping, and performs an 'undo' operation.

Definition at line 338 of file CPUndoManager.j.

- (CPString) undoActionName

If the receiver can perform an undo, this method returns the action name previously associated with the top grouping with -setActionName:. This name should identify the action to be undone.

Returns:
the undo action name or nil if no if there's no undo on the stack.

Definition at line 697 of file CPUndoManager.j.

- (CPString) undoMenuItemTitle

Returns the full localized title of the actions to be displayed as a menu item. This method first invokes [-undoActionName] and passes it to [-undoMenuTitleForUndoActionName:] and returns the result.

Definition at line 710 of file CPUndoManager.j.

- (CPString) undoMenuTitleForUndoActionName: (CPString anActionName

Returns the localized title of the actions to be displayed as a menu item identified by actionName, by appending a localized command string like "Undo <localized(actionName)>".

Definition at line 720 of file CPUndoManager.j.

- (void) undoNestedGroup

Performs an undo on the last undo group.

Definition at line 349 of file CPUndoManager.j.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Defines