Dictionary is a class like NSDictionary in Obj-C . More...

#include <CCDictionary.h>

Inheritance diagram for __Dictionary:

Public Member Functions
	__Dictionary ()
	The constructor of Dictionary. More...

	~__Dictionary ()
	The destructor of Dictionary. More...

bool	init ()
	Initializes the dictionary. More...

unsigned int	count ()
	Get the count of elements in Dictionary. More...

local	count ()
	Get the count of elements in Dictionary. More...

__Array *	allKeys ()
	Return all keys of elements. More...

__Array *	allKeysForObject (Ref *object)
	Get all keys according to the specified object. More...

local	allKeysForObject ( local object)
	Get all keys according to the specified object. More...

Ref *	objectForKey (const std::string &key)
	Get the object according to the specified string key. More...

Ref *	objectForKey (intptr_t key)
	Get the object according to the specified integer key. More...

const __String *	valueForKey (const std::string &key)
	Get the value according to the specified string key. More...

local	valueForKey ( local key)
	Get the value according to the specified string key. More...

const __String *	valueForKey (intptr_t key)
	Get the value according to the specified integer key. More...

local	valueForKey ( local key)
	Get the value according to the specified integer key. More...

void	setObject (Ref *pObject, const std::string &key)
	Insert an object to dictionary, and match it with the specified string key. More...

void	setObject (Ref *pObject, intptr_t key)
	Insert an object to dictionary, and match it with the specified string key. More...

void	removeObjectForKey (const std::string &key)
	Remove an object by the specified string key. More...

void	removeObjectForKey (intptr_t key)
	Remove an object by the specified integer key. More...

void	removeObjectsForKeys (__Array *pKey__Array)
	Remove objects by an array of keys. More...

void	removeObjectForElememt (DictElement *pElement)
	Remove an object by an element. More...

void	removeAllObjects ()
	Remove all objects in the dictionary. More...

Ref *	randomObject ()
	Return a random object in the dictionary. More...

bool	writeToFile (const char *fullPath)
	Write a dictionary to a plist file. More...

virtual void	acceptVisitor (DataVisitor &visitor)
virtual __Dictionary *	clone () const
	returns a copy of the Ref More...

Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...

void	release ()
	Release the ownership immediately. More...

Ref *	autorelease ()
	Release the ownership sometime soon automatically. More...

unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...

virtual	~Ref ()
Public Member Functions inherited from Clonable
virtual	~Clonable ()
Ref *	copy () const
	returns a copy of the Ref. More...

var	copy ()
	returns a copy of the Ref. More...

local	copy ()
	returns a copy of the Ref. More...

Static Public Member Functions
static __Dictionary *	create ()
	Create a dictionary. More...

static __Dictionary *	createWithDictionary (__Dictionary *srcDict)
	Create a dictionary with an existing dictionary. More...

local	createWithDictionary ( local srcDict)
	Create a dictionary with an existing dictionary. More...

static __Dictionary *	createWithContentsOfFile (const char *pFileName)
	Create a dictionary with a plist file. More...

static __Dictionary *	createWithContentsOfFileThreadSafe (const char *pFileName)
	Create a dictionary with a plist file. More...

Public Attributes
DictElement *	_elements
	All the elements in dictionary. More...

Additional Inherited Members
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...

Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...

Detailed Description

Dictionary is a class like NSDictionary in Obj-C .

Note: Only the pointer of Object or its subclass can be inserted to Dictionary.
// Create a dictionary, return an autorelease object.

Dictionary* pDict = Dictionary::create();

// Insert objects to dictionary

String* pValue1 = String::create("100");

String* pValue2 = String::create("120");

Integer* pValue3 = Integer::create(200);

pDict->setObject(pValue1, "key1");

pDict->setObject(pValue2, "key2");

pDict->setObject(pValue3, "key3");

// Get the object for key

String* pStr1 = static_cast<String*>(pDict->objectForKey("key1"));

log("{ key1: %s }", pStr1->getCString());

Integer* pInteger = static_cast<Integer*>(pDict->objectForKey("key3"));

log("{ key3: %d }", pInteger->getValue());

Constructor & Destructor Documentation

__Dictionary ( )

The constructor of Dictionary.

~__Dictionary ( )

The destructor of Dictionary.

Member Function Documentation

virtual void acceptVisitor ( DataVisitor & visitor)

virtual

var acceptVisitor ( var visitor)

virtual

local acceptVisitor ( local visitor)

virtual

__Array* allKeys ( )

Return all keys of elements.

Returns: The array contains all keys of elements. It's an autorelease object yet.

local allKeys ( )

Return all keys of elements.

Returns: The array contains all keys of elements. It's an autorelease object yet.

__Array* allKeysForObject ( Ref * object)

Get all keys according to the specified object.

Warning: We use '==' to compare two objects

Returns: The array contains all keys for the specified object. It's an autorelease object yet.

local allKeysForObject ( local object)

Get all keys according to the specified object.

Warning: We use '==' to compare two objects

Returns: The array contains all keys for the specified object. It's an autorelease object yet.

virtual __Dictionary* clone ( ) const

virtual

returns a copy of the Ref

Implements Clonable.

unsigned int count ( )

Get the count of elements in Dictionary.

Returns: The count of elements.

local count ( )

Get the count of elements in Dictionary.

Returns: The count of elements.

static __Dictionary* create ( )

static

Create a dictionary.

Returns: A dictionary which is an autorelease object.

See Also: createWithDictionary(Dictionary*), createWithContentsOfFile(const char*), createWithContentsOfFileThreadSafe(const char*).

local create ( )

static

Create a dictionary.

Returns: A dictionary which is an autorelease object.

See Also: createWithDictionary(Dictionary*), createWithContentsOfFile(const char*), createWithContentsOfFileThreadSafe(const char*).

static __Dictionary*
createWithContentsOfFile ( const char * pFileName)

static

Create a dictionary with a plist file.

Parameters

pFileName The name of the plist file.

Returns: A dictionary which is an autorelease object.

See Also: create(), createWithDictionary(Dictionary*), createWithContentsOfFileThreadSafe(const char*).

local createWithContentsOfFile ( local pFileName)

static

Create a dictionary with a plist file.

Parameters

pFileName The name of the plist file.

Returns: A dictionary which is an autorelease object.

See Also: create(), createWithDictionary(Dictionary*), createWithContentsOfFileThreadSafe(const char*).

static __Dictionary*
createWithContentsOfFileThreadSafe ( const char * pFileName)

static

Create a dictionary with a plist file.

Note: the return object isn't an autorelease object. This can make sure not using autorelease pool in a new thread. Therefore, you need to manage the lifecycle of the return object. It means that when you don't need it, CC_SAFE_RELEASE needs to be invoked.

Parameters

pFileName The name of the plist file.

Returns: A dictionary which isn't an autorelease object.

static __Dictionary*
createWithDictionary ( __Dictionary * srcDict)

static

Create a dictionary with an existing dictionary.

Parameters

srcDict The exist dictionary.

Returns: A dictionary which is an autorelease object.

See Also: create(), createWithContentsOfFile(const char*), createWithContentsOfFileThreadSafe(const char*).

local createWithDictionary ( local srcDict)

static

Create a dictionary with an existing dictionary.

Parameters

srcDict The exist dictionary.

Returns: A dictionary which is an autorelease object.

See Also: create(), createWithContentsOfFile(const char*), createWithContentsOfFileThreadSafe(const char*).

bool init ( )

Initializes the dictionary.

It returns true if the initializations was successful.

Ref* objectForKey ( const std::string & key)

Get the object according to the specified string key.

Note: The dictionary needs to use string as key. If integer is passed, an assert will appear.

Parameters

key	The string key for searching.

Returns: The object matches the key. You need to force convert it to the type you know.
// Assume that the elements are String* pointers. Convert it by following code.

String* pStr = static_cast<String*>(pDict->objectForKey("key1"));

// Do something about pStr.

// If you don't know the object type, properly you need to use dynamic_cast<SomeType*> to check it.

String* pStr2 = dynamic_cast<String*>(pDict->objectForKey("key1"));

if (pStr2 != NULL) {

// Do something about pStr2

}

See Also: objectForKey(intptr_t)

local objectForKey ( local key)

Get the object according to the specified string key.

Note: The dictionary needs to use string as key. If integer is passed, an assert will appear.

Parameters

key	The string key for searching.

Returns: The object matches the key. You need to force convert it to the type you know.
// Assume that the elements are String* pointers. Convert it by following code.

String* pStr = static_cast<String*>(pDict->objectForKey("key1"));

// Do something about pStr.

// If you don't know the object type, properly you need to use dynamic_cast<SomeType*> to check it.

String* pStr2 = dynamic_cast<String*>(pDict->objectForKey("key1"));

if (pStr2 != NULL) {

// Do something about pStr2

}

See Also: objectForKey(intptr_t)

Ref* objectForKey ( intptr_t key)

Get the object according to the specified integer key.

Note: The dictionary needs to use integer as key. If string is passed, an assert will appear.

Parameters

key	The integer key for searching.

Returns: The object matches the key.

See Also: objectForKey(const std::string&)

local objectForKey ( local key)

Get the object according to the specified integer key.

Note: The dictionary needs to use integer as key. If string is passed, an assert will appear.

Parameters

key	The integer key for searching.

Returns: The object matches the key.

See Also: objectForKey(const std::string&)

Ref* randomObject ( )

Return a random object in the dictionary.

Returns: The random object.

See Also: objectForKey(intptr_t), objectForKey(const std::string&)

void removeAllObjects ( )

Remove all objects in the dictionary.

See Also: removeObjectForKey(const std::string&), removeObjectForKey(intptr_t), removeObjectsForKeys(__Array*), removeObjectForElememt(DictElement*).

local removeAllObjects ( )

Remove all objects in the dictionary.

See Also: removeObjectForKey(const std::string&), removeObjectForKey(intptr_t), removeObjectsForKeys(__Array*), removeObjectForElememt(DictElement*).

void removeObjectForElememt ( DictElement * pElement)

Remove an object by an element.

Parameters

pElement The element need to be removed.

See Also: removeObjectForKey(const std::string&), removeObjectForKey(intptr_t), removeObjectsForKeys(__Array*), removeAllObjects().

void removeObjectForKey ( const std::string & key)

Remove an object by the specified string key.

Parameters

key	The string key for searching.

See Also: removeObjectForKey(intptr_t), removeObjectsForKeys(__Array*), removeObjectForElememt(DictElement*), removeAllObjects().

local removeObjectForKey ( local key)

Remove an object by the specified string key.

Parameters

key	The string key for searching.

See Also: removeObjectForKey(intptr_t), removeObjectsForKeys(__Array*), removeObjectForElememt(DictElement*), removeAllObjects().

void removeObjectForKey ( intptr_t key)

Remove an object by the specified integer key.

Parameters

key	The integer key for searching.

See Also: removeObjectForKey(const std::string&), removeObjectsForKeys(__Array*), removeObjectForElememt(DictElement*), removeAllObjects().

local removeObjectForKey ( local key)

Remove an object by the specified integer key.

Parameters

key	The integer key for searching.

See Also: removeObjectForKey(const std::string&), removeObjectsForKeys(__Array*), removeObjectForElememt(DictElement*), removeAllObjects().

void removeObjectsForKeys ( __Array * pKey__Array)

Remove objects by an array of keys.

Parameters

pKeyArray The array contains keys to be removed.

See Also: removeObjectForKey(const std::string&), removeObjectForKey(intptr_t), removeObjectForElememt(DictElement*), removeAllObjects().

local removeObjectsForKeys ( local pKey__Array)

Remove objects by an array of keys.

Parameters

pKeyArray The array contains keys to be removed.

See Also: removeObjectForKey(const std::string&), removeObjectForKey(intptr_t), removeObjectForElememt(DictElement*), removeAllObjects().

void setObject	(	Ref *	pObject,
		const std::string &	key
	)

Insert an object to dictionary, and match it with the specified string key.

Note: Whe the first time this method is invoked, the key type will be set to string. After that you can't setObject with an integer key. If the dictionary contains the key you passed, the object matching the key will be released and removed from dictionary. Then the new object will be inserted after that.

Parameters

pObject	The Object to be inserted.
key	The string key for searching.

See Also: setObject(Ref*, intptr_t)

local setObject	(	local	pObject,
		local	key
	)

Insert an object to dictionary, and match it with the specified string key.

Note: Whe the first time this method is invoked, the key type will be set to string. After that you can't setObject with an integer key. If the dictionary contains the key you passed, the object matching the key will be released and removed from dictionary. Then the new object will be inserted after that.

Parameters

pObject	The Object to be inserted.
key	The string key for searching.

See Also: setObject(Ref*, intptr_t)

void setObject	(	Ref *	pObject,
		intptr_t	key
	)

Insert an object to dictionary, and match it with the specified string key.

Note: Then the first time this method is invoked, the key type will be set to string. After that you can't setObject with an integer key. If the dictionary contains the key you passed, the object matching the key will be released and removed from dictionary. Then the new object will be inserted after that.

Parameters

pObject	The Object to be inserted.
key	The string key for searching.

See Also: setObject(Ref*, const std::string&)

local setObject	(	local	pObject,
		local	key
	)

Insert an object to dictionary, and match it with the specified string key.

Note: Then the first time this method is invoked, the key type will be set to string. After that you can't setObject with an integer key. If the dictionary contains the key you passed, the object matching the key will be released and removed from dictionary. Then the new object will be inserted after that.

Parameters

pObject	The Object to be inserted.
key	The string key for searching.

See Also: setObject(Ref*, const std::string&)

const __String* valueForKey ( const std::string & key)

Get the value according to the specified string key.

Note: Be careful to use this function since it assumes the objects in the dictionary are __String pointer.

Parameters

key	The string key for searching

Returns: An instance of String. It will return an empty string if the objects aren't __String pointer or the key wasn't found.

See Also: valueForKey(intptr_t)

local valueForKey ( local key)

Get the value according to the specified string key.

Note: Be careful to use this function since it assumes the objects in the dictionary are __String pointer.

Parameters

key	The string key for searching

Returns: An instance of String. It will return an empty string if the objects aren't __String pointer or the key wasn't found.

See Also: valueForKey(intptr_t)

const __String* valueForKey ( intptr_t key)

Get the value according to the specified integer key.

Note: Be careful to use this function since it assumes the objects in the dictionary are __String pointer.

Parameters

key	The string key for searching.

Returns: An instance of String. It will return an empty string if the objects aren't __String pointer or the key wasn't found.

See Also: valueForKey(intptr_t)

local valueForKey ( local key)

Get the value according to the specified integer key.

Note: Be careful to use this function since it assumes the objects in the dictionary are __String pointer.

Parameters

key	The string key for searching.

Returns: An instance of String. It will return an empty string if the objects aren't __String pointer or the key wasn't found.

See Also: valueForKey(intptr_t)

bool writeToFile ( const char * fullPath)

Write a dictionary to a plist file.

Parameters

fullPath The full path of the plist file. You can get writeable path by getWritablePath()

Returns: true if successed, false if failed

Member Data Documentation

DictElement* _elements

All the elements in dictionary.

Note: For internal usage, we need to declare this member variable as public since it's used in UT_HASH.

var _elements

All the elements in dictionary.

Note: For internal usage, we need to declare this member variable as public since it's used in UT_HASH.

local _elements

All the elements in dictionary.

Note: For internal usage, we need to declare this member variable as public since it's used in UT_HASH.

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

/Users/cocos2d/MyWork/cocos2d-x-develop/cocos/base/CCDictionary.h

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation