ActionHideColours Class Reference

When executed, sets/clears an IndexedColour's 'deleted' flag, so that it becomes {un}hidden - this is then un/redoable by using a HideAction with the opposite 'HideFlag' value. More...

#include <colormgr.h>

Inheritance diagram for ActionHideColours:

List of all members.

Public Member Functions
	ActionHideColours ()
	ActionHideColours constructor.
	~ActionHideColours ()
	ActionHideColours destructor.
virtual void	Slaughter (void)
	ActionHideColours Slaughter method. Cleans up any deleted colours associated with this action - once slaughtered, deleted colours can not come back (touch wood!) so are actually deleted from the document rather than just hidden.
virtual ActionCode	Execute ()
	Executes the ActionHideColours (to hide/unhide an IndexedColour), creating an equal and opposite action to undo it with later.
Static Public Member Functions
static ActionCode	Init (Operation *const pOp, ActionList *pActionList, UINT32 ActionSize, ColourList *ParentList, IndexedColour *Colour[], BOOL HideThem, Action **NewAction)
	To check that there is sufficient room for the action in the operation history, and if there is, then to add the action to the operations action list.
Private Attributes
ColourList *	ParentList
IndexedColour **	ChangeColour
BOOL	HideFlag

---

Detailed Description

When executed, sets/clears an IndexedColour's 'deleted' flag, so that it becomes {un}hidden - this is then un/redoable by using a HideAction with the opposite 'HideFlag' value.

Author:

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

Date:

3/6/94

Scope: Private - for use only by the ColourManager

See also:

OpHideColours

Definition at line 356 of file colormgr.h.

---

Constructor & Destructor Documentation

ActionHideColours::ActionHideColours (   )

ActionHideColours constructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 6/6/94 Definition at line 2853 of file colormgr.cpp. { ChangeColour = NULL; ParentList = NULL; }

ActionHideColours::~ActionHideColours (   )

ActionHideColours destructor. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 6/6/94 Definition at line 2871 of file colormgr.cpp. { if (ChangeColour != NULL) delete [] ChangeColour; }

---

Member Function Documentation

ActionCode ActionHideColours::Execute (   )  [virtual]

Executes the ActionHideColours (to hide/unhide an IndexedColour), creating an equal and opposite action to undo it with later. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 6/6/94 Parameters: -  [INPUTS] ActionCode  indicating if the action was successfully executed or not [OUTPUTS] Returns: - Reimplemented from Action. Definition at line 2949 of file colormgr.cpp. { ActionHideColours HideColAct; ActionCode ActCode; // Create an action to restore the changes we are about to make if ((ActCode = ActionHideColours::Init(pOperation, pOppositeActLst, sizeof(ActionHideColours), ParentList, ChangeColour, ((HideFlag) ? FALSE : TRUE), (Action**)(&HideColAct))) != AC_FAIL) { INT32 Index = 0; while (ChangeColour[Index] != NULL) // Write all the 'deleted' flags { // Check that the caller only gave us named colours ERROR3IF(!ChangeColour[Index]->IsNamed(), "You don't need to call (Un)HideColours for Local colours! Remove ASAP!"); ChangeColour[Index]->SetDeleted(HideFlag); Index++; } } return (ActCode); }

ActionCode ActionHideColours::Init (  Operation *const   pOp, ActionList *  pActionList, UINT32  ActionSize, ColourList *  TheParentList, IndexedColour *  Colour[], BOOL  HideThem, Action **  NewAction )  [static]

To check that there is sufficient room for the action in the operation history, and if there is, then to add the action to the operations action list. Parameters: pOp,:  The operation to which the action should be added [INPUTS] pActionList: The action list in the operation object ActionSize: The size of the action in bytes. This should be the total size of the action (including any objects pointed to by the action). TheParentList: Points to the list containing the IndexedColours in Colour[] Colour[]: A NULL terminated list array of pointers to the IndexedColours which are to be hidden/unhidden HideThem: TRUE to Hide, FALSE to unhide the colours. NewAction,:  A pointer to the action if it could be allocated. [OUTPUTS] Returns: AC_FAIL: There was not enough room in the operation history for the action and the user did not wish to continue. Usually End() should be called in this situation. AC_NORECORD: There was not enough room in the operation history for the action, but the user requested that he wished to continue without undo. AC_OK : The action was successfully initialised and added to the operation. The function calls the Action::Init function passing the runtime class of an ActionHideColours. Returns: Errors: - See also: Action::Init Definition at line 3027 of file colormgr.cpp. { ActionCode Ac = (Action::Init(pOp, pActionList, ActionSize, CC_RUNTIME_CLASS(ActionHideColours), NewAction)); if (*NewAction != NULL) { INT32 Count = 0; while (Colour[Count] != NULL) // Count array size Count++; ActionHideColours *AHC = (ActionHideColours*) (*NewAction); ALLOC_WITH_FAIL(AHC->ChangeColour, new IndexedColourPtr[Count+1], pOp); if (AHC->ChangeColour == NULL) // Failed in Action Alloc { delete AHC; // Delete the action *NewAction = NULL; // Ensure return NULL return(AC_FAIL); // And return 'failed' } Count = 0; while (Colour[Count] != NULL) // Copy Colour array { AHC->ChangeColour[Count] = Colour[Count]; Count++; } AHC->ChangeColour[Count] = NULL; // And NULL terminate AHC->ParentList = TheParentList; // Copy the parentlist pointer AHC->HideFlag = HideThem; // Copy HideFlag } return (Ac); }

void ActionHideColours::Slaughter (  void   )  [virtual]

ActionHideColours Slaughter method. Cleans up any deleted colours associated with this action - once slaughtered, deleted colours can not come back (touch wood!) so are actually deleted from the document rather than just hidden. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 21/11/94 Notes: Only colours which are truly 'deleted' at this point in time are destructed, because this action both deletes (hides) and undeletes (unhides) colours, so our 'undo/redo' record may point at colours which are currently alive and in use. We also have to be careful about this, as there can be 2 undo records for the same colour (creation and deletion) in the list at once, and obviously, only one of them should attemp to destruct the colour! Reimplemented from Action. Definition at line 2899 of file colormgr.cpp. { // If we have some colour(s) and our last action was to hide them (thus they are // deleted colours rather than undeleted ones), then we are responsible for // slaughtering the now-unneeded colours. // NOTE: Remember that if we are a 'Hide' action, then the colour should currently // be in an UN-hidden state; thus, we delete ONLY if we are an UN-hide action. if (ChangeColour != NULL && !HideFlag) { INT32 Index = 0; // Delete each colour in turn from the ParentList ColourList while (ChangeColour[Index] != NULL) { // Remove from the list ParentList->RemoveItem(ChangeColour[Index]); // Ensure it has no children pointing at it ParentList->RemoveLinksToColour(ChangeColour[Index]); // Delink this colour from its parent, if any if (ChangeColour[Index]->FindLastLinkedParent() != NULL) ChangeColour[Index]->SetLinkedParent(NULL, COLOURTYPE_NORMAL); // And finally, delete it delete ChangeColour[Index]; Index++; } } Action::Slaughter(); // Call the base class Slaughter method to delete ourself }

---

Member Data Documentation

IndexedColour** ActionHideColours::ChangeColour [private]

Definition at line 378 of file colormgr.h.

BOOL ActionHideColours::HideFlag [private]

Definition at line 379 of file colormgr.h.

ColourList* ActionHideColours::ParentList [private]

Definition at line 377 of file colormgr.h.

---

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

• Kernel/colormgr.h (r1785/r1282)
• Kernel/colormgr.cpp (r1785/r1777)

---