#include <property_basics.h>

Inheritance diagram for PBD::PropertyBase:

Public Member Functions
	PropertyBase (PropertyID pid)

virtual	~PropertyBase ()

virtual bool	set_value (XMLNode const &)=0

virtual void	get_value (XMLNode &node) const =0

virtual void	clear_changes ()=0

virtual void	clear_owned_changes ()

virtual bool	changed () const =0

virtual void	invert ()=0

virtual void	get_changes_as_xml (XMLNode *) const =0

virtual void	get_changes_as_properties (PropertyList &changes, Command *) const =0

virtual void	rdiff (std::vector< Command * > &) const

virtual PropertyBase *	clone_from_xml (const XMLNode &) const

virtual PropertyBase *	clone () const =0

virtual void	apply_changes (PropertyBase const *)=0

const gchar *	property_name () const

PropertyID	property_id () const

bool	operator== (PropertyID pid) const

Protected Member Functions
	PropertyBase (PropertyBase const &b)

Private Attributes
PropertyID	_property_id

Detailed Description

Base (non template) part of Property Properties are used for two main reasons:

to handle current state (when serializing Stateful objects)
to handle history since some operation was started (when making StatefulDiffCommands for undo)

Definition at line 88 of file property_basics.h.

Constructor & Destructor Documentation

PBD::PropertyBase::PropertyBase ( PropertyID pid )

inline

Definition at line 91 of file property_basics.h.

virtual PBD::PropertyBase::~PropertyBase ( )

inlinevirtual

Definition at line 95 of file property_basics.h.

PBD::PropertyBase::PropertyBase ( PropertyBase const & b )

inlineprotected

Definition at line 163 of file property_basics.h.

Member Function Documentation

virtual void PBD::PropertyBase::apply_changes ( PropertyBase const * )

pure virtual

Set this property's current state from another

virtual bool PBD::PropertyBase::changed ( ) const

pure virtual

Returns: true if this property has changed in value since construction or since the last call to clear_changes (), whichever was more recent.

virtual void PBD::PropertyBase::clear_changes ( )

pure virtual

Forget about any old changes to this property's value

virtual void PBD::PropertyBase::clear_owned_changes ( )

inlinevirtual

Tell any things we own to forget about their old values

Reimplemented in PBD::SequenceProperty< Container >, and PBD::SequenceProperty< std::list< boost::shared_ptr< Region > > >.

Definition at line 115 of file property_basics.h.

virtual PropertyBase* PBD::PropertyBase::clone ( ) const

pure virtual

Implemented in PBD::Property< std::string >, PBD::Property< T >, PBD::Property< gain_t >, PBD::Property< float >, PBD::Property< int >, PBD::Property< framecnt_t >, PBD::Property< bool >, PBD::Property< PositionLockStyle >, PBD::Property< framepos_t >, PBD::Property< Evoral::Beats >, PBD::Property< uint64_t >, ARDOUR::RegionListProperty, and ARDOUR::AutomationListProperty.

virtual PropertyBase* PBD::PropertyBase::clone_from_xml ( const XMLNode & ) const

inlinevirtual

Look in an XML node written by get_changes_as_xml and, if XML from this property is found, create a property with the changes from the XML.

Reimplemented in PBD::Property< T >, PBD::Property< gain_t >, PBD::Property< float >, PBD::Property< int >, PBD::Property< framecnt_t >, PBD::Property< bool >, PBD::Property< PositionLockStyle >, PBD::Property< framepos_t >, PBD::Property< Evoral::Beats >, PBD::Property< uint64_t >, PBD::SequenceProperty< Container >, and PBD::SequenceProperty< std::list< boost::shared_ptr< Region > > >.

Definition at line 144 of file property_basics.h.

virtual void PBD::PropertyBase::get_changes_as_properties	(	PropertyList &	changes,
		Command *
	)		const

pure virtual

If this Property has changed, clone it and add it to a given list. Used for making StatefulDiffCommands.

virtual void PBD::PropertyBase::get_changes_as_xml ( XMLNode * ) const

pure virtual

Get any changes in this property as XML and add them to a StatefulDiffCommand node.

virtual void PBD::PropertyBase::get_value ( XMLNode & node ) const

pure virtual

Get this property's value and put it into a Stateful node

virtual void PBD::PropertyBase::invert ( )

pure virtual

Invert the changes in this property

bool PBD::PropertyBase::operator== ( PropertyID pid ) const

inline

Definition at line 157 of file property_basics.h.

PropertyID PBD::PropertyBase::property_id ( ) const

inline

Definition at line 155 of file property_basics.h.

const gchar* PBD::PropertyBase::property_name ( ) const

inline

Definition at line 154 of file property_basics.h.

virtual void PBD::PropertyBase::rdiff ( std::vector< Command * > & ) const

inlinevirtual

Collect StatefulDiffCommands for changes to anything that we own

Reimplemented in PBD::SequenceProperty< Container >, and PBD::SequenceProperty< std::list< boost::shared_ptr< Region > > >.

Definition at line 139 of file property_basics.h.

virtual bool PBD::PropertyBase::set_value ( XMLNode const & )

pure virtual

Set the value of this property from a Stateful node.

Returns: true if the value was set.

Member Data Documentation

PropertyID PBD::PropertyBase::_property_id

private

Definition at line 168 of file property_basics.h.

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

/usr/local/music/src/ardour/4.0/libs/pbd/pbd/property_basics.h

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation