Rocket::Core::PropertyDictionary Class Reference

#include <PropertyDictionary.h>


Public Member Functions
void	SetProperty (const String &name, const Property &property)
void	RemoveProperty (const String &name)
const Property *	GetProperty (const String &name) const
int	GetNumProperties () const
const PropertyMap &	GetProperties () const
void	Import (const PropertyDictionary &property_dictionary, int specificity=-1)
void	Merge (const PropertyDictionary &property_dictionary, int specificity_offset=0)

Detailed Description

A dictionary to property names to values.

Author:: Peter Curry

Member Function Documentation

void Rocket::Core::PropertyDictionary::SetProperty	(	const String &	name,
		const Property &	property
	)

Sets a property on the dictionary. Any existing property with a similar name will be overwritten.

Parameters:

`[in]`	name	The name of the property to add.
`[in]`	property	The value of the new property.

void Rocket::Core::PropertyDictionary::RemoveProperty ( const String & name )

Removes a property from the dictionary, if it exists.

Parameters:

[in] name The name of the property to remove.

const Property * Rocket::Core::PropertyDictionary::GetProperty ( const String & name ) const

Returns the value of the property with the requested name, if one exists.

Parameters:

[in] name The name of the desired property.

int Rocket::Core::PropertyDictionary::GetNumProperties ( ) const

Returns the number of properties in the dictionary.

Returns:: The number of properties in the dictionary.

const PropertyMap & Rocket::Core::PropertyDictionary::GetProperties ( ) const

Returns the map of properties in the dictionary.

Returns:: The property map.

void Rocket::Core::PropertyDictionary::Import	(	const PropertyDictionary &	property_dictionary,
		int	specificity = `-1`
	)

Imports into the dictionary, and optionally defines the specificity of, potentially un-specified properties. In the case of name conflicts, the incoming properties will overwrite the existing properties if their specificity (or their forced specificity) are at least equal.

Parameters:

`[in]`	property_dictionary	The properties to import.
`[in]`	specificity	The specificity for all incoming properties. If this is not specified, the properties will keep their original specificity.

void Rocket::Core::PropertyDictionary::Merge	(	const PropertyDictionary &	property_dictionary,
		int	specificity_offset = `0`
	)

Merges the contents of another fully-specified property dictionary with this one. Properties defined in the new dictionary will overwrite those with the same name as appropriate.

Parameters:

`[in]`	property_dictionary	The dictionary to merge.
`[in]`	specificity_offset	The specificities of all incoming properties will be offset by this value.

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

Include/Rocket/Core/PropertyDictionary.h
Source/Core/PropertyDictionary.cpp

Rocket::Core::PropertyDictionary Class Reference

Public Member Functions

Detailed Description

Member Function Documentation