< home
expo::Expo

Expo Class Reference
[Basic exposition elements used to specify exposed functionality.]

Base class for all exposition elements. More...

#include <Exposition.h>

Inheritance diagram for Expo:

MethodExpo PropertyExpo VariableExpo List of all members.

Public Member Functions

 Expo (string const &name, string const &type, data_type datatype, Exposer *parent=Exposer::Current())
 Constructor. Needs to have the name, type, datatype specified.
Expo * Add (Property *property)
 Adds a property to the exposition.
Expo & operator<< (Property *property)
 Adds a property to the exposition.
bool Has (Property::expo_property property)
 Returns true if the exposition has the specified property.
set< Property *, PropertyCompare > & Properties ()
 Returns the entire properties set.
Property * FindProperty (Property::expo_property property)
 Returns the Property object with the specified expo_property (NULL if not found).
string const & Name () const
 Returns the exposition name.
string const & Type () const
 Returns the exposition type.
data_type DataType () const
 Returns the exposition data type.
int Order () const
 Returns the order in which the exposition was created.
Exposer & GetExposer ()
 Returns the exposer this exposition belongs to.
virtual vartype Call (void *p=NULL)
 Executes the action (function call) associated with the exposition.
virtual void Set (vartype const &v, ExposerManifester *by=NULL)
 Sets the value associated with the exposition.
virtual vartype Get ()
 Gets the value associated with the exposition.

Protected Attributes

string name
 Name of the exposition. Used to reference it.
string type
 Type of exposition. For example, "Method" or "Variable".
data_type datatype
 Data type referenced by the exposition.
set< Property *, PropertyCompare > properties
 Properties for this exposition.
Exposer * parent
 Exposer this exposition belongs to.
int order
 Order in which this exposition was created.

Detailed Description

Base class for all exposition elements.

Expositions are used to expose parts of a class to the UI modules. This can be used, for example, to expose a variable or a function.

Member Function Documentation

data_type DataType (   )  const [inline]
 

Returns the exposition data type.

See also:
Expo::datatype

Exposer& GetExposer (   )  [inline]
 

Returns the exposer this exposition belongs to.

See also:
Expo::parent

string const& Name (   )  const [inline]
 

Returns the exposition name.

See also:
Expo::name

string const& Type (   )  const [inline]
 

Returns the exposition type.

See also:
Expo::type

Member Data Documentation

set<Property *, PropertyCompare> properties [protected]
 

Properties for this exposition.

See also:
expo::Property
Todo:
Convert to boost pointer set.
The documentation for this class was generated from the following files:

 

Documentation generated on 14 Jun 2006 for OpenExposition by  doxygen 1.4.6>
Development hosted by SourceForge.net Logo