k3d::iproperty_collection Class Reference

Abstract interface for a collection of iproperty objects. More...

#include <iproperty_collection.h>

Inheritance diagram for k3d::iproperty_collection:
Inheritance graph
[legend]

List of all members.

Public Types

typedef std::vector< iproperty * > properties_t
 Defines a collection of properties.

Public Member Functions

virtual void register_property (iproperty &Property)=0
 Registers a property with the collection - note: the collection will assume responsibility for the lifetime of user properties only.
virtual void register_properties (const properties_t &Properties)=0
 Registers a set of properties with the collection - note: the collection will assume responsibility for the lifetime of user properties only.
virtual void unregister_property (iproperty &Property)=0
 Removes a property from the collection.
virtual void unregister_properties (const properties_t &Properties)=0
 Removes a set of properties from the collection.
virtual const properties_tproperties ()=0
 Returns the set of all properties in the collection.
virtual sigc::connection connect_properties_changed_signal (const sigc::slot< void, ihint * > &Slot)=0
 Connects a slot to a signal emitted whenever the collection changes - note: the signal is emitted when the collection changes (properties are registered and unregistered), not when individual property values are changed.

Protected Member Functions

 iproperty_collection ()
 iproperty_collection (const iproperty_collection &Other)
iproperty_collectionoperator= (const iproperty_collection &)
virtual ~iproperty_collection ()

Detailed Description

Abstract interface for a collection of iproperty objects.


Member Typedef Documentation

Defines a collection of properties.


Constructor & Destructor Documentation

k3d::iproperty_collection::iproperty_collection (  )  [inline, protected]
k3d::iproperty_collection::iproperty_collection ( const iproperty_collection Other  )  [inline, protected]
virtual k3d::iproperty_collection::~iproperty_collection (  )  [inline, protected, virtual]

Member Function Documentation

virtual sigc::connection k3d::iproperty_collection::connect_properties_changed_signal ( const sigc::slot< void, ihint * > &  Slot  )  [pure virtual]

Connects a slot to a signal emitted whenever the collection changes - note: the signal is emitted when the collection changes (properties are registered and unregistered), not when individual property values are changed.

Implemented in k3d::property::detail::null_property_collection, and k3d::property_collection.

Referenced by k3d::user_property_changed_signal::user_property_changed_signal().

iproperty_collection& k3d::iproperty_collection::operator= ( const iproperty_collection  )  [inline, protected]
virtual const properties_t& k3d::iproperty_collection::properties (  )  [pure virtual]
virtual void k3d::iproperty_collection::register_properties ( const properties_t Properties  )  [pure virtual]

Registers a set of properties with the collection - note: the collection will assume responsibility for the lifetime of user properties only.

Implemented in k3d::property::detail::null_property_collection, and k3d::property_collection.

Referenced by k3d::user::property_container::restore_state().

virtual void k3d::iproperty_collection::register_property ( iproperty Property  )  [pure virtual]

Registers a property with the collection - note: the collection will assume responsibility for the lifetime of user properties only.

Implemented in k3d::property::detail::null_property_collection, and k3d::property_collection.

virtual void k3d::iproperty_collection::unregister_properties ( const properties_t Properties  )  [pure virtual]

Removes a set of properties from the collection.

Implemented in k3d::property::detail::null_property_collection, and k3d::property_collection.

Referenced by k3d::user::property_container::restore_state().

virtual void k3d::iproperty_collection::unregister_property ( iproperty Property  )  [pure virtual]

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

Generated on Mon Mar 21 07:41:58 2011 for K-3D by doxygen 1.6.3