ObjChangeParam Class Reference

Provides a derivable structure for passing to a nodes OnChildChange virtual function. To create this class parameter simply call Define with the necessary change variables. More...

#include <objchge.h>

Inheritance diagram for ObjChangeParam:

CCObject SimpleCCObject ObjChangeParamWithToken ObjChangePathEdit List of all members.

Public Member Functions

 ObjChangeParam ()
 Constructor for the ObjChangeParam class.
 ObjChangeParam (ObjChangeType cType, ObjChangeFlags cFlags, Node *cNode, UndoableOperation *cOp, ObjChangeDirection=OBJCHANGE_CALLEDBYOP, Node *pCallingChild=NULL)
 Initialises an ObjChange parameter block.
 ~ObjChangeParam ()
 Destructor for the ObjChangeParam class.
void Define (ObjChangeType, ObjChangeFlags, Node *, UndoableOperation *, ObjChangeDirection direction=OBJCHANGE_CALLEDBYOP, Node *pCallingChild=NULL)
 Initialises an ObjChange parameter block.
ObjChangeType GetChangeType () const
ObjChangeFlags GetChangeFlags () const
UndoableOperationGetOpPointer () const
NodeGetChangeObj () const
ObjChangeDirection GetDirection () const
void SetDirection (ObjChangeDirection direction)
void SetReasonForDenial (UINT32 IDS)
UINT32 GetReasonForDenial ()
ObjChangeFlagsGetSettableChangeFlags ()
void SetCallingChild (Node *pCallingChild)
NodeGetCallingChild ()
void SetRetainCachedData (BOOL bNewValue)
BOOL GetRetainCachedData () const

Public Attributes

ObjChangeMask ChangeMask

Protected Attributes

ObjChangeType ChangeType
ObjChangeFlags ChangeFlags
ObjChangeDirection ChangeDirection
UndoableOperationpChangeOp
NodepChangeNode
UINT32 DenialReason
Nodem_pCallingChild
BOOL m_bRetainCachedData

Detailed Description

Provides a derivable structure for passing to a nodes OnChildChange virtual function. To create this class parameter simply call Define with the necessary change variables.

Author:
Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com> Date: 09/01/95
See also:
ObjChangeType, ObjChangeFlags

Definition at line 226 of file objchge.h.


Constructor & Destructor Documentation

ObjChangeParam::ObjChangeParam  ) 
 

Constructor for the ObjChangeParam class.

Author:
Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
Date:
09/01/95

Definition at line 225 of file objchge.cpp.

ObjChangeParam::ObjChangeParam ObjChangeType  cType,
ObjChangeFlags  cFlags,
Node cNode,
UndoableOperation cOp,
ObjChangeDirection  direction = OBJCHANGE_CALLEDBYOP,
Node pCallingChild = NULL
 

Initialises an ObjChange parameter block.

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
7/2/95
Parameters:
cType = a change type [INPUTS] cFlags = change flags cNode = a pointer to the node thats changing cOp = a pointer to the current operation (NULL if the change is occuring in a none undoable way) direction = direction in which the AllowOp is being called pCallingChild = the node calling the AllowOp, if OBJCHANGE_CALLEDBYCHILD set.

Definition at line 259 of file objchge.cpp.

00265 {
00266     DenialReason = 0;
00267     Define(cType,cFlags,cNode,cOp,direction,pCallingChild);
00268 }

ObjChangeParam::~ObjChangeParam  ) 
 

Destructor for the ObjChangeParam class.

Author:
Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
Date:
09/01/95

Definition at line 282 of file objchge.cpp.

00283 {
00284 }


Member Function Documentation

void ObjChangeParam::Define ObjChangeType  cType,
ObjChangeFlags  cFlags,
Node cNode,
UndoableOperation cOp,
ObjChangeDirection  direction = OBJCHANGE_CALLEDBYOP,
Node pCallingChild = NULL
 

Initialises an ObjChange parameter block.

Author:
Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
Date:
09/01/95
Parameters:
cType = a change type [INPUTS] cFlags = change flags cNode = a pointer to the node thats changing cOp = a pointer to the current operation (NULL if the change is occuring in a none undoable way) direction = direction in which AllowOp is called pCallingChild = the node calling the AllowOp, if OBJCHANGE_CALLEDBYCHILD set.
Returns:
-

Definition at line 310 of file objchge.cpp.

00316 {
00317     ERROR3IF(cType==OBJCHANGE_UNDEFINED,"ObjChangeParam::Define() called with an illegal change type");
00318     //ERROR3IF(cNode==NULL,"ObjChangeParam::Define() called with a null child node pointer");
00319 
00320     // Now set the internal variables
00321     ChangeType          = cType;
00322     ChangeFlags         = cFlags;
00323     pChangeOp           = cOp;
00324     pChangeNode         = cNode;
00325     ChangeDirection     = direction;
00326     m_pCallingChild     = pCallingChild;
00327     m_bRetainCachedData = FALSE;
00328 }

Node* ObjChangeParam::GetCallingChild  )  [inline]
 

Definition at line 251 of file objchge.h.

00251 { return m_pCallingChild; }

ObjChangeFlags ObjChangeParam::GetChangeFlags  )  const [inline]
 

Definition at line 240 of file objchge.h.

00240 { return ChangeFlags; }

Node* ObjChangeParam::GetChangeObj  )  const [inline]
 

Definition at line 242 of file objchge.h.

00242 { return pChangeNode; }

ObjChangeType ObjChangeParam::GetChangeType  )  const [inline]
 

Definition at line 239 of file objchge.h.

00239 { return ChangeType; }

ObjChangeDirection ObjChangeParam::GetDirection  )  const [inline]
 

Definition at line 243 of file objchge.h.

00243 { return ChangeDirection; }

UndoableOperation* ObjChangeParam::GetOpPointer  )  const [inline]
 

Definition at line 241 of file objchge.h.

00241 { return pChangeOp; }

UINT32 ObjChangeParam::GetReasonForDenial  )  [inline]
 

Definition at line 247 of file objchge.h.

00247 { return DenialReason; }

BOOL ObjChangeParam::GetRetainCachedData  )  const [inline]
 

Definition at line 254 of file objchge.h.

00254 {return m_bRetainCachedData;}

ObjChangeFlags* ObjChangeParam::GetSettableChangeFlags  )  [inline]
 

Definition at line 248 of file objchge.h.

00248 { return &ChangeFlags; }

void ObjChangeParam::SetCallingChild Node pCallingChild  )  [inline]
 

Definition at line 250 of file objchge.h.

00250 { m_pCallingChild = pCallingChild; }

void ObjChangeParam::SetDirection ObjChangeDirection  direction  )  [inline]
 

Definition at line 244 of file objchge.h.

00244 { ChangeDirection=direction; }

void ObjChangeParam::SetReasonForDenial UINT32  IDS  )  [inline]
 

Definition at line 246 of file objchge.h.

00246 { DenialReason = IDS; }

void ObjChangeParam::SetRetainCachedData BOOL  bNewValue  )  [inline]
 

Definition at line 253 of file objchge.h.

00253 {m_bRetainCachedData = bNewValue;}


Member Data Documentation

ObjChangeDirection ObjChangeParam::ChangeDirection [protected]
 

Definition at line 262 of file objchge.h.

ObjChangeFlags ObjChangeParam::ChangeFlags [protected]
 

Definition at line 261 of file objchge.h.

ObjChangeMask ObjChangeParam::ChangeMask
 

Definition at line 257 of file objchge.h.

ObjChangeType ObjChangeParam::ChangeType [protected]
 

Definition at line 260 of file objchge.h.

UINT32 ObjChangeParam::DenialReason [protected]
 

Definition at line 265 of file objchge.h.

BOOL ObjChangeParam::m_bRetainCachedData [protected]
 

Definition at line 267 of file objchge.h.

Node* ObjChangeParam::m_pCallingChild [protected]
 

Definition at line 266 of file objchge.h.

Node* ObjChangeParam::pChangeNode [protected]
 

Definition at line 264 of file objchge.h.

UndoableOperation* ObjChangeParam::pChangeOp [protected]
 

Definition at line 263 of file objchge.h.


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