SpinOption< T > Class Template Reference

#include <option_editor.h>

Inheritance diagram for SpinOption< T >:

Public Member Functions
	SpinOption (std::string const &i, std::string const &n, sigc::slot< T > g, sigc::slot< bool, T > s, T min, T max, T step, T page, std::string const &unit="", float scale=1, unsigned digits=0)
void	set_state_from_config ()
void	add_to_page (OptionEditorPage *p)
void	changed ()
Gtk::Widget &	tip_widget ()
Public Member Functions inherited from Option
	Option (std::string const &i, std::string const &n)
void	parameter_changed (std::string const &p)
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 &)

Private Attributes
sigc::slot< T >	_get
sigc::slot< bool, T >	_set
float	_scale
Gtk::Label *	_label
Gtk::HBox *	_box
Gtk::SpinButton *	_spin

Additional Inherited Members
Protected Attributes inherited from Option
std::string	_id
std::string	_name

Detailed Description

template<class T>
class SpinOption< T >

Component which provides the UI to handle an numeric option using a GTK SpinButton

Definition at line 495 of file option_editor.h.

Constructor & Destructor Documentation

template<class T >

SpinOption< T >::SpinOption ( std::string const &  i, std::string const &  n, sigc::slot< T >  g, sigc::slot< bool, T >  s, T  min, T  max, T  step, T  page, std::string const &  unit = "", float  scale = 1, unsigned  digits = 0  )

inline

Construct an SpinOption.

Parameters

i	id
n	User-visible name.
g	Slot to get the variable's value.
s	Slot to set the variable's value.
min	Variable minimum value.
max	Variable maximum value.
step	Step for the spin button.
page	Page step for the spin button.
unit	Unit name.
scale	Scaling factor (such that for a value x in the spinbutton, x * scale is written to the config)
digits	Number of decimal digits to show.

Definition at line 511 of file option_editor.h.

Member Function Documentation

template<class T >

void SpinOption< T >::add_to_page ( OptionEditorPage *  )

inlinevirtual

Called to instruct the object to add itself to an OptionEditorPage

Implements Option.

Definition at line 552 of file option_editor.h.

template<class T >

void SpinOption< T >::changed ( )

inline

Definition at line 557 of file option_editor.h.

template<class T >

void SpinOption< T >::set_state_from_config ( )

inlinevirtual

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

Implements Option.

Definition at line 547 of file option_editor.h.

template<class T >

Gtk::Widget& SpinOption< T >::tip_widget ( )

inlinevirtual

Implements OptionEditorComponent.

Definition at line 562 of file option_editor.h.

Member Data Documentation

template<class T >

Gtk::HBox* SpinOption< T >::_box

private

Definition at line 569 of file option_editor.h.

template<class T >

sigc::slot<T> SpinOption< T >::_get

private

Definition at line 565 of file option_editor.h.

template<class T >

Gtk::Label* SpinOption< T >::_label

private

Definition at line 568 of file option_editor.h.

template<class T >

float SpinOption< T >::_scale

private

Definition at line 567 of file option_editor.h.

template<class T >

sigc::slot<bool, T> SpinOption< T >::_set

private

Definition at line 566 of file option_editor.h.

template<class T >

Gtk::SpinButton* SpinOption< T >::_spin

private

Definition at line 570 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