Caelum::DefaultTypeDescriptor Class Reference

Default implementation of a TypeDescriptor. More...

#include <TypeDescriptor.h>

Inheritance diagram for Caelum::DefaultTypeDescriptor:

Caelum::TypeDescriptor

List of all members.

Public Member Functions

PropertyMap & getPropertyMap ()
 Direct access to the internal property map.
void add (const Ogre::String &name, const ValuePropertyDescriptor *descriptor)
 Add a property. Type descriptor takes ownership.
void clear ()
 Clear the property map; delete all property descriptors.
virtual const
ValuePropertyDescriptor
getPropertyDescriptor (const Ogre::String &name) const
virtual const std::vector< String > getPropertyNames () const
virtual const PropertyMap getFullPropertyMap () const


Detailed Description

Default implementation of a TypeDescriptor.

This is a standard implementation of a type descriptor.

It allows direct access to an internal PropertyMap. The user must manually fill the map with property descriptors; probably in an init method of sorts.

Definition at line 204 of file TypeDescriptor.h.


Member Function Documentation

PropertyMap& Caelum::DefaultTypeDescriptor::getPropertyMap (  )  [inline]

Direct access to the internal property map.

Get the property map used to implement this type descriptor. Once initialisation is complete the property map should no longer be modified.

Definition at line 215 of file TypeDescriptor.h.

virtual const ValuePropertyDescriptor* Caelum::DefaultTypeDescriptor::getPropertyDescriptor ( const Ogre::String &  name  )  const [virtual]

Get a property descriptor; or null if not available.

Parameters:
name Name of the property to request.
Returns:
A pointer to a property descriptor; or null if not available.

Implements Caelum::TypeDescriptor.

virtual const std::vector<String> Caelum::DefaultTypeDescriptor::getPropertyNames (  )  const [virtual]

Get a map of all supported properties.

Returns a complete list of all supported properties; by value.

Implements Caelum::TypeDescriptor.

virtual const PropertyMap Caelum::DefaultTypeDescriptor::getFullPropertyMap (  )  const [virtual]

Get a map of all supported properties.

Returns a complete list of all supported properties; by value.

Implements Caelum::TypeDescriptor.


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

Generated on Sun Aug 9 10:24:22 2009 for Caelum by  doxygen 1.5.9