k3d::inode_collection Class Reference

Abstract interface for a collection of document nodes. More...

#include <inode_collection.h>

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

List of all members.

Public Types

typedef std::vector< inode * > nodes_t
 Defines a collection of nodes.
typedef sigc::signal< void,
const nodes_t & > 
add_nodes_signal_t
 Defines a signal that will be emitted whenever nodes are added to the collection.
typedef sigc::signal< void,
const nodes_t & > 
remove_nodes_signal_t
 Defines a signal that will be emitted whenever nodes are removed from the collection.
typedef sigc::signal< void,
inode * > 
rename_node_signal_t
 Defines a signal that will be emitted whenever an node is renamed.

Public Member Functions

virtual void add_nodes (const nodes_t &Objects)=0
 Adds new nodes to the collection.
virtual const nodes_tcollection ()=0
 Returns the set of all nodes in the collection.
virtual void remove_nodes (const nodes_t &Objects)=0
 Removes nodes from the collection.
virtual add_nodes_signal_tadd_nodes_signal ()=0
virtual remove_nodes_signal_tremove_nodes_signal ()=0
virtual rename_node_signal_trename_node_signal ()=0

Protected Member Functions

 inode_collection ()
 inode_collection (const inode_collection &Other)
inode_collectionoperator= (const inode_collection &)
virtual ~inode_collection ()

Detailed Description

Abstract interface for a collection of document nodes.


Member Typedef Documentation

typedef sigc::signal<void, const nodes_t&> k3d::inode_collection::add_nodes_signal_t

Defines a signal that will be emitted whenever nodes are added to the collection.

typedef std::vector<inode*> k3d::inode_collection::nodes_t

Defines a collection of nodes.

typedef sigc::signal<void, const nodes_t&> k3d::inode_collection::remove_nodes_signal_t

Defines a signal that will be emitted whenever nodes are removed from the collection.

typedef sigc::signal<void, inode*> k3d::inode_collection::rename_node_signal_t

Defines a signal that will be emitted whenever an node is renamed.


Constructor & Destructor Documentation

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

Member Function Documentation

virtual void k3d::inode_collection::add_nodes ( const nodes_t Objects  )  [pure virtual]
virtual add_nodes_signal_t& k3d::inode_collection::add_nodes_signal (  )  [pure virtual]
virtual const nodes_t& k3d::inode_collection::collection (  )  [pure virtual]
inode_collection& k3d::inode_collection::operator= ( const inode_collection  )  [inline, protected]
virtual void k3d::inode_collection::remove_nodes ( const nodes_t Objects  )  [pure virtual]
virtual remove_nodes_signal_t& k3d::inode_collection::remove_nodes_signal (  )  [pure virtual]
virtual rename_node_signal_t& k3d::inode_collection::rename_node_signal (  )  [pure virtual]

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

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