Option Class Reference

#include <option_editor.h>

Inheritance diagram for Option:

Public Member Functions
	Option (std::string const &i, std::string const &n)
void	parameter_changed (std::string const &p)
virtual void	set_state_from_config ()=0
virtual void	add_to_page (OptionEditorPage *)=0
std::string	id () const
Public Member Functions inherited from OptionEditorComponent
	OptionEditorComponent ()
virtual	~OptionEditorComponent ()
void	add_widget_to_page (OptionEditorPage *, Gtk::Widget *)
void	add_widgets_to_page (OptionEditorPage *, Gtk::Widget *, Gtk::Widget *, bool expand=true)
void	set_note (std::string const &)
virtual Gtk::Widget &	tip_widget ()=0
virtual PBD::Configuration::Metadata const *	get_metadata () const
void	set_metadata (PBD::Configuration::Metadata const &)
void	highlight ()
void	end_highlight ()

Protected Attributes
std::string	_id
std::string	_name
Protected Attributes inherited from OptionEditorComponent
std::string	_note
ArdourWidgets::Frame *	_frame
PBD::Configuration::Metadata const *	_metadata

Additional Inherited Members
Protected Member Functions inherited from OptionEditorComponent
void	maybe_add_note (OptionEditorPage *, int)

Detailed Description

Base class for components which provide UI to change an option

Definition at line 173 of file option_editor.h.

Constructor & Destructor Documentation

Option()

Option::Option ( std::string const &  i, std::string const &  n  )

inline

Construct an Option.

Parameters

i	Option id (e.g. "plugins-stop-with-transport")
n	User-visible name (e.g. "Stop plugins when the transport is stopped")

Definition at line 180 of file option_editor.h.

Member Function Documentation

add_to_page()

virtual void Option::add_to_page ( OptionEditorPage *  )

pure virtual

Called to instruct the object to add itself to an OptionEditorPage

Implements OptionEditorComponent.

Implemented in SpinOption< T >, ComboStringOption, HSliderOption, ComboOption< T >, ComboOption< float >, ComboOption< ARDOUR::ListenPosition >, ComboOption< ARDOUR::SampleFormat >, SearchPathOption, DirectoryOption, ClockOption, WidgetOption, FaderOption, BoolComboOption, EntryOption, and BoolOption.

id()

std::string Option::id ( ) const

inline

Definition at line 197 of file option_editor.h.

parameter_changed()

void Option::parameter_changed ( std::string const &  p )

inlinevirtual

Called when a configuration parameter's value has changed.

Parameters

p	parameter name

Implements OptionEditorComponent.

Reimplemented in WidgetOption.

Definition at line 187 of file option_editor.h.

set_state_from_config()

virtual void Option::set_state_from_config ( )

pure virtual

Called to instruct the object to set its UI state from the configuration

Implements OptionEditorComponent.

Implemented in SearchPathOption, DirectoryOption, ClockOption, WidgetOption, FaderOption, SpinOption< T >, BoolComboOption, ComboStringOption, HSliderOption, ComboOption< T >, ComboOption< float >, ComboOption< ARDOUR::ListenPosition >, ComboOption< ARDOUR::SampleFormat >, EntryOption, and BoolOption.

Member Data Documentation

_id

std::string Option::_id

protected

Definition at line 202 of file option_editor.h.

_name

std::string Option::_name

protected

Definition at line 203 of file option_editor.h.

---

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

• option_editor.h