Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > > Class Template Reference

#include <idioskopos/readonlypropertybase.h>

Inheritance diagram for Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >:

Inheritance graph
[legend]
List of all members.

Detailed Description

template<typename X, typename A>
class Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >

Template specialization of ReadOnlyPropertyBase for std::vector.


Public Types

typedef IdioskoposPointer<
ReadOnlyPropertyBase
pointer
typedef std::vector< X, A > value_type
typedef std::set< Object * > Objects

Public Member Functions

 IDIOSKOPOS_OBJECT (ReadOnlyPropertyBase)
 ReadOnlyPropertyBase (const Glib::ustring &name, sigc::slot< void > slot=sigc::slot< void >())
 Default constructor that doesn't do much.
 ReadOnlyPropertyBase (const Glib::ustring &name, Introspectable &container, sigc::slot< void > slot=sigc::slot< void >())
 Makes this a property of the introspectable container accessible through the provided name.
virtual ~ReadOnlyPropertyBase ()
 Destructor.
virtual const std::vector<
X, A > & 
get () const=0
 The canonical get() accessor method.
virtual std::vector< X, A > * get_pointer ()=0
 Should return a pointer to the contained object, or NULL if pointers are not allowed.
virtual const std::vector<
X, A > * 
get_pointer () const
 operator const std::vector () const
 Allows for implicit casts to the contained type.
const std::vector< X, A > & operator() () const
 Function call syntax.
std::vector< X, A > * operator-> ()
 A convenience operator when the property contains a class.
virtual Glib::ustring xml (int indent=-1)
 The get_xml function is a template method with full specializations for known types.
virtual Glib::ustring value ()
 Similar in concept to the xml() method, this provides a string representation of the contained value if the get_value() template has a meaningful template specialization.
const std::type_info & type () const
 Returns the RTTI type id of the contained type.
 IDIOSKOPOS_OBJECT (Object)
const Glib::ustring & name ()
void set_name (const Glib::ustring &n)
virtual sigc::signal< void,
Object * > 
signal_property_added ()
 Returns the property added signal if this is an introspectable object, otherwise throws an exception.
virtual sigc::signal< void,
Object * > 
signal_property_removed ()
 Returns the property removed signal if this is an introspectable object, otherwise throws an exception.
sigc::signal< void, const
Glib::ustring & > 
signal_name_changed ()
sigc::signal< void > & signal_value_changed ()
 Signal emitted when the property is changed.
virtual void set_xml (const Glib::ustring &s, bool change_names=false, bool create_missing=true)
virtual void set_xml (const xmlpp::Node *n, bool change_names=false, bool create_missing=true)
virtual void set_value (const Glib::ustring &v)
template<typename T>
void set_value (const T &t)
virtual size_t num_properties () const
 If this is a property container, this should be reimplemented to provide a true count of the number of child properties this container has.
virtual iterator properties_begin ()
virtual iterator properties_end ()
virtual Objectoperator[] (const Glib::ustring &name) throw (error::bad_property_name)
 This method returns an Object reference and throws exceptions when a bad name is encountered.

Protected Member Functions

virtual iterator next_property (std::set< Object * >::iterator i)
virtual iterator next_property (size_t i)
virtual iterator previous_property (std::set< Object * >::iterator i)
virtual iterator previous_property (size_t i)

Protected Attributes

Glib::ustring m_name
sigc::signal< void, const
Glib::ustring & > 
m_signal_name_changed
sigc::signal< void > m_signal_value_changed
 Signal emitted when underlying data is changed.


Constructor & Destructor Documentation

template<typename X, typename A>
Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::ReadOnlyPropertyBase ( const Glib::ustring &  name,
sigc::slot< void >  slot = sigc::slot<void>() 
) [inline]

Default constructor that doesn't do much.

template<typename X, typename A>
Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::ReadOnlyPropertyBase ( const Glib::ustring &  name,
Introspectable container,
sigc::slot< void >  slot = sigc::slot<void>() 
) [inline]

Makes this a property of the introspectable container accessible through the provided name.

template<typename X, typename A>
virtual Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::~ReadOnlyPropertyBase (  )  [inline, virtual]

Destructor.


Member Function Documentation

template<typename X, typename A>
virtual const std::vector<X, A>& Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::get (  )  const [pure virtual]

The canonical get() accessor method.

template<typename X, typename A>
virtual std::vector<X, A>* Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::get_pointer (  )  [pure virtual]

Should return a pointer to the contained object, or NULL if pointers are not allowed.

template<typename X, typename A>
Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::operator const std::vector (  )  const [inline]

Allows for implicit casts to the contained type.

template<typename X, typename A>
const std::vector<X, A>& Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::operator() (  )  const [inline]

Function call syntax.

Get the value of the property with property() notation.

Returns:
the current value of the property

template<typename X, typename A>
std::vector<X, A>* Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::operator-> (  )  [inline]

A convenience operator when the property contains a class.

Allows class method to be accessed using notation: property->class_method()

template<typename X, typename A>
virtual Glib::ustring Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::xml ( int  indent = -1  )  [inline, virtual]

The get_xml function is a template method with full specializations for known types.

The default implementation returns an XML string filled with the RTTI typeinfo id. This is not a portable approach. However, if you provide a specialization of get_xml() for your class, it _will_ be a portable solution.

Implements Idioskopos::Object.

Reimplemented in Idioskopos::PropertyBase< std::vector< X, A > >.

template<typename X, typename A>
virtual Glib::ustring Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::value (  )  [inline, virtual]

Similar in concept to the xml() method, this provides a string representation of the contained value if the get_value() template has a meaningful template specialization.

Reimplemented from Idioskopos::Object.

template<typename X, typename A>
const std::type_info& Idioskopos::ReadOnlyPropertyBase< std::vector< X, A > >::type (  )  const [inline, virtual]

Returns the RTTI type id of the contained type.

Implements Idioskopos::Object.

Reimplemented in Idioskopos::PropertyBase< std::vector< X, A > >.

sigc::signal< void, Object * > Idioskopos::Object::signal_property_added (  )  [virtual, inherited]

Returns the property added signal if this is an introspectable object, otherwise throws an exception.

Reimplemented in Idioskopos::Introspectable.

sigc::signal< void, Object * > Idioskopos::Object::signal_property_removed (  )  [virtual, inherited]

Returns the property removed signal if this is an introspectable object, otherwise throws an exception.

Reimplemented in Idioskopos::Introspectable.

sigc::signal< void > & Idioskopos::Object::signal_value_changed (  )  [inherited]

Signal emitted when the property is changed.

size_t Idioskopos::Object::num_properties (  )  const [virtual, inherited]

If this is a property container, this should be reimplemented to provide a true count of the number of child properties this container has.

Reimplemented in Idioskopos::Introspectable, Idioskopos::PropertyBase< std::vector< X, A > >, and Idioskopos::PropertyBase< IdioskoposArray< X, N > >.

Object & Idioskopos::Object::operator[] ( const Glib::ustring &  name  )  throw (error::bad_property_name) [virtual, inherited]

This method returns an Object reference and throws exceptions when a bad name is encountered.

The alternative would be to return an Object* and return NULL for an unfound name. However, by returning a reference, it is possible to index into objects using array notation, as in myobject["child"]["property"]

Reimplemented in Idioskopos::Introspectable.


Member Data Documentation

sigc::signal<void> Idioskopos::Object::m_signal_value_changed [protected, inherited]

Signal emitted when underlying data is changed.


The documentation for this class was generated from the following file:
Generated on Thu Jan 11 00:26:45 2007 by  doxygen 1.5.1