ardour
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | List of all members
GUIObjectState Class Reference

#include <gui_object.h>

Public Member Functions

 GUIObjectState ()
 
XMLNodeget_state () const
 
int set_state (const XMLNode &)
 
void load (const XMLNode &)
 
std::string get_string (const std::string &id, const std::string &prop_name, bool *empty=0)
 
template<typename T >
void set_property (const std::string &id, const std::string &prop_name, const T &val)
 
std::list< std::string > all_ids () const
 
XMLNodeget_or_add_node (const std::string &)
 
void remove_node (const std::string &id)
 

Static Public Member Functions

static XMLNodeget_node (const XMLNode *, const std::string &)
 
static XMLNodeget_or_add_node (XMLNode *, const std::string &)
 

Static Public Attributes

static const std::string xml_node_name
 

Private Attributes

XMLNode _state
 

Detailed Description

Definition at line 31 of file gui_object.h.

Constructor & Destructor Documentation

GUIObjectState::GUIObjectState ( )

Definition at line 30 of file gui_object.cc.

Member Function Documentation

std::list< string > GUIObjectState::all_ids ( ) const

Definition at line 142 of file gui_object.cc.

XMLNode * GUIObjectState::get_node ( const XMLNode ,
const std::string &   
)
static

Definition at line 37 of file gui_object.cc.

XMLNode* GUIObjectState::get_or_add_node ( const std::string &  )
static XMLNode* GUIObjectState::get_or_add_node ( XMLNode ,
const std::string &   
)
static
XMLNode & GUIObjectState::get_state ( void  ) const

Definition at line 119 of file gui_object.cc.

string GUIObjectState::get_string ( const std::string &  id,
const std::string &  prop_name,
bool *  empty = 0 
)

Get a string from our state.

Parameters
idproperty of Object node to look for.
prop_namename of the Object property to return.
emptyif non-0, filled in with true if the property is currently non-existant, otherwise false.
Returns
value of property `prop_name', or empty.

Definition at line 92 of file gui_object.cc.

void GUIObjectState::load ( const XMLNode node)

Definition at line 136 of file gui_object.cc.

void GUIObjectState::remove_node ( const std::string &  id)

Remove node with provided id.

Parameters
idproperty of Object node to look for.

Definition at line 79 of file gui_object.cc.

template<typename T >
void GUIObjectState::set_property ( const std::string &  id,
const std::string &  prop_name,
const T &  val 
)
inline

Definition at line 44 of file gui_object.h.

int GUIObjectState::set_state ( const XMLNode node)

Definition at line 125 of file gui_object.cc.

Member Data Documentation

XMLNode GUIObjectState::_state
private

Definition at line 60 of file gui_object.h.

const string GUIObjectState::xml_node_name
static

Definition at line 39 of file gui_object.h.


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