Ardour  9.0-pre0-582-g084a23a80d
GUIObjectState Class Reference

#include <gui_object.h>

Public Member Functions

 GUIObjectState ()
 
void load (const XMLNode &)
 
int set_state (const XMLNode &)
 
XMLNodeget_state () const
 
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)
 
void remove_property (const std::string &id, const std::string &prop_name)
 
void remove_node (const std::string &id)
 
std::list< std::string > all_ids () const
 
XMLNodeget_or_add_node (const std::string &)
 

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 Member Functions

 GUIObjectState (const GUIObjectState &other)
 

Private Attributes

XMLNode _state
 
std::map< std::string, XMLNode * > object_map
 

Detailed Description

Definition at line 29 of file gui_object.h.

Constructor & Destructor Documentation

◆ GUIObjectState() [1/2]

GUIObjectState::GUIObjectState ( )

◆ GUIObjectState() [2/2]

GUIObjectState::GUIObjectState ( const GUIObjectState other)
private

Member Function Documentation

◆ all_ids()

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

◆ get_node()

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

◆ get_or_add_node() [1/2]

XMLNode* GUIObjectState::get_or_add_node ( const std::string &  )

◆ get_or_add_node() [2/2]

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

◆ get_state()

XMLNode& GUIObjectState::get_state ( ) const

◆ get_string()

std::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-existent, otherwise false.
Returns
value of property ‘prop_name’, or empty.

◆ load()

void GUIObjectState::load ( const XMLNode )

◆ remove_node()

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

Remove node with provided id.

Parameters
idproperty of Object node to look for.

◆ remove_property()

void GUIObjectState::remove_property ( const std::string &  id,
const std::string &  prop_name 
)

◆ set_property()

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

Definition at line 48 of file gui_object.h.

◆ set_state()

int GUIObjectState::set_state ( const XMLNode )

Member Data Documentation

◆ _state

XMLNode GUIObjectState::_state
private

Definition at line 70 of file gui_object.h.

◆ object_map

std::map<std::string, XMLNode*> GUIObjectState::object_map
private

Definition at line 73 of file gui_object.h.

◆ xml_node_name

const std::string GUIObjectState::xml_node_name
static

Definition at line 34 of file gui_object.h.


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