CPUndoManager Class Reference
[Foundation]

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

List of all members.

Public Member Functions

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

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 170 of file CPUndoManager.j.


Member Function Documentation

- (void) beginUndoGrouping   [implementation]

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

Definition at line 412 of file CPUndoManager.j.

- (BOOL) canRedo   [implementation]

Returns YES if the user can perform a redo operation.

Definition at line 304 of file CPUndoManager.j.

- (BOOL) canUndo   [implementation]

Returns YES if the user can perform an undo operation.

Definition at line 316 of file CPUndoManager.j.

- (void) disableUndoRegistration   [implementation]

Disables undo registrations.

Definition at line 541 of file CPUndoManager.j.

- (void) enableUndoRegistration   [implementation]

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 489 of file CPUndoManager.j.

- (void) encodeWithCoder: (CPCoder aCoder   [implementation]

Definition at line 770 of file CPUndoManager.j.

- (void) endUndoGrouping   [implementation]

Closes the current undo grouping.

Exceptions:
CPInternalInconsistencyException if no undo group is open

Definition at line 444 of file CPUndoManager.j.

- (unsigned) groupingLevel   [implementation]

Returns the number of undo/redo groups.

Definition at line 526 of file CPUndoManager.j.

- (BOOL) groupsByEvent   [implementation]

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

Definition at line 501 of file CPUndoManager.j.

- (id) init   [implementation]

Initializes the undo manager

Returns:
the initialized undo manager

Definition at line 193 of file CPUndoManager.j.

- (id) initWithCoder: (CPCoder aCoder   [implementation]

Definition at line 748 of file CPUndoManager.j.

- (BOOL) isRedoing   [implementation]

Returns YES if the manager is currently performing a redo.

Definition at line 566 of file CPUndoManager.j.

- (BOOL) isUndoing   [implementation]

Returns YES if the manager is currently performing an undo.

Definition at line 558 of file CPUndoManager.j.

- (BOOL) isUndoRegistrationEnabled   [implementation]

Returns YES if undo registration is enabled.

Definition at line 549 of file CPUndoManager.j.

- (void) observeChangesForKeyPath: (CPString aKeyPath
ofObject: (id)  anObject 
[implementation]

Definition at line 711 of file CPUndoManager.j.

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

Definition at line 724 of file CPUndoManager.j.

- (id) prepareWithInvocationTarget: (id)  aTarget   [implementation]

Prepares the specified target for the undo action.

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

Definition at line 258 of file CPUndoManager.j.

- (void) redo   [implementation]

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

Definition at line 371 of file CPUndoManager.j.

- (CPString) redoActionName   [implementation]

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 632 of file CPUndoManager.j.

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

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:
aTarget the target for the undo invocation
aSelector the selector for the action message
anObject the argument for the action message
Exceptions:
CPInternalInconsistencyException if no undo group is currently open

Definition at line 237 of file CPUndoManager.j.

- (void) removeAllActions   [implementation]

Clears all redo and undo operations and enables undo registrations.

Definition at line 575 of file CPUndoManager.j.

- (void) removeAllActionsWithTarget: (id)  aTarget   [implementation]

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

Parameters:
aTarget the target for which operations should be removed.

Definition at line 586 of file CPUndoManager.j.

- (CPArray) runLoopModes   [implementation]

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

Definition at line 653 of file CPUndoManager.j.

- (void) setActionName: (CPString anActionName   [implementation]

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:
anActionName the new name for the current group

Definition at line 621 of file CPUndoManager.j.

- (void) setGroupsByEvent: (BOOL)  aFlag   [implementation]

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

Parameters:
aFlag YES groups undo operations

Definition at line 510 of file CPUndoManager.j.

- (void) setRunLoopModes: (CPArray modes   [implementation]

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:
modes the modes in which calls are registered

Definition at line 666 of file CPUndoManager.j.

- (void) stopObservingChangesForKeyPath: (CPString aKeyPath
ofObject: (id)  anObject 
[implementation]

Definition at line 719 of file CPUndoManager.j.

- (void) undo   [implementation]

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

Definition at line 328 of file CPUndoManager.j.

- (CPString) undoActionName   [implementation]

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 643 of file CPUndoManager.j.

- (void) undoNestedGroup   [implementation]

Performs an undo on the last undo group.

Definition at line 339 of file CPUndoManager.j.


The documentation for this class was generated from the following file:

Generated on Fri Apr 9 11:04:22 2010 for Cappuccino API by  doxygen 1.6.1