RecordBoundsAction Class Reference

An action which simply marks the fact that, when undone, it has to create a RecalcBoundsAction, and invalidate the existing bounds. It is the opposite action to RecalcBounds and should be used after creating a Recalc object and modifying the bounding box. Even when executed, all the action does is invalidate the screen and create a Recalc action. More...

#include <pathedit.h>

Inheritance diagram for RecordBoundsAction:

List of all members.

Public Member Functions
	RecordBoundsAction ()
	Constructor for the action to recalculate bounds of a node.
	~RecordBoundsAction ()
virtual ActionCode	Execute ()
	Will replace the bounding box of an object, recording the existing bounds.
Static Public Member Functions
static ActionCode	Init (Operation *pOp, ActionList *pActionList, NodeRenderableBounded *WhichNode, 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	DoRecord (Operation *pOp, ActionList *pActionList, NodeRenderableBounded *WhichNode, BOOL OptimiseRedraw=FALSE)
	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. Then it invalidates the current view according to the blob rectangle of the object.
Protected Attributes
NodeRenderableBounded *	ChangedNode

---

Detailed Description

An action which simply marks the fact that, when undone, it has to create a RecalcBoundsAction, and invalidate the existing bounds. It is the opposite action to RecalcBounds and should be used after creating a Recalc object and modifying the bounding box. Even when executed, all the action does is invalidate the screen and create a Recalc action.

Author:

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

Date:

11/7/94

See also:

RecalcBoundsAction

Definition at line 902 of file pathedit.h.

---

Constructor & Destructor Documentation

RecordBoundsAction::RecordBoundsAction (   )

Constructor for the action to recalculate bounds of a node. Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 11/7/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 9872 of file pathedit.cpp. { }

RecordBoundsAction::~RecordBoundsAction (   )

Definition at line 10021 of file pathedit.cpp. { }

---

Member Function Documentation

ActionCode RecordBoundsAction::DoRecord (  Operation *  pOp, ActionList *  pActionList, NodeRenderableBounded *  WhichNode, BOOL  OptimiseRedraw = FALSE )  [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. Then it invalidates the current view according to the blob rectangle of the object. Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 12/7/94 Parameters: pOp  is the currently running operation [INPUTS] pActionList is a pointer ot the action list to which the action should be appended WhichNode is the node we're dealing with here OptimiseRedraw : If this is TRUE and WhichNode is a NodePath then the NeedToRender flags are used to determine the areas of the screen to redraw -  [OUTPUTS] Returns: Action code which indicates success or failure to create the action Errors: ERROR2 if the operation dosen't have a document ERROR3 if you attempt to optimise for a non path object See also: RecalcBoundsAction::DoRecalc Definition at line 9944 of file pathedit.cpp. { ERROR3IF(OptimiseRedraw && !WhichNode->IsNodePath(),"Can't optimise redraw for a non-path object"); RecordBoundsAction* RecAction; ActionCode Act = RecordBoundsAction::Init(pOp, pActionList, WhichNode, (Action**)&RecAction); if (Act != AC_FAIL) { // Force a re-draw of the place where the path used to be Document* pDoc = pOp->GetWorkingDoc(); ERROR2IF( pDoc == NULL, AC_FAIL, "There was no current document in RecordBoundsAction::DoRecord" ); Spread* pSpread = WhichNode->FindParentSpread(); // Do an optimised redraw if possible if (WhichNode->IsNodePath() && OptimiseRedraw) OptimiseRedraw = RecalcBoundsAction::CauseOptimisedRedraw((NodePath*)WhichNode, pDoc, pSpread); else OptimiseRedraw = FALSE; if (!OptimiseRedraw) pDoc->ForceRedraw( pSpread, WhichNode->GetUnionBlobBoundingRect(), FALSE, WhichNode); } return Act; }

ActionCode RecordBoundsAction::Execute (   )  [virtual]

Will replace the bounding box of an object, recording the existing bounds. Author: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 11/7/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: ActionCode, either AC_OK, AC_NORECORD or AC_FAIL Errors: - See also: - Reimplemented from Action. Definition at line 9989 of file pathedit.cpp. { // This is undoing a bounds recalculation RecalcBoundsAction* ReAction; // Create a redo action for this action, which is also a RecalcBoundsAction ActionCode Act; Act = RecalcBoundsAction::Init(pOperation, pOppositeActLst, ChangedNode, (Action**)(&ReAction)); if (Act == AC_FAIL) return AC_FAIL; // Force a re-draw of the place where the path used to be Document* pDoc = GetWorkingDoc(); ERROR2IF( pDoc == NULL, AC_FAIL, "There was no current document when undoing RecalcBounds" ); Spread* pSpread = ChangedNode->FindParentSpread(); if (pSpread != NULL) { DocRect Invalid = ChangedNode->GetUnionBlobBoundingRect(); pDoc->ForceRedraw( pSpread, Invalid, FALSE, ChangedNode ); } return Act; }

ActionCode RecordBoundsAction::Init (  Operation *  pOp, ActionList *  pActionList, NodeRenderableBounded *  WhichNode, 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: Jim_Lynn (Xara Group Ltd) <camelotdev@xara.com> Date: 11/7/94 Parameters: pOp  is the pointer to the operation to which this action belongs [INPUTS] pActionList is the action list to which this action should be added WhichNode is the object whose bounds we want to recalculate NewAction  is a pointer to a pointer to an action, allowing the function to return [OUTPUTS] 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 9904 of file pathedit.cpp. { UINT32 ActSize = sizeof(RecordBoundsAction); ActionCode Ac = Action::Init( pOp, pActionList, ActSize, CC_RUNTIME_CLASS(RecordBoundsAction), NewAction); if ((Ac == AC_OK) && (*NewAction != NULL)) ((RecordBoundsAction*)*NewAction)->ChangedNode = WhichNode; return Ac; }

---

Member Data Documentation

NodeRenderableBounded* RecordBoundsAction::ChangedNode [protected]

Definition at line 920 of file pathedit.h.

---

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

• Kernel/pathedit.h (r1785/r1282)
• Kernel/pathedit.cpp (r1785/r1282)

---