Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CP_CFDictionary< TKey, TValue > Class Template Reference

A class to handle a MacOS CFDictionary.

Inheritance diagram for CP_CFDictionary< TKey, TValue >:

CP_CFMutableObject< CFDictionaryRef, CFMutableDictionaryRef > CP_CFObject< CFDictionaryRef > List of all members.

Public Member Functions

CFMutableDictionaryRef GetMutableCFRef ()
 operator TMutableCFRef ()
void AttachRefMutable (CFMutableDictionaryRefinMutableRef, bool inRetain)
void AttachRef (CFDictionaryRefinRef, bool inRetain)
CFMutableDictionaryRef DetachRefMutable ()
CFDictionaryRef DetachRef ()
CFDictionaryRef GetCFRef () const
bool IsValid () const
Constructor / Destructor
 CP_CFDictionary ()
 Constructor.
 CP_CFDictionary (const CP_CFDictionary &inOriginal)
 CP_CFDictionary (const TKey *inKeys, const TValue *inValues, CFIndex inItemCount, const CFDictionaryKeyCallBacks *inKeyCallBacks=NULL, const CFDictionaryValueCallBacks *inValueCallBacks=NULL, CFAllocatorRef inAllocator=NULL)
virtual ~CP_CFDictionary () throw ()
 Destructor.

Protected Member Functions

void MakeMutable ()
CFMutableDictionaryRef MutableCopy (CFDictionaryRefinCFRef)

Protected Attributes

CFDictionaryRef fCFObject

Private Types

typedef CP_CFMutableObject<
CFDictionaryRef, CFMutableDictionaryRef > 
T_Base

template<class TKey, class TValue>
class CP_CFDictionary< TKey, TValue >


Member Typedef Documentation

template<class TKey, class TValue>
typedef CP_CFMutableObject<CFDictionaryRef, CFMutableDictionaryRef> CP_CFDictionary< TKey, TValue >::T_Base [private]
 

Reimplemented from CP_CFMutableObject< CFDictionaryRef, CFMutableDictionaryRef >.


Constructor & Destructor Documentation

template<class TKey, class TValue>
CP_CFDictionary< TKey, TValue >::CP_CFDictionary  ) 
 

Constructor.

Exceptions:
none 

template<class TKey, class TValue>
CP_CFDictionary< TKey, TValue >::CP_CFDictionary const CP_CFDictionary< TKey, TValue > &  inOriginal  ) 
 

Copy constructor.

Parameters:
inOriginal The original CP_CFDictionary to copy the fields from.
Exceptions:
none 

template<class TKey, class TValue>
CP_CFDictionary< TKey, TValue >::CP_CFDictionary const TKey *  inKeys,
const TValue *  inValues,
CFIndex  inItemCount,
const CFDictionaryKeyCallBacks *  inKeyCallBacks = NULL,
const CFDictionaryValueCallBacks *  inValueCallBacks = NULL,
CFAllocatorRef  inAllocator = NULL
 

Copy constructor.

Parameters:
inKeys List of keys for the dictionary items.
inValues List of values for the dictionary items.
inItemCount Number of items passed in.
inKeyCallBacks Dictionarykey callback for the keys.
inValueCallBacks Dictionarykey callback for the values.
inAllocator Allocator for the items in the dictionary.
Exceptions:
none 

template<class TKey, class TValue>
CP_CFDictionary< TKey, TValue >::~CP_CFDictionary  )  throw () [virtual]
 

Destructor.

Exceptions:
none 


Member Function Documentation

CFMutableDictionaryRef CP_CFMutableObject< CFDictionaryRef , CFMutableDictionaryRef >::GetMutableCFRef  )  [inherited]
 

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 

CP_CFMutableObject< CFDictionaryRef , CFMutableDictionaryRef >::operator CFMutableDictionaryRef  )  [inherited]
 

operator TMutableCFRef to return the mutable CFRef object for this class.

Exceptions:
none 
Returns:
CFMutableCFRef The mutable CFRef object for ths class.

void CP_CFMutableObject< CFDictionaryRef , CFMutableDictionaryRef >::AttachRefMutable CFMutableDictionaryRef   inMutableRef,
bool  inRetain
[inherited]
 

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 

void CP_CFMutableObject< CFDictionaryRef , CFMutableDictionaryRef >::AttachRef CFDictionaryRef   inRef,
bool  inRetain
[inherited]
 

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< CFDictionaryRef >.

CFMutableDictionaryRef CP_CFMutableObject< CFDictionaryRef , CFMutableDictionaryRef >::DetachRefMutable  )  [inherited]
 

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

Exceptions:
none 

void CP_CFMutableObject< CFDictionaryRef , CFMutableDictionaryRef >::MakeMutable  )  [protected, inherited]
 

Turns this object we are storing into a mutable version.

Exceptions:
none 

CFMutableDictionaryRef CP_CFMutableObject< CFDictionaryRef , CFMutableDictionaryRef >::MutableCopy CFDictionaryRef   inCFRef  )  [protected, inherited]
 

CFDictionaryRef CP_CFObject< CFDictionaryRef >::DetachRef  )  [inherited]
 

CFDictionaryRef CP_CFObject< CFDictionaryRef >::GetCFRef  )  const [inherited]
 

bool CP_CFObject< CFDictionaryRef >::IsValid  )  const [inherited]
 


Member Data Documentation

CFDictionaryRef CP_CFObject< CFDictionaryRef >::fCFObject [protected, inherited]
 


The documentation for this class was generated from the following file:
Generated on Sat Sep 17 20:01:24 2005 for CPLAT by  doxygen 1.4.0