CP_M_Persist Class Reference

Mix-in class for objects that need to be able to be read and written to and from an XML file.

Inheritance diagram for CP_M_Persist:

List of all members.

Initialization
virtual void	OnInitPersist (CP_View *inSuperview, CP_DataValueList &inDataValueList)
virtual void	OnFinishPersist ()
Public Member Functions
void	SetID (FourCharCode inIdentifier)
FourCharCode	GetID ()
void	RegisterSignal (const CP_SignalHolder &inSignal)
CP_DataValueSignal *	FindSignal (const CP_String &inSignalName)
UInt32	GetNumberSignals ()
CP_String	GetNthSignalName (UInt32 inSignalIndex)
void	RegisterSlot (const CP_SlotHolder &inSlot)
CP_DataValueSlot	FindSlot (const CP_String &inSlotName)
UInt32	GetNumberSlots ()
CP_String	GetNthSlotName (UInt32 inSlotIndex)
template<class R, class P1, class P2>
CP_CommandHandlerSignal *	Connect (CPLAT::CP_CommandNo cmd, void(R::*handler)(P1, P2), SInt32 mode)
template<class R, class P1, class P2>
void	Connect (CP_Object *control, const CPLAT::CP_String &signalName, void(R::*handler)(P1, P2))
Constructor / Destructor
virtual	~CP_M_Persist ()
	Destructor.
Static Public Member Functions
static void	Connect (CP_Object *sender, const CP_String &signalName, CP_Object *receiver, const CP_String &slotName, const bool reciprocal=false)
static void	Connect (CP_Object *sender, CP_Object *receiver, const bool reciprocal=false, const CP_String &signalName=kCP_Signal_ValueChanged, const CP_String &slotName=kCP_Slot_SetValue)
Protected Member Functions
Constructor / Destructor
	CP_M_Persist ()
	Constructor.
Protected Attributes
CP_Signals_Array *	fSignals
CP_Slots_Array *	fSlots
FourCharCode	fObjectID
Static Protected Attributes
static FourCharCode	fObjectIDCount = 0

---

Constructor & Destructor Documentation

CP_M_Persist::~CP_M_Persist (   )  [virtual]

Destructor. Exceptions: none

CPLAT_Begin_Namespace_CPLAT CP_M_Persist::CP_M_Persist (   )  [protected]

Constructor. Exceptions: none

---

Member Function Documentation

void CP_M_Persist::InitPersist (  CP_View *  inSuperview, CP_DataValueList &  inDataValueList )

Finish initializing our object. Calls OnInitPersist to do the actual work. Parameters: inSuperview  The CP_View that contains this object. inDataValueList  List of data values used to construct this object. Exceptions: none  Returns: void

void CP_M_Persist::FinishPersist (   )

Called when we have constructed our persist objects and are now giving each one a chance to finish up. Calls OnFinishPersist to do the actual work. Exceptions: none  Returns: void

void CP_M_Persist::OnInitPersist (  CP_View *  inSuperview, CP_DataValueList &  inDataValueList )  [protected, virtual]

Finish initializing our object. Called from InitPersist. This is the method to override to initialize your object. Parameters: inSuperview  The CP_View that contains this object. inDataValueList  List of data values used to construct this object. Exceptions: none  Returns: void Reimplemented in CP_BevelButton, CP_ChasingArrows, CP_CheckBox, CP_CheckGroupBox, CP_Clock, CP_DisclosureButton, CP_DisclosureTriangle, CP_EditField, CP_FocusBorder, CP_IconControl, CP_ImageWell, CP_LittleArrows, CP_LittleArrowsEditBuddy, CP_OpenGLView, CP_PictureControl, CP_Placard, CP_PopupArrow, CP_PopupGroupBox, CP_PopupMenu, CP_ProgressBar, CP_PushButton, CP_QT_MovieView, CP_RadioButton, CP_RadioGroup, CP_Relevance, CP_RoundButton, CP_ScrollableView, CP_ScrollBar, CP_Scroller, CP_SearchField, CP_SegmentView, CP_SelectColorButton, CP_Separator, CP_Slider, CP_Splitter, CP_StaticText, CP_TabGroup, CP_TableHeaders, CP_TableView, CP_TabView, CP_TextGroupBox, CP_TextView, CP_TV_DataBrowser, CP_TV_TextColumn, CP_View, CP_ViewBackground, CP_ViewBackground_White, CP_Window, CP_WindowHeader, and CP_WindowListHeader.

virtual void CP_M_Persist::OnFinishPersist (   )  [protected, virtual]

Override this do the actual finishing up of initializing the persist object. This is called after all of the other objects have been created. Exceptions: none  Returns: void Reimplemented in CP_TabView, and CP_View.

void CP_Object::SetID (  FourCharCode  inIdentifier  )  [inherited]

Sets the identifier for this object. If a specific identifier is not set with this function, then a default id is used, which is simply a running count of the number of objects created. Parameters: inIdentifier  The objects identifier. Returns: void

FourCharCode CP_Object::GetID (   )  [inherited]

Returns the objects identifier. Returns: FourCharCode The identifier of this object.

void CP_Object::RegisterSignal (  const CP_SignalHolder &  inSignal  )  [inherited]

Registers the signal / signal name contained in the passed in inSignal object. Parameters: inSignal  CP_SignalHolder that holds a signal and string identifier. Returns: void

CP_DataValueSignal * CP_Object::FindSignal (  const CP_String &  inSignalName  )  [inherited]

Finds the CP_DataValueSignal object that matches the passed in inSignalName. Parameters: inSignalName  CP_String containing the identifier of the signal to return. Returns: CP_DataValueSignal * Returns a pointer to a CP_DataValueSignal object.

UInt32 CP_Object::GetNumberSignals (   )  [inherited]

Returns the number of signals for this object. Returns: UInt32 The number of signals.

CP_String CP_Object::GetNthSignalName (  UInt32  inSignalIndex  )  [inherited]

Returns the signal name of the passed in signal index. Parameters: inSignalIndex  Index of the name of the signal to return. Returns: CP_String The name of the nth signal being returned.

void CP_Object::RegisterSlot (  const CP_SlotHolder &  inSlot  )  [inherited]

Registers the slot / slot name contained in the passed in inSlot object. Parameters: inSlot  CP_SignalHolder that holds a slot and string identifier. Returns: void

CP_DataValueSlot CP_Object::FindSlot (  const CP_String &  inSlotName  )  [inherited]

Finds the CP_Slot1 object that matches the passed in inSlotName. Parameters: inSlotName  CP_String containing the identifier of the slot to return. Returns: CP_DataValueSlot Returns a pointer to a CP_DataValueSlot object.

UInt32 CP_Object::GetNumberSlots (   )  [inherited]

Returns the number of slots for this object. Returns: UInt32 The number of slots.

CP_String CP_Object::GetNthSlotName (  UInt32  inSlotIndex  )  [inherited]

Returns the slot name of the passed in signal index. Parameters: inSlotIndex  Index of the name of the slot to return. Returns: CP_String The name of the nth slot being returned.

template<class R, class P1, class P2> CP_CommandHandlerSignal* CP_Object::Connect (  CPLAT::CP_CommandNo  cmd, void(R::*)(P1, P2)  handler, SInt32  mode )  [inherited]

template<class R, class P1, class P2> void CP_Object::Connect (  CP_Object *  control, const CPLAT::CP_String &  signalName, void(R::*)(P1, P2)  handler )  [inherited]

void CP_Object::Connect (  CP_Object *  sender, const CP_String &  signalName, CP_Object *  receiver, const CP_String &  slotName, const bool  reciprocal = false )  [static, inherited]

void CP_Object::Connect (  CP_Object *  sender, CP_Object *  receiver, const bool  reciprocal = false, const CP_String &  signalName = kCP_Signal_ValueChanged, const CP_String &  slotName = kCP_Slot_SetValue )  [static, inherited]

---

Member Data Documentation

CP_Signals_Array* CP_Object::fSignals [protected, inherited]

CP_Slots_Array* CP_Object::fSlots [protected, inherited]

List of registered signals for this object.

FourCharCode CP_Object::fObjectID [protected, inherited]

List of registered slots for this object.

CPLAT_Begin_Namespace_CPLAT FourCharCode CP_Object::fObjectIDCount = 0 [static, protected, inherited]

Object identifier.

---

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

• CP_M_Persist.h
• CP_M_Persist.cpp

---