MarkEditListAction Class Reference

An action to record/restore the current state of the LiveEffect EditList. An action to record/restore the current state of the LiveEffect EditList. More...

#include <opliveeffects.h>

Inheritance diagram for MarkEditListAction:

List of all members.

Public Member Functions
	MarkEditListAction ()
	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. 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. Inserts the floating endpoint into the Line Tool, creating an undo action to remove the endpoint.
	~MarkEditListAction ()
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	DoMarkEditList (Operation *pOp, ActionList *pActionList, EffectsStack *pPPStack, INT32 iStackPos)
	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
IXMLDOMDocumentPtr	pEditList
INT32	iStackPos

---

Detailed Description

An action to record/restore the current state of the LiveEffect EditList. An action to record/restore the current state of the LiveEffect EditList.

Author:

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

Date:

17/09/2004

See also:

Definition at line 706 of file opliveeffects.h.

---

Constructor & Destructor Documentation

MarkEditListAction::MarkEditListAction (   )

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. 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. Inserts the floating endpoint into the Line Tool, creating an undo action to remove the endpoint. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 17/09/2004 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 4607 of file opliveeffects.cpp. { pEditList = NULL; iStackPos = -1; }

MarkEditListAction::~MarkEditListAction (   )

Definition at line 4770 of file opliveeffects.cpp. { pEditList = NULL; }

---

Member Function Documentation

ActionCode MarkEditListAction::DoMarkEditList (  Operation *  pOp, ActionList *  pActionList, EffectsStack *  pPPStack, INT32  iStackPos )  [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: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 17/09/2004 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 4672 of file opliveeffects.cpp. { ERROR2IF(iStackPos<0, AC_FAIL, "Bad stack pos in DoMarkEditList"); MarkEditListAction* RecAction = NULL; ActionCode Act = MarkEditListAction::Init(pOp, pActionList, (Action**)&RecAction); if ( (Act == AC_OK) && (RecAction != NULL) ) { PPStackLevel* pLevel = (PPStackLevel*)pPPStack->FindItem(iStackPos); if (pLevel && pLevel->pPPNode && pLevel->pPPNode->IsBitmapEffect()) { RecAction->pEditList = CXMLUtils::NewDocument(((NodeBitmapEffect*)pLevel->pPPNode)->GetEditList()); RecAction->iStackPos = iStackPos; } else return AC_FAIL; } return Act; }

ActionCode MarkEditListAction::Execute (   )  [virtual]

Inserts the floating endpoint into the Line Tool, creating an undo action to remove the endpoint. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 17/09/2004 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: ActionCode, either AC_OK, AC_NORECORD or AC_FAIL Errors: - See also: RemoveFloaterAction::Execute Reimplemented from Action. Definition at line 4713 of file opliveeffects.cpp. { ERROR2IF(this->iStackPos<0, AC_FAIL, "Bad stack pos in MarkEditListAction::Execute"); MarkEditListAction* ReAction = NULL; ActionCode Act = AC_FAIL; // Create a redo action for this action, which is another MarkEditListAction Act = MarkEditListAction::Init(pOperation, pOppositeActLst, (Action**)(&ReAction)); if (Act == AC_FAIL) return AC_FAIL; // --------------------------------------------------- // Record the current edit list in the Action? EffectsStack* pPPStack = EffectsStack::GetEffectsStackFromSelection(); if (pPPStack==NULL) return AC_FAIL; PPStackLevel* pLevel = (PPStackLevel*)pPPStack->FindItem(this->iStackPos); if (pLevel && pLevel->pPPNode && pLevel->pPPNode->IsBitmapEffect()) { ReAction->pEditList = CXMLUtils::NewDocument(((NodeBitmapEffect*)pLevel->pPPNode)->GetEditList()); ReAction->iStackPos = this->iStackPos; } else { ReAction->pEditList = CXMLUtils::NewDocument(this->pEditList); ReAction->iStackPos = this->iStackPos; } // --------------------------------------------------- // Now do the actual action // Run through the selection, setting edit lists on LiveEffects Node* pNode = NULL; if (pLevel) pNode = pLevel->listSelNodes.FindFirst(); while (pNode) { if (pNode->IsBitmapEffect()) { NodeBitmapEffect* pLE = (NodeBitmapEffect*)pNode; pLE->SetProcessedBitmap(NULL, NULL, DocRect(), 0, 0, 0, 0); // Remove cached bitmap to be sure pLE->SetEditList(CXMLUtils::NewDocument(this->pEditList)); } else return AC_FAIL; pNode = pLevel->listSelNodes.FindNext(pNode); } delete pPPStack; pPPStack = NULL; return Act; }

ActionCode MarkEditListAction::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: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 17/09/2004 Parameters: pOp  is the pointer to the operation to which this action belongs [INPUTS] pTool is 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 4639 of file opliveeffects.cpp. { UINT32 ActSize = sizeof(MarkEditListAction); ActionCode Ac = Action::Init( pOp, pActionList, ActSize, CC_RUNTIME_CLASS(MarkEditListAction), NewAction); return Ac; }

---

Member Data Documentation

INT32 MarkEditListAction::iStackPos

Definition at line 725 of file opliveeffects.h.

IXMLDOMDocumentPtr MarkEditListAction::pEditList

Definition at line 724 of file opliveeffects.h.

---

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

• tools/opliveeffects.h (r1785/r1361)
• tools/opliveeffects.cpp (r1785/r1282)

---