Ardour  9.0-pre0-582-g084a23a80d
PBD::Command Class Referenceabstract

#include <command.h>

Inheritance diagram for PBD::Command:
[legend]

Public Member Functions

virtual ~Command ()
 
virtual void operator() ()=0
 
void set_name (const std::string &str)
 
const std::string & name () const
 
virtual void undo ()=0
 
virtual void redo ()
 
virtual XMLNodeget_state () const
 
virtual int set_state (const XMLNode &, int)
 
virtual bool empty () const
 
- Public Member Functions inherited from PBD::Stateful
 Stateful ()
 
virtual ~Stateful ()
 
virtual bool apply_change (PropertyBase const &)
 
PropertyChange apply_changes (PropertyList const &)
 
const OwnedPropertyListproperties () const
 
void add_property (PropertyBase &s)
 
void add_extra_xml (XMLNode &)
 
XMLNodeextra_xml (const std::string &str, bool add_if_missing=false)
 
void save_extra_xml (const XMLNode &)
 
const PBD::IDid () const
 
bool set_id (const XMLNode &)
 
void set_id (const std::string &)
 
void reset_id ()
 
void clear_changes ()
 
virtual void clear_owned_changes ()
 
PropertyListget_changes_as_properties (PBD::Command *) const
 
virtual void rdiff (std::vector< PBD::Command * > &) const
 
bool changed () const
 
virtual PropertyListproperty_factory (const XMLNode &) const
 
virtual void suspend_property_changes ()
 
virtual void resume_property_changes ()
 
bool property_changes_suspended () const
 
- Public Member Functions inherited from PBD::Destructible
virtual ~Destructible ()
 
virtual void drop_references ()
 
- Public Member Functions inherited from PBD::ScopedConnectionList
 ScopedConnectionList ()
 
 ScopedConnectionList (const ScopedConnectionList &)=delete
 
ScopedConnectionListoperator= (const ScopedConnectionList &)=delete
 
virtual ~ScopedConnectionList ()
 
void add_connection (const UnscopedConnection &c)
 
void drop_connections ()
 

Protected Member Functions

 Command ()
 
 Command (const std::string &name)
 
- Protected Member Functions inherited from PBD::Stateful
void add_instant_xml (XMLNode &, const std::string &directory_path)
 
XMLNodeinstant_xml (const std::string &str, const std::string &directory_path)
 
void add_properties (XMLNode &) const
 
PropertyChange set_values (XMLNode const &)
 
virtual void post_set (const PropertyChange &)
 
virtual void send_change (const PropertyChange &)
 
virtual void mid_thaw (const PropertyChange &)
 
bool regenerate_xml_or_string_ids () const
 

Protected Attributes

std::string _name
 
- Protected Attributes inherited from PBD::Stateful
XMLNode_extra_xml
 
XMLNode_instant_xml
 
PBD::PropertyChange _pending_changed
 
Glib::Threads::Mutex _lock
 
std::string _xml_node_name
 name of node to use for this object in XML More...
 
OwnedPropertyList_properties
 

Additional Inherited Members

- Public Attributes inherited from PBD::Stateful
PBD::Signal< void(const PropertyChange &)> PropertyChanged
 
- Public Attributes inherited from PBD::Destructible
PBD::Signal< void()> Destroyed
 
PBD::Signal< void()> DropReferences
 
- Static Public Attributes inherited from PBD::Stateful
static int current_state_version
 
static int loading_state_version
 

Detailed Description

Base class for Undo/Redo commands and changesets

Definition at line 34 of file command.h.

Constructor & Destructor Documentation

◆ ~Command()

virtual PBD::Command::~Command ( )
inlinevirtual

Definition at line 37 of file command.h.

◆ Command() [1/2]

PBD::Command::Command ( )
inlineprotected

Definition at line 55 of file command.h.

◆ Command() [2/2]

PBD::Command::Command ( const std::string &  name)
inlineprotected

Definition at line 56 of file command.h.

Member Function Documentation

◆ empty()

virtual bool PBD::Command::empty ( ) const
inlinevirtual

Reimplemented in PBD::UndoTransaction, and PBD::StatefulDiffCommand.

Definition at line 50 of file command.h.

◆ get_state()

◆ name()

const std::string& PBD::Command::name ( ) const
inline

Definition at line 42 of file command.h.

◆ operator()()

◆ redo()

virtual void PBD::Command::redo ( )
inlinevirtual

Reimplemented in PBD::UndoTransaction.

Definition at line 45 of file command.h.

◆ set_name()

void PBD::Command::set_name ( const std::string &  str)
inline

Definition at line 41 of file command.h.

◆ set_state()

virtual int PBD::Command::set_state ( const XMLNode ,
int   
)
inlinevirtual

◆ undo()

Member Data Documentation

◆ _name

std::string PBD::Command::_name
protected

Definition at line 58 of file command.h.


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