CP_CFMutableObject< TCFRef, TMutableCFRef > Class Template Reference

A class to handle a MacOS CFMutableObject.

Inheritance diagram for CP_CFMutableObject< TCFRef, TMutableCFRef >:

List of all members.

Public Member Functions
TCFRef	DetachRef ()
TCFRef	GetCFRef () const
bool	IsValid () const
Getters
TMutableCFRef	GetMutableCFRef ()
	operator TMutableCFRef ()
Reference
void	AttachRefMutable (TMutableCFRef inMutableRef, bool inRetain)
void	AttachRef (TCFRef inRef, bool inRetain)
TMutableCFRef	DetachRefMutable ()
Protected Member Functions
Constructor / Destructor
	CP_CFMutableObject ()
	Constructor.
	CP_CFMutableObject (TCFRef inCFRef, bool inRetain)
	CP_CFMutableObject (TMutableCFRef inCFRef, bool inRetain)
	CP_CFMutableObject (const CP_CFMutableObject &inMutableObject)
virtual	~CP_CFMutableObject () throw ()
	Destructor.
Mutable
void	MakeMutable ()
TMutableCFRef	MutableCopy (TCFRef inCFRef)
Protected Attributes
TCFRef	fCFObject
Private Types
typedef CP_CFObject< TCFRef >	T_Base
Private Attributes
bool	fIsMutable

template<typename TCFRef, typename TMutableCFRef>
class CP_CFMutableObject< TCFRef, TMutableCFRef >

---

Member Typedef Documentation

template<typename TCFRef, typename TMutableCFRef> typedef CP_CFObject<TCFRef> CP_CFMutableObject< TCFRef, TMutableCFRef >::T_Base [private]

Reimplemented in CP_CFDictionary< TKey, TValue >.

---

Constructor & Destructor Documentation

template<typename TCFRef, typename TMutableCFRef> CP_CFMutableObject< TCFRef, TMutableCFRef >::CP_CFMutableObject (   )  [protected]

Constructor. Exceptions: none

template<typename TCFRef, typename TMutableCFRef> CP_CFMutableObject< TCFRef, TMutableCFRef >::CP_CFMutableObject (  TCFRef  inRef, bool  inRetain )  [protected]

Constructor. Parameters: inRef  The CFRef we are storing in this class. inRetain  Flag to indicate if we retain the reference. Exceptions: none

template<typename TCFRef, typename TMutableCFRef> CP_CFMutableObject< TCFRef, TMutableCFRef >::CP_CFMutableObject (  TMutableCFRef  inRef, bool  inRetain )  [protected]

Constructor. Parameters: inRef  The CFMutableRef we are storing in this class. inRetain  Flag to indicate if we retain the reference. Exceptions: none

template<typename TCFRef, typename TMutableCFRef> CP_CFMutableObject< TCFRef, TMutableCFRef >::CP_CFMutableObject (  const CP_CFMutableObject< TCFRef, TMutableCFRef > &  inObject  )  [protected]

Constructor. Parameters: inObject  Object to copy the fields from. Exceptions: none

template<typename TCFRef, typename TMutableCFRef> CP_CFMutableObject< TCFRef, TMutableCFRef >::~CP_CFMutableObject (   )  throw () [protected, virtual]

Destructor. Exceptions: none

---

Member Function Documentation

template<typename TCFRef, typename TMutableCFRef> TMutableCFRef CP_CFMutableObject< TCFRef, TMutableCFRef >::GetMutableCFRef (   )

Returns a mutable CFRef for this object. If the object is not mutable already, then it is first made mutable before returning the CFRef. Exceptions: none

template<typename TCFRef, typename TMutableCFRef> CP_CFMutableObject< TCFRef, TMutableCFRef >::operator TMutableCFRef (   )

operator TMutableCFRef to return the mutable CFRef object for this class. Exceptions: none  Returns: CFMutableCFRef The mutable CFRef object for ths class.

template<typename TCFRef, typename TMutableCFRef> void CP_CFMutableObject< TCFRef, TMutableCFRef >::AttachRefMutable (  TMutableCFRef  inMutableRef, bool  inRetain )

Attach a reference to the passed in CFRef. Parameters: inMutableRef  The mutable ref object to attach the reference to. inRetain  Flag to indicate if we retain this object. Exceptions: none

template<typename TCFRef, typename TMutableCFRef> void CP_CFMutableObject< TCFRef, TMutableCFRef >::AttachRef (  TCFRef  refToAttach, bool  inRetain )

Attach a reference to the passed in CFRef. Parameters: refToAttach  The object to attach the reference to. inRetain  Flag to indicate if we retain this object. Exceptions: none  Reimplemented from CP_CFObject< TCFRef >.

template<typename TCFRef, typename TMutableCFRef> TMutableCFRef CP_CFMutableObject< TCFRef, TMutableCFRef >::DetachRefMutable (   )

Detach a reference to the CFRef maintained by this object. If the object is not mutable, it is first made mutable. Exceptions: none

template<typename TCFRef, typename TMutableCFRef> void CP_CFMutableObject< TCFRef, TMutableCFRef >::MakeMutable (   )  [protected]

Turns this object we are storing into a mutable version. Exceptions: none

template<typename TCFRef, typename TMutableCFRef> TMutableCFRef CP_CFMutableObject< TCFRef, TMutableCFRef >::MutableCopy (  TCFRef  inCFRef  )  [protected]

template<typename TCFRef> TCFRef CP_CFObject< TCFRef >::DetachRef (   )  [inherited]

template<typename TCFRef> TCFRef CP_CFObject< TCFRef >::GetCFRef (   )  const [inherited]

template<typename TCFRef> bool CP_CFObject< TCFRef >::IsValid (   )  const [inherited]

---

Member Data Documentation

template<typename TCFRef, typename TMutableCFRef> bool CP_CFMutableObject< TCFRef, TMutableCFRef >::fIsMutable [private]

template<typename TCFRef> TCFRef CP_CFObject< TCFRef >::fCFObject [protected, inherited]

---

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

• CP_CFMutableObject.h

---