InsertFloaterAction Class Reference

An action to provide the Line tool with an undoable way of inserting the floating endpoint. This isn't stored in the document, which makes life tricky. More...

#include <opbezier.h>

Inheritance diagram for InsertFloaterAction:

List of all members.

Public Member Functions
	InsertFloaterAction ()
	Constructor for the action to insert a floating endpoint.
	~InsertFloaterAction ()
virtual ActionCode	Execute ()
	Inserts the floating endpoint into the Line Tool, creating an undo action to remove the endpoint.
Static Public Member Functions
static ActionCode	Init (Operation *pOp, ActionList *pActionList, 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	DoInsert (Operation *pOp, ActionList *pActionList, BezierTool *pTool, DocCoord *pPoint, Spread *pSpread)
	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.
Public Attributes
BezierTool *	pLineTool
DocCoord	Point
Spread *	pSpread

---

Detailed Description

An action to provide the Line tool with an undoable way of inserting the floating endpoint. This isn't stored in the document, which makes life tricky.

Author:

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

Date:

05/12/94

See also:

Definition at line 259 of file opbezier.h.

---

Constructor & Destructor Documentation

InsertFloaterAction::InsertFloaterAction (   )

Constructor for the action to insert a floating endpoint. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 05/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 1133 of file opbezier.cpp. { pLineTool = NULL; }

InsertFloaterAction::~InsertFloaterAction (   )

Definition at line 1256 of file opbezier.cpp. { }

---

Member Function Documentation

ActionCode InsertFloaterAction::DoInsert (  Operation *  pOp, ActionList *  pActionList, BezierTool *  pTool, DocCoord *  pPoint, Spread *  pSpread )  [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: 05/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 pTool is a pointer to the Line tool. -  [OUTPUTS] Returns: Action code which indicates success or failure to create the action Errors: - See also: RemoveFloaterAction::DoRemove Definition at line 1198 of file opbezier.cpp. { InsertFloaterAction* RecAction = NULL; ActionCode Act = InsertFloaterAction::Init(pOp, pActionList, (Action**)&RecAction); if ( (Act == AC_OK) && (RecAction != NULL) ) { RecAction->pLineTool = pTool; RecAction->pSpread = pSpread; RecAction->Point = *pPoint; } return Act; }

ActionCode InsertFloaterAction::Execute (   )  [virtual]

Inserts the floating endpoint into the Line Tool, creating an undo action to remove the endpoint. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 05/12/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: ActionCode, either AC_OK, AC_NORECORD or AC_FAIL Errors: - See also: RemoveFloaterAction::Execute Reimplemented from Action. Definition at line 1232 of file opbezier.cpp. { ERROR3IF(pLineTool == NULL, "Pointer to line tool was NULL"); RemoveFloaterAction* ReAction = NULL; ActionCode Act = AC_FAIL; // Create a redo action for this action, which is a RemoveFloaterAction if (pLineTool != NULL) { Act = RemoveFloaterAction::Init(pOperation, pOppositeActLst, pLineTool, (Action**)(&ReAction)); if (Act == AC_FAIL) return AC_FAIL; // Now do the actual action pLineTool->SetMoveTo(Point, pSpread, GetWorkingDoc()); } return Act; }

ActionCode InsertFloaterAction::Init (  Operation *  pOp, ActionList *  pActionList, 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: 05/12/94 Parameters: pOp  is the pointer to the operation to which this action belongs [INPUTS] pTool is a pointer to the Line tool so the action can access the SetLineTo and ClearLineTo functions 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 1166 of file opbezier.cpp. { UINT32 ActSize = sizeof(InsertFloaterAction); ActionCode Ac = Action::Init( pOp, pActionList, ActSize, CC_RUNTIME_CLASS(InsertFloaterAction), NewAction); return Ac; }

---

Member Data Documentation

BezierTool* InsertFloaterAction::pLineTool

Definition at line 277 of file opbezier.h.

DocCoord InsertFloaterAction::Point

Definition at line 278 of file opbezier.h.

Spread* InsertFloaterAction::pSpread

Definition at line 279 of file opbezier.h.

---

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

• tools/opbezier.h (r1785/r1282)
• tools/opbezier.cpp (r1785/r1282)

---