InvalidateBoundsAction Class Reference

An action which invalidates the bounds of a node. More...

#include <blndtool.h>

Inheritance diagram for InvalidateBoundsAction:

Action ListItem CCObject SimpleCCObject List of all members.

Public Member Functions

 InvalidateBoundsAction ()
 Constructor for the action.
 ~InvalidateBoundsAction ()
virtual ActionCode Execute ()
 Executes the action.

Static Public Member Functions

static ActionCode Init (Operation *pOp, ActionList *pActionList, NodeRenderableBounded *pNode, BOOL IncludeChildren)
 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.

Protected Attributes

NodeRenderableBoundedm_pNode
BOOL m_IncludeChildren

Detailed Description

An action which invalidates the bounds of a node.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
20/3/99
See also:
-

Definition at line 1171 of file blndtool.h.


Constructor & Destructor Documentation

InvalidateBoundsAction::InvalidateBoundsAction  ) 
 

Constructor for the action.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
24/5/99

Definition at line 8598 of file blndtool.cpp.

08599 {
08600     m_pNode = NULL;
08601     m_IncludeChildren = FALSE;
08602 }

InvalidateBoundsAction::~InvalidateBoundsAction  ) 
 

Definition at line 8681 of file blndtool.cpp.

08682 {
08683 }


Member Function Documentation

ActionCode InvalidateBoundsAction::Execute  )  [virtual]
 

Executes the action.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
22/5/99
Parameters:
- [INPUTS]
- [OUTPUTS]
Returns:
ActionCode, one of AC_OK, AC_NO_RECORD or AC_FAIL

Errors: -

See also:
Action::Init()

Reimplemented from Action.

Definition at line 8673 of file blndtool.cpp.

08674 {
08675     ActionCode Act;
08676     Act = InvalidateBoundsAction::Init(pOperation,pOppositeActLst,m_pNode,m_IncludeChildren);
08677 
08678     return Act;
08679 }

ActionCode InvalidateBoundsAction::Init Operation pOp,
ActionList pActionList,
NodeRenderableBounded pNode,
BOOL  IncludeChildren
[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:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
20/5/99
Parameters:
pOp = ptr to the operation to which this action belongs [INPUTS] pActionList = ptr to action list to which this action should be added pNodeBlender = ptr to Node whos bounds invalidating IncludeChildren = invalidate the bounds of the children too
- [OUTPUTS]
Returns:
ActionCode, one of AC_OK, AC_NO_RECORD or AC_FAIL

Errors: -

See also:
Action::Init()

Definition at line 8635 of file blndtool.cpp.

08639 {
08640     ERROR2IF(pNode == NULL,AC_FAIL,"pNode is NULL");
08641 
08642     UINT32 ActSize = sizeof(InvalidateBoundsAction);
08643 
08644     InvalidateBoundsAction* pNewAction;
08645     ActionCode Ac = Action::Init(pOp,pActionList,ActSize,CC_RUNTIME_CLASS(InvalidateBoundsAction),(Action**)&pNewAction);
08646 
08647     if (Ac != AC_FAIL && pNewAction != NULL)
08648     {
08649         pNewAction->m_pNode            = pNode;
08650         pNewAction->m_IncludeChildren  = IncludeChildren;
08651 
08652         pNode->InvalidateBoundingRect(IncludeChildren);
08653     }
08654 
08655     return Ac;
08656 }


Member Data Documentation

BOOL InvalidateBoundsAction::m_IncludeChildren [protected]
 

Definition at line 1186 of file blndtool.h.

NodeRenderableBounded* InvalidateBoundsAction::m_pNode [protected]
 

Definition at line 1185 of file blndtool.h.


The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:55:32 2007 for Camelot by  doxygen 1.4.4