ChangeShapePointAction Class Reference

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

#include <shapeops.h>

Inheritance diagram for ChangeShapePointAction:

List of all members.

Public Types
enum	ChangeItem { CHANGE_MAJOR, CHANGE_CENTRE, CHANGE_MINOR }
Public Member Functions
	ChangeShapePointAction ()
	Constructor for the action to change a point in a regular shape. Initialises the data members to sensible defaults.
virtual ActionCode	Execute ()
	Changes a data item in a Regular shape, createing another ChangeShapePointAction to undo the change.
Static Public Member Functions
static ActionCode	Init (Operation *pOp, ActionList *pActionList, NodeRegularShape *pShape, enum ChangeItem NewItem, DocCoord NewData, 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	DoToggle (Operation *pOp, ActionList *pActionList, NodeRegularShape *pShape, enum ChangeItem NewItem, DocCoord NewData)
	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 *	pToggleShape
enum ChangeItem	ChangeItemID
DocCoord	NewValue

---

Detailed Description

An action to change a point in a regular shape.

Author:

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

Date:

13/12/94

See also:

ChangeShapeDataAction

Definition at line 413 of file shapeops.h.

---

Member Enumeration Documentation

enum ChangeShapePointAction::ChangeItem

Enumerator: CHANGE_MAJOR  CHANGE_CENTRE  CHANGE_MINOR  Definition at line 419 of file shapeops.h. {CHANGE_MAJOR, CHANGE_CENTRE, CHANGE_MINOR};

---

Constructor & Destructor Documentation

ChangeShapePointAction::ChangeShapePointAction (   )

Constructor for the action to change a point in a regular shape. Initialises the data members to sensible defaults. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 13/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1162 of file shapeops.cpp. { pToggleShape = NULL; ChangeItemID = CHANGE_MAJOR; NewValue = DocCoord(0,0); }

---

Member Function Documentation

ActionCode ChangeShapePointAction::DoToggle (  Operation *  pOp, ActionList *  pActionList, NodeRegularShape *  pShape, enum ChangeItem  NewItem, DocCoord  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: 10/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 is the value this action should set the data item to -  [OUTPUTS] Returns: Action code which indicates success or failure to create the action Errors: - See also: - Definition at line 1246 of file shapeops.cpp. { // Get the runtime class info on this object and create a pointer to another object of the same type ChangeShapePointAction* NewAction; // Now call the init function to set everything up ActionCode Act = ChangeShapePointAction::Init(pOp, pActionList, pShape, NewItem, NewData, (Action**)&NewAction); return Act; }

ActionCode ChangeShapePointAction::Execute (   )  [virtual]

Changes a data item in a Regular shape, createing another ChangeShapePointAction to undo the change. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 09/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: ActionCode, either AC_OK, AC_NORECORD or AC_FAIL Errors: ERROR3 if the internal shape pointer was NULL. ERROR2 checks on individual changes. See also: - Reimplemented from Action. Definition at line 1278 of file shapeops.cpp. { ERROR3IF(pToggleShape == NULL, "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 ChangeShapePointAction *ReAction; ActionCode Act = AC_FAIL; DocCoord ReData(0,0); switch (ChangeItemID) { case CHANGE_MINOR: ReData = pToggleShape->GetUTMinorAxes(); break; case CHANGE_MAJOR: ReData = pToggleShape->GetUTMajorAxes(); break; case CHANGE_CENTRE: ReData = pToggleShape->GetUTCentrePoint(); break; default: ERROR2(Act, "What was that Change ID?!"); break; } // Create a redo action for this action if (pToggleShape != NULL) { Act = ChangeShapePointAction::Init(pOperation, pOppositeActLst, pToggleShape, ChangeItemID, ReData, (Action**)(&ReAction)); if (Act == AC_FAIL) return AC_FAIL; // Now do the actual action switch (ChangeItemID) { case CHANGE_MINOR: pToggleShape->SetMinorAxes(NewValue); break; case CHANGE_MAJOR: pToggleShape->SetMajorAxes(NewValue); break; case CHANGE_CENTRE: pToggleShape->SetCentrePoint(NewValue); break; } pToggleShape->InvalidateBoundingRect(); pToggleShape->InvalidateCache(); } return Act; }

ActionCode ChangeShapePointAction::Init (  Operation *  pOp, ActionList *  pActionList, NodeRegularShape *  pShape, enum ChangeItem  NewItem, DocCoord  NewData, 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: 10/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 NewData is the value this action should set the data item to 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 1201 of file shapeops.cpp. { UINT32 ActSize = sizeof(ChangeShapePointAction); ActionCode Ac = Action::Init( pOp, pActionList, ActSize, CC_RUNTIME_CLASS(ChangeShapePointAction), NewAction); if ((Ac == AC_OK) && (*NewAction != NULL)) { ((ChangeShapePointAction*)*NewAction)->pToggleShape = pShape; ((ChangeShapePointAction*)*NewAction)->ChangeItemID = NewItem; ((ChangeShapePointAction*)*NewAction)->NewValue = NewData; } return Ac; }

---

Member Data Documentation

enum ChangeItem ChangeShapePointAction::ChangeItemID [private]

Definition at line 438 of file shapeops.h.

DocCoord ChangeShapePointAction::NewValue [private]

Definition at line 439 of file shapeops.h.

NodeRegularShape* ChangeShapePointAction::pToggleShape [private]

Definition at line 437 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)

---