ActionList Class Reference

An ActionList is a list object which holds actions which can be executed. It is used by Operation objects to hold UNDO, REDO and Smart duplicate actions. More...

#include <ops.h>

Inheritance diagram for ActionList:

List of all members.

Public Member Functions
	ActionList ()
	~ActionList ()
	ActionList destructor, deletes the action list and all actions it contains. NOTE that REDO action lists must be deleted backwrds.
BOOL	ExecuteForwards (BOOL AllButLast)
	This method executes all actions in the action list forwards. If there is no failure then all actions are deleted If an action fails whilst executing no actions are deleted and FALSE is returned.
BOOL	ExecuteBackwards (BOOL AllButLast, BOOL bIgnoreSelectActions=FALSE)
	This method executes all actions in the action list backwards. If there is no failure then all actions are deleted If an action fails whilst executing no actions are deleted and FALSE is returned.
Action *	FindActionOfClass (CCRuntimeClass *ClassOfActionToFind, Action *LastAction=NULL)
	To search the action list for the first action with runtime class ClassOfActionToFind.

---

Detailed Description

An ActionList is a list object which holds actions which can be executed. It is used by Operation objects to hold UNDO, REDO and Smart duplicate actions.

Author:

Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>

Date:

6/7/93

See also:

Operation

Action

Definition at line 196 of file ops.h.

---

Constructor & Destructor Documentation

ActionList::ActionList (   )

ActionList::~ActionList (   )

ActionList destructor, deletes the action list and all actions it contains. NOTE that REDO action lists must be deleted backwrds. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 6/7/93 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: ActionList::SlaughterBackwards; Definition at line 219 of file ops.cpp. { /* ListItem* Current = GetHead(); // First action while (Current != NULL) // While there are more actions to delete { ((Action*)RemoveHead())->Slaughter(); // Delete the action Current = GetHead(); // Get next action ContinueSlowJob(); } */ ListItem* Current = GetTail(); // Last action while (Current != NULL) // While there are more actions to delete { ((Action*)RemoveTail())->Slaughter(); // Delete the action Current = GetTail(); // Get next action ContinueSlowJob(); } }

---

Member Function Documentation

BOOL ActionList::ExecuteBackwards (  BOOL  AllButLast, BOOL  bIgnoreSelectActions = FALSE )

This method executes all actions in the action list backwards. If there is no failure then all actions are deleted If an action fails whilst executing no actions are deleted and FALSE is returned. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 5/7/93 Parameters: AllButLast,:  When FALSE execute all actions in the action list. [INPUTS] When TRUE execute all actions except the last -  [OUTPUTS] Returns: TRUE if the action list was successfully executed FALSE if it was not Errors: - See also: ActionList::ExecuteForwards Definition at line 338 of file ops.cpp. { ListItem* CurrentAction = GetTail(); if (AllButLast && (CurrentAction != NULL)) CurrentAction = CurrentAction->Previous; // Don't execute the last action //TRACE( _T("Before Undo\n")); //((Action*)CurrentAction)->GetWorkingDoc()->FindFirstSpread()->DST(); BOOL Failed = FALSE; while ((CurrentAction != NULL) && (!Failed)) // For each action in the list { // Attempt to execute action if (!(bIgnoreSelectActions && CurrentAction->IsKindOf(CC_RUNTIME_CLASS(RestoreSelectionsAction))) ) Failed = (((Action*)CurrentAction)->Execute() == AC_FAIL); //((Action*)CurrentAction)->Dump(); //((Action*)CurrentAction)->GetWorkingDoc()->FindFirstSpread()->DST(); // Get next action CurrentAction = CurrentAction->Previous; } if (!Failed) { // Successfully executed action list so all actions are deleted. Action* HeadItem = (Action *) GetHead(); Document *pDoc = HeadItem->GetWorkingDoc(); ERROR2IF(pDoc == NULL, FALSE, "No document attached to action in Action::ExecuteBackwards"); OperationHistory& OpHistory = pDoc->GetOpHistory(); // Loop while there are still actions to delete while (HeadItem != NULL) { // Reduce the size of the operation history by the size of the action being deleted OpHistory.DecSize(((Action*)HeadItem)->GetSize()); // Delete the action delete (RemoveItem(HeadItem)); // Get next action HeadItem = (Action *) GetHead(); } } return (!Failed); }

BOOL ActionList::ExecuteForwards (  BOOL  AllButLast  )

This method executes all actions in the action list forwards. If there is no failure then all actions are deleted If an action fails whilst executing no actions are deleted and FALSE is returned. Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 5/7/93 Parameters: AllButLast,:  When FALSE execute all actions in the action list. [INPUTS] When TRUE execute all actions except the last -  [OUTPUTS] Returns: TRUE if the action list was successfully executed FALSE if it was not Errors: - See also: - Definition at line 265 of file ops.cpp. { ListItem* CurrentAction = GetHead(); ListItem* LastAction = GetTail(); // If we are to execute all actions but the last then the last action to // execute is prev(tail) if ((LastAction != NULL) && (AllButLast)) LastAction = LastAction->Previous; //TRACE( _T("Before Redo\n")); //((Action*)CurrentAction)->GetWorkingDoc()->FindFirstSpread()->DST(); BOOL Failed = FALSE; while ((CurrentAction != LastAction) && (!Failed)) // For each action in the list { // Execute the action Failed = (((Action*)CurrentAction)->Execute() == AC_FAIL); //((Action*)CurrentAction)->Dump(); //((Action*)CurrentAction)->GetWorkingDoc()->FindFirstSpread()->DST(); CurrentAction = CurrentAction->Next; } if (!Failed) { // Successfully executed action list so all actions are deleted. Action* HeadItem = (Action *) GetHead(); Document *pDoc = HeadItem->GetWorkingDoc(); ERROR2IF(pDoc == NULL, FALSE, "No document attached to action in Action::ExecuteForwards"); OperationHistory& OpHistory = pDoc->GetOpHistory(); while (HeadItem != NULL) { // Reduce the size of the operation history by the size of the action // being deleted. OpHistory.DecSize(HeadItem->GetSize()); // Remove the action from the action list delete (RemoveItem(HeadItem)); // Get next action HeadItem = (Action *) GetHead(); } } return (!Failed); }

Action * ActionList::FindActionOfClass (  CCRuntimeClass *  ClassOfActionToFind, Action *  LastAction = NULL )

To search the action list for the first action with runtime class ClassOfActionToFind. Action* ActionList::FindActionOfClass(CCRuntimeClass* ClassOfActionToFind, Action* LastAction = NULL); Author: Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com> Date: 04/11/94 Parameters: ClassOfActionToFind,:  the runtime class of the action we are to search for [INPUTS] LastAction: if you need to search for more than one occurence of a particular action then specifying the LastAction parameter will cause the search to begin after this Action. If this parameter is not specified then the search will start at the head of the action list. -  [OUTPUTS] Returns: A pointer to the first action with runtime class ClassOfActionToFind, or NULL if no such action was found. Errors: - See also: Definition at line 418 of file ops.cpp. { Action* Current = LastAction; // Will be NULL if LastAction is not specified do { if (Current == NULL) { Current = (Action*)GetHead(); } else { Current = (Action*)GetNext(Current); } if ((Current != NULL) && (Current->GetRuntimeClass() == ClassOfActionToFind)) { return Current; } } while (Current != NULL); return NULL; }

---

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

• Kernel/ops.h (r1785/r877)
• Kernel/ops.cpp (r1785/r1361)

---