k3d::imetadata Class Reference

Abstract interface for objects that can store arbitrary metadata (name-value pairs). More...

#include <imetadata.h>

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

List of all members.

Public Types

typedef std::map< string_t,
string_t
metadata_t
 Defines storage for an arbitrary collection of name-value pairs.

Public Member Functions

virtual void set_metadata_value (const string_t &Name, const string_t &Value)=0
 Sets a new name-value pair, overwriting the value if the name already exists.
virtual void set_metadata (const metadata_t &Values)=0
 Sets a collection of name-value pair, overwriting any existing values.
virtual metadata_t get_metadata ()=0
 Returns the set of existing name-value pairs.
virtual const string_t get_metadata_value (const string_t &Name)=0
 Returns a value by name, or empty-string if the name doesn't exist.
virtual void erase_metadata_value (const string_t &Name)=0
 Erases an existing name-value pair.
virtual sigc::connection connect_metadata_changed_signal (const sigc::slot< void > &Slot)=0
 Connects a slot to a signal that will be emitted whenever the metadata contents change.

Protected Member Functions

 imetadata ()
 imetadata (const imetadata &Other)
imetadataoperator= (const imetadata &)
virtual ~imetadata ()

Detailed Description

Abstract interface for objects that can store arbitrary metadata (name-value pairs).


Member Typedef Documentation

Defines storage for an arbitrary collection of name-value pairs.


Constructor & Destructor Documentation

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

Member Function Documentation

virtual sigc::connection k3d::imetadata::connect_metadata_changed_signal ( const sigc::slot< void > &  Slot  )  [pure virtual]

Connects a slot to a signal that will be emitted whenever the metadata contents change.

Implemented in k3d::metadata::storage.

Referenced by k3d::qtui::selection::state::implementation::node_selection(), and k3d::ngui::selection::state::implementation::node_selection().

virtual void k3d::imetadata::erase_metadata_value ( const string_t Name  )  [pure virtual]

Erases an existing name-value pair.

Implemented in k3d::metadata::storage.

virtual metadata_t k3d::imetadata::get_metadata (  )  [pure virtual]

Returns the set of existing name-value pairs.

Implemented in k3d::metadata::storage.

virtual const string_t k3d::imetadata::get_metadata_value ( const string_t Name  )  [pure virtual]

Returns a value by name, or empty-string if the name doesn't exist.

Implemented in k3d::metadata::storage.

imetadata& k3d::imetadata::operator= ( const imetadata  )  [inline, protected]
virtual void k3d::imetadata::set_metadata ( const metadata_t Values  )  [pure virtual]

Sets a collection of name-value pair, overwriting any existing values.

Implemented in k3d::metadata::storage.

virtual void k3d::imetadata::set_metadata_value ( const string_t Name,
const string_t Value 
) [pure virtual]

Sets a new name-value pair, overwriting the value if the name already exists.

Implemented in k3d::metadata::storage.

Referenced by k3d::ngui::detail::setup_selection_document().


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

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