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
virtual	~OptionEditorComponent ()
void	add_widget_to_page (OptionEditorPage *, Gtk::Widget *)
void	add_widgets_to_page (OptionEditorPage *, Gtk::Widget *, Gtk::Widget *)
void	set_note (std::string const &)
virtual Gtk::Widget &	tip_widget ()=0

Protected Attributes
std::string	_id
std::string	_name

Detailed Description

Base class for components which provide UI to change an option

Definition at line 125 of file option_editor.h.

Constructor & Destructor Documentation

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 132 of file option_editor.h.

Member Function Documentation

virtual void Option::add_to_page ( OptionEditorPage *  )

pure virtual

Called to instruct the object to add itself to an OptionEditorPage

Implements OptionEditorComponent.

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

std::string Option::id ( ) const

inline

Definition at line 149 of file option_editor.h.

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

inlinevirtual

Called when a configuration parameter's value has changed.

Parameters

p	parameter name

Implements OptionEditorComponent.

Definition at line 139 of file option_editor.h.

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 VisibilityOption, DirectoryOption, ClockOption, FaderOption, SpinOption< T >, BoolComboOption, ComboStringOption, HSliderOption, ComboOption< T >, ComboOption< ARDOUR::SyncSource >, ComboOption< float >, ComboOption< ARDOUR::ListenPosition >, EntryOption, BoolOption, and SearchPathOption.

Member Data Documentation

std::string Option::_id

protected

Definition at line 155 of file option_editor.h.

std::string Option::_name

protected

Definition at line 156 of file option_editor.h.

---

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

• /usr/local/music/src/ardour/4.0/gtk2_ardour/option_editor.h