Action

References
public abstract class Action : IStorable
A single undoable/redoable action. Actions are combined into Records in order to be timestamped, named and joined.

Constructors

Action

#
protected Action(Effects response)
Parameters:
response (Effects)

Action

#
protected Action(IReader reader)
Parameters:
reader (IReader)

Properties

Response

#
public Effects Response { get; }
Gets the automatic response required by this action.

State

#
public State State { get; }
Gets the state this action is in.

Methods

Extends

#
public virtual bool Extends(Action action)
Override this method to indicate this action extends another action, and can thus be dropped from a sequence of actions.
Parameters:
action (Action)

PerformRedo

#
public bool PerformRedo(Document doc)
Redo this action. This is only allowed if the State equals State.Redo.
Parameters:
doc (Document)

PerformRedoInternal

#
protected abstract void PerformRedoInternal(Document doc)
Parameters:
doc (Document)

PerformUndo

#
public bool PerformUndo(Document doc)
Undo this action. This is only allowed if the State equals State.Undo.
Parameters:
doc (Document)

PerformUndoInternal

#
protected abstract void PerformUndoInternal(Document doc)
Parameters:
doc (Document)

PrepareRedo

#
public bool PrepareRedo(Document doc)
Run the preperatory work for a redo operation. The PerformRedo(Document) method ought never be called without a preceding call to PrepareRedo(Document), although note that a call to PrepareRedo(Document) is not necessarily followed by a call to PerformRedo(Document).
Parameters:
doc (Document)

PrepareRedoInternal

#
protected virtual void PrepareRedoInternal(Document doc)
Parameters:
doc (Document)

PrepareUndo

#
public bool PrepareUndo(Document doc)
Run the preperatory work for an undo operation. The PerformUndo(Document) method ought never be called without a preceding call to PrepareUndo(Document), although note that a call to PrepareUndo(Document) is not necessarily followed by a call to PerformUndo(Document).
Parameters:
doc (Document)

PrepareUndoInternal

#
protected virtual void PrepareUndoInternal(Document doc)
Parameters:
doc (Document)

Store

#
public virtual void Store(IWriter writer)
Parameters:
writer (IWriter)
Implements: Store