ai::Dictionary Class Reference

#include <IAIDictionary.hpp>

List of all members.

Classes
class	DictEntryGetSet
class	Impl
class	iterator
Public Types
enum	Type { kCreateEmpty, kCurrentDocument, kCurrentDocumentNonRecorded }
Public Member Functions
	Dictionary (Type type=Type::kCreateEmpty)
	Dictionary (AIArtHandle art)
	Dictionary (AIDictionaryRef dictRef)
	~Dictionary ()
	Dictionary (const Dictionary &other)
Dictionary &	operator= (Dictionary other) AINOEXCEPT
Dictionary	clone () const
void	copy (const Dictionary &other)
ai::UnicodeString	GetUnicodeString (KeyType key) const
AIErr	GetUnicodeString (KeyType key, ai::UnicodeString &value) const AINOEXCEPT
void	SetUnicodeString (KeyType key, const ai::UnicodeString &value)
std::string	GetString (KeyType key) const
AIErr	GetString (KeyType key, std::string &value) const AINOEXCEPT
void	SetString (KeyType key, const std::string &value)
AIReal	GetReal (KeyType key) const
AIErr	GetReal (KeyType key, AIReal &value) const AINOEXCEPT
void	SetReal (KeyType key, AIReal value)
AIBoolean	GetBoolean (KeyType key) const
AIErr	GetBoolean (KeyType key, AIBoolean &value) const AINOEXCEPT
void	SetBoolean (KeyType key, AIBoolean value)
ai::int32	GetInteger (KeyType key) const
AIErr	GetInteger (KeyType key, ai::int32 &value) const AINOEXCEPT
void	SetInteger (KeyType key, ai::int32 value)
ai::intptr	GetPointer (KeyType key) const
AIErr	GetPointer (KeyType key, ai::intptr &value) const AINOEXCEPT
void	SetPointer (KeyType key, ai::intptr value)
BinaryType	GetBinary (KeyType key) const
AIErr	GetBinary (KeyType key, BinaryType &value) const AINOEXCEPT
void	SetBinary (KeyType key, const BinaryType &value)
Dictionary	GetDictionary (KeyType key) const
AIErr	GetDictionary (KeyType key, Dictionary &value) const AINOEXCEPT
void	SetDictionary (KeyType key, const Dictionary &value)
Array	GetArray (KeyType key) const
AIErr	GetArray (KeyType key, Array &value) const AINOEXCEPT
void	SetArray (KeyType key, const Array &value)
Entry	Get (KeyType key) const
void	Set (KeyType key, const Entry &entry)
DictEntryGetSet	operator[] (KeyType key)
const char *	GetKeyString (KeyType key) const
KeyType	GetKey (const char *string) const
bool	IsKnown (KeyType key) const
AIEntryType	GetEntryType (KeyType key) const
iterator	find (KeyType key)
void	erase (KeyType key)
void	TouchArt ()
AIDictionaryRef	get () const AINOEXCEPT
iterator	begin () const
iterator	end () const
void	swap (Dictionary &other) AINOEXCEPT
	Dictionary (Dictionary &&other) AINOEXCEPT
Static Public Member Functions
static void	Test ()

---

Member Enumeration Documentation

enum ai::Dictionary::Type

Enumerator:

kCreateEmpty
kCurrentDocument
kCurrentDocumentNonRecorded

---

Constructor & Destructor Documentation

ai::Dictionary::Dictionary

(

Type

type = Type::kCreateEmpty

)

[explicit]

Referenced by ai::Dictionary::Impl::clone(), and ai::Dictionary::Impl::GetDictionary().

ai::Dictionary::Dictionary

(

AIArtHandle

art

)

[explicit]

ai::Dictionary::Dictionary

(

AIDictionaryRef

dictRef

)

[explicit]

ai::Dictionary::~Dictionary

(

)

ai::Dictionary::Dictionary

(

const Dictionary &

other

)

ai::Dictionary::Dictionary

(

Dictionary &&

other

)

References swap().

---

Member Function Documentation

Dictionary::iterator ai::Dictionary::begin

(

)

const

References AIDictionaryIteratorSuite::AtEnd, AIDictionarySuite::Begin, end(), and ai::Replace().

Dictionary ai::Dictionary::clone

(

)

const

void ai::Dictionary::copy

(

const Dictionary &

other

)

Dictionary::iterator ai::Dictionary::end

(

)

const

Referenced by begin(), find(), and Test().

void ai::Dictionary::erase

(

KeyType

key

)

ai::Dictionary::iterator ai::Dictionary::find

(

KeyType

key

)

References end(), AIDictionarySuite::Find, and ai::Replace().

Referenced by Test().

AIDictionaryRef ai::Dictionary::get

(

)

const

Referenced by ai::Entry::Impl::Impl(), and ai::Dictionary::Impl::SetDictionary().

Entry ai::Dictionary::Get

(

KeyType

key

)

const

Referenced by Test().

AIErr ai::Dictionary::GetArray	(	KeyType	key,
		Array &	value
	)			const

Array ai::Dictionary::GetArray

(

KeyType

key

)

const

AIErr ai::Dictionary::GetBinary	(	KeyType	key,
		BinaryType &	value
	)			const

BinaryType ai::Dictionary::GetBinary

(

KeyType

key

)

const

Referenced by Test().

AIErr ai::Dictionary::GetBoolean	(	KeyType	key,
		AIBoolean &	value
	)			const

AIBoolean ai::Dictionary::GetBoolean

(

KeyType

key

)

const

Referenced by Test().

AIErr ai::Dictionary::GetDictionary	(	KeyType	key,
		Dictionary &	value
	)			const

Dictionary ai::Dictionary::GetDictionary

(

KeyType

key

)

const

Referenced by Test().

AIEntryType ai::Dictionary::GetEntryType

(

KeyType

key

)

const

AIErr ai::Dictionary::GetInteger	(	KeyType	key,
		ai::int32 &	value
	)			const

ai::int32 ai::Dictionary::GetInteger

(

KeyType

key

)

const

Referenced by Test().

Dictionary::KeyType ai::Dictionary::GetKey

(

const char *

string

)

const

const char * ai::Dictionary::GetKeyString

(

KeyType

key

)

const

AIErr ai::Dictionary::GetPointer	(	KeyType	key,
		ai::intptr &	value
	)			const

ai::intptr ai::Dictionary::GetPointer

(

KeyType

key

)

const

Referenced by Test().

AIErr ai::Dictionary::GetReal	(	KeyType	key,
		AIReal &	value
	)			const

AIReal ai::Dictionary::GetReal

(

KeyType

key

)

const

Referenced by Test().

AIErr ai::Dictionary::GetString	(	KeyType	key,
		std::string &	value
	)			const

std::string ai::Dictionary::GetString

(

KeyType

key

)

const

AIErr ai::Dictionary::GetUnicodeString	(	KeyType	key,
		ai::UnicodeString &	value
	)			const

ai::UnicodeString ai::Dictionary::GetUnicodeString

(

KeyType

key

)

const

Referenced by Test().

bool ai::Dictionary::IsKnown

(

KeyType

key

)

const

Dictionary & ai::Dictionary::operator=

(

Dictionary

other

)

DictEntryGetSet ai::Dictionary::operator[]

(

KeyType

key

)

[inline]

void ai::Dictionary::Set	(	KeyType	key,
		const Entry &	entry
	)

Referenced by Test().

void ai::Dictionary::SetArray	(	KeyType	key,
		const Array &	value
	)

Referenced by Test().

void ai::Dictionary::SetBinary	(	KeyType	key,
		const BinaryType &	value
	)

Referenced by Test().

void ai::Dictionary::SetBoolean	(	KeyType	key,
		AIBoolean	value
	)

Referenced by Test(), and ai::Array::Test().

void ai::Dictionary::SetDictionary	(	KeyType	key,
		const Dictionary &	value
	)

Referenced by Test().

void ai::Dictionary::SetInteger	(	KeyType	key,
		ai::int32	value
	)

Referenced by Test().

void ai::Dictionary::SetPointer	(	KeyType	key,
		ai::intptr	value
	)

Referenced by Test().

void ai::Dictionary::SetReal	(	KeyType	key,
		AIReal	value
	)

Referenced by Test().

void ai::Dictionary::SetString	(	KeyType	key,
		const std::string &	value
	)

void ai::Dictionary::SetUnicodeString	(	KeyType	key,
		const ai::UnicodeString &	value
	)

Referenced by Test().

void ai::Dictionary::swap

(

Dictionary &

other

)

Referenced by Dictionary().

void ai::Dictionary::Test

(

)

[static]

References AIMsgAssert, BinaryType, BooleanType, AIStrokeStyle::color, AIFillStyle::color, ai::UnicodeString::compare(), end(), AIPathStyle::fill, find(), Get(), GetBinary(), GetBoolean(), GetDictionary(), GetInteger(), GetPointer(), GetReal(), GetUnicodeString(), IntegerType, kFillStyleKey, AIColor::kind, kStrokeStyleKey, ai::Array::push_back(), RealType, Set(), SetArray(), SetBinary(), SetBoolean(), SetDictionary(), SetInteger(), SetPointer(), SetReal(), SetUnicodeString(), StringType, AIPathStyle::stroke, and UnicodeStringType.

void ai::Dictionary::TouchArt

(

)

---

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

• IAIDictionary.hpp
• IAIDictionary.cpp