ChangeShapePathAction Class Reference

An action to change a path in a regular shape. More...

#include <shapeops.h>

Inheritance diagram for ChangeShapePathAction:

List of all members.

Public Types
enum	ChangeItem { CHANGE_PATH1, CHANGE_PATH2 }
Public Member Functions
	ChangeShapePathAction ()
	Constructor for the action to change an edge path of a regular shape. Initialises the data members to sensible defaults.
virtual ActionCode	Execute ()
	Changes a data item in a Regular shape, createing another ChangeShapePathAction to undo the change.
Static Public Member Functions
static ActionCode	Init (Operation *pOp, ActionList *pActionList, NodeRegularShape *pShape, enum ChangeItem NewItem, Path *NewPath, Action **NewAction)
	This is the function which creates an instance of this action. If there is no room in the undo buffer (which is determined by the base class Init function called within) the function will either return AC_NO_RECORD which means the operation can continue, but no undo information needs to be stored, or AC_OK which means the operation should continue AND record undo information. If the function returns AC_FAIL, there was not enough memory to record the undo information, and the user has decided not to continue with the operation.
static ActionCode	DoReshape (Operation *pOp, ActionList *pActionList, NodeRegularShape *pShape, enum ChangeItem NewItem, Path *NewPath)
	This static function makes it a little easier to use this action. It creates an instance of this action and appends it to the action list.
Private Attributes
NodeRegularShape *	pShape
enum ChangeItem	ChangeItemID
Path	NewEdge

---

Detailed Description

An action to change a path in a regular shape.

Author:

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

Date:

21/12/94

See also:

ChangeShapeDataAction

Definition at line 455 of file shapeops.h.

---

Member Enumeration Documentation

enum ChangeShapePathAction::ChangeItem

Enumerator: CHANGE_PATH1  CHANGE_PATH2  Definition at line 461 of file shapeops.h. {CHANGE_PATH1, CHANGE_PATH2};

---

Constructor & Destructor Documentation

ChangeShapePathAction::ChangeShapePathAction (   )

Constructor for the action to change an edge path of a regular shape. Initialises the data members to sensible defaults. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 21/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1353 of file shapeops.cpp. { pShape = NULL; ChangeItemID = CHANGE_PATH1; }

---

Member Function Documentation

ActionCode ChangeShapePathAction::DoReshape (  Operation *  pOp, ActionList *  pActionList, NodeRegularShape *  pShape, enum ChangeItem  NewItem, Path *  NewData )  [static]

This static function makes it a little easier to use this action. It creates an instance of this action and appends it to the action list. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 21/12/94 Parameters: pOp  is the currently running operation. [INPUTS] pActionList is a pointer ot the action list to which the action should be appended. pShape is a pointer to the NodeRegularShape to change. NewItem identifes the data item that shoudl be changed NewData poits to the path that this action should store -  [OUTPUTS] Returns: Action code which indicates success or failure to create the action Errors: - See also: - Definition at line 1438 of file shapeops.cpp. { // Get the runtime class info on this object and create a pointer to another object of the same type ChangeShapePathAction* NewAction; // Now call the init function to set everything up ActionCode Act = ChangeShapePathAction::Init(pOp, pActionList, pShape, NewItem, NewData, (Action**)&NewAction); return Act; }

ActionCode ChangeShapePathAction::Execute (   )  [virtual]

Changes a data item in a Regular shape, createing another ChangeShapePathAction to undo the change. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 21/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: ActionCode, either AC_OK, AC_NORECORD or AC_FAIL Errors: ERROR2 if the internal shape pointer was NULL. See also: - Reimplemented from Action. Definition at line 1469 of file shapeops.cpp. { ERROR2IF(pShape == NULL, AC_FAIL, "Pointer to shape was NULL. Did you call Init/DoToggle OR handle their failure?"); // Get the runtime class info on this object and create a pointer to another object of the same type ChangeShapePathAction *ReAction; ActionCode Act = AC_FAIL; Path* ReData; switch (ChangeItemID) { case CHANGE_PATH1: ReData = &(pShape->EdgePath1); break; case CHANGE_PATH2: ReData = &(pShape->EdgePath2); break; default: ERROR2(Act, "What was that Change ID?!"); break; } // Create a redo action for this action Act = ChangeShapePathAction::Init(pOperation, pOppositeActLst, pShape, ChangeItemID, ReData, (Action**)(&ReAction)); if (Act == AC_FAIL) return AC_FAIL; // Now do the actual action switch (ChangeItemID) { case CHANGE_PATH1: pShape->EdgePath1.CopyPathDataFrom(&NewEdge); break; case CHANGE_PATH2: pShape->EdgePath2.CopyPathDataFrom(&NewEdge); break; } pShape->InvalidateBoundingRect(); pShape->InvalidateCache(); return Act; }

ActionCode ChangeShapePathAction::Init (  Operation *  pOp, ActionList *  pActionList, NodeRegularShape *  pChangeShape, enum ChangeItem  NewItem, Path *  NewPath, Action **  NewAction )  [static]

This is the function which creates an instance of this action. If there is no room in the undo buffer (which is determined by the base class Init function called within) the function will either return AC_NO_RECORD which means the operation can continue, but no undo information needs to be stored, or AC_OK which means the operation should continue AND record undo information. If the function returns AC_FAIL, there was not enough memory to record the undo information, and the user has decided not to continue with the operation. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 21/12/94 Parameters: pOp  is the pointer to the operation to which this action belongs [INPUTS] pShape is a pointer to the NodeRegularShape to change NewItem identifes the data item that shoudl be changed NewPath points to the path to store as undo infomation pActionList is the action list to which this action should be added NewAction  is a pointer to a pointer to an action, allowing the function to [OUTPUTS] return a pointer to the created action Returns: ActionCode, one of AC_OK, AC_NO_RECORD or AC_FAIL Errors: - See also: Action::Init() Definition at line 1391 of file shapeops.cpp. { UINT32 ActSize = sizeof(ChangeShapePathAction); ActionCode Ac = Action::Init( pOp, pActionList, ActSize, CC_RUNTIME_CLASS(ChangeShapePathAction), NewAction); if ((Ac == AC_OK) && (*NewAction != NULL)) { ((ChangeShapePathAction*)*NewAction)->pShape = pChangeShape; ((ChangeShapePathAction*)*NewAction)->ChangeItemID = NewItem; if (!((ChangeShapePathAction*)*NewAction)->NewEdge.Initialise(NewPath->GetNumCoords())) return AC_FAIL; ((ChangeShapePathAction*)*NewAction)->NewEdge.CopyPathDataFrom(NewPath); } return Ac; }

---

Member Data Documentation

enum ChangeItem ChangeShapePathAction::ChangeItemID [private]

Definition at line 478 of file shapeops.h.

Path ChangeShapePathAction::NewEdge [private]

Definition at line 479 of file shapeops.h.

NodeRegularShape* ChangeShapePathAction::pShape [private]

Definition at line 477 of file shapeops.h.

---

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

• Kernel/shapeops.h (r1785/r1282)
• Kernel/shapeops.cpp (r1785/r1776)

---