OptionEditorComponent Class Reference

#include <option_editor.h>

Inheritance diagram for OptionEditorComponent:

Public Member Functions
	OptionEditorComponent ()
virtual	~OptionEditorComponent ()
virtual void	parameter_changed (std::string const &p)=0
virtual void	set_state_from_config ()=0
virtual void	add_to_page (OptionEditorPage *)=0
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 Member Functions
void	maybe_add_note (OptionEditorPage *, int)

Protected Attributes
std::string	_note
ArdourWidgets::Frame *	_frame
PBD::Configuration::Metadata const *	_metadata

Detailed Description

Base class for components of an OptionEditor dialog

Definition at line 70 of file option_editor.h.

Constructor & Destructor Documentation

OptionEditorComponent()

OptionEditorComponent::OptionEditorComponent ( )

inline

Definition at line 73 of file option_editor.h.

~OptionEditorComponent()

virtual OptionEditorComponent::~OptionEditorComponent ( )

inlinevirtual

Definition at line 74 of file option_editor.h.

Member Function Documentation

add_to_page()

virtual void OptionEditorComponent::add_to_page ( OptionEditorPage *  )

pure virtual

Called to instruct the object to add itself to an OptionEditorPage

Implemented in SpinOption< T >, ComboStringOption, HSliderOption, ComboOption< T >, ComboOption< float >, ComboOption< ARDOUR::ListenPosition >, ComboOption< ARDOUR::SampleFormat >, FooOption, Option, SearchPathOption, OptionEditorMiniPage, DirectoryOption, ClockOption, WidgetOption, FaderOption, BoolComboOption, EntryOption, BoolOption, CheckOption, RcActionButton, RcConfigDisplay, OptionEditorBlank, OptionEditorHeading, and ColorThemeManager.

add_widget_to_page()

void OptionEditorComponent::add_widget_to_page	(	OptionEditorPage *	,
		Gtk::Widget *
	)

add_widgets_to_page()

void OptionEditorComponent::add_widgets_to_page	(	OptionEditorPage *	,
		Gtk::Widget *	,
		Gtk::Widget *	,
		bool	expand = true
	)

end_highlight()

void OptionEditorComponent::end_highlight

(

)

get_metadata()

virtual PBD::Configuration::Metadata const* OptionEditorComponent::get_metadata ( ) const

virtual

highlight()

void OptionEditorComponent::highlight

(

)

maybe_add_note()

void OptionEditorComponent::maybe_add_note ( OptionEditorPage *  , int    )

protected

parameter_changed()

virtual void OptionEditorComponent::parameter_changed ( std::string const &  p )

pure virtual

Called when a configuration parameter's value has changed.

Parameters

p	parameter name

Implemented in Option, RcActionButton, RcConfigDisplay, ColorThemeManager, OptionEditorMiniPage, WidgetOption, FooOption, CheckOption, OptionEditorBlank, and OptionEditorHeading.

set_metadata()

void OptionEditorComponent::set_metadata

(

PBD::Configuration::Metadata const &

)

set_note()

void OptionEditorComponent::set_note

(

std::string const &

)

set_state_from_config()

virtual void OptionEditorComponent::set_state_from_config ( )

pure virtual

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

Implemented in OptionEditorMiniPage, Option, SearchPathOption, DirectoryOption, ClockOption, WidgetOption, FaderOption, SpinOption< T >, BoolComboOption, ComboStringOption, HSliderOption, ComboOption< T >, ComboOption< float >, ComboOption< ARDOUR::ListenPosition >, ComboOption< ARDOUR::SampleFormat >, EntryOption, FooOption, BoolOption, CheckOption, RcActionButton, RcConfigDisplay, OptionEditorBlank, OptionEditorHeading, and ColorThemeManager.

tip_widget()

virtual Gtk::Widget& OptionEditorComponent::tip_widget ( )

pure virtual

Implemented in SearchPathOption, OptionEditorMiniPage, DirectoryOption, ClockOption, WidgetOption, FaderOption, SpinOption< T >, BoolComboOption, ComboStringOption, HSliderOption, ComboOption< T >, ComboOption< float >, ComboOption< ARDOUR::ListenPosition >, ComboOption< ARDOUR::SampleFormat >, EntryOption, FooOption, BoolOption, CheckOption, RcActionButton, RcConfigDisplay, OptionEditorBlank, OptionEditorHeading, and ColorThemeManager.

Member Data Documentation

_frame

ArdourWidgets::Frame* OptionEditorComponent::_frame

protected

Definition at line 104 of file option_editor.h.

_metadata

PBD::Configuration::Metadata const* OptionEditorComponent::_metadata

protected

Definition at line 105 of file option_editor.h.

_note

std::string OptionEditorComponent::_note

protected

Definition at line 103 of file option_editor.h.

---

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

• option_editor.h