Ardour  9.0-pre0-582-g084a23a80d
BoolOption Class Reference

#include <option_editor.h>

Inheritance diagram for BoolOption:
[legend]

Public Member Functions

 BoolOption (std::string const &, std::string const &, sigc::slot< bool >, sigc::slot< bool, bool >)
 
void set_state_from_config ()
 
void add_to_page (OptionEditorPage *)
 
void set_sensitive (bool yn)
 
Gtk::Widgettip_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
 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 PBD::Configuration::Metadata const * get_metadata () const
 
void set_metadata (PBD::Configuration::Metadata const &)
 
void highlight ()
 
void end_highlight ()
 

Protected Member Functions

virtual void toggled ()
 
- Protected Member Functions inherited from OptionEditorComponent
void maybe_add_note (OptionEditorPage *, int)
 

Protected Attributes

sigc::slot< bool > _get
 slot to get the configuration variable's value More...
 
sigc::slot< bool, bool > _set
 slot to set the configuration variable's value More...
 
Gtk::CheckButton_button
 UI button. More...
 
Gtk::Label_label
 label for button, so we can use markup More...
 
- Protected Attributes inherited from Option
std::string _id
 
std::string _name
 
- Protected Attributes inherited from OptionEditorComponent
std::string _note
 
ArdourWidgets::Frame_frame
 
PBD::Configuration::Metadata const * _metadata
 

Detailed Description

Component which provides the UI to handle a boolean option using a GTK CheckButton

Definition at line 233 of file option_editor.h.

Constructor & Destructor Documentation

◆ BoolOption()

BoolOption::BoolOption ( std::string const &  ,
std::string const &  ,
sigc::slot< bool >  ,
sigc::slot< bool, bool >   
)

Member Function Documentation

◆ add_to_page()

void BoolOption::add_to_page ( OptionEditorPage )
virtual

Called to instruct the object to add itself to an OptionEditorPage

Implements Option.

◆ set_sensitive()

void BoolOption::set_sensitive ( bool  yn)
inline

Definition at line 240 of file option_editor.h.

◆ set_state_from_config()

void BoolOption::set_state_from_config ( )
virtual

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

Implements Option.

◆ tip_widget()

Gtk::Widget& BoolOption::tip_widget ( )
inlinevirtual

Implements OptionEditorComponent.

Definition at line 244 of file option_editor.h.

◆ toggled()

virtual void BoolOption::toggled ( )
protectedvirtual

Reimplemented in RouteDisplayBoolOption.

Member Data Documentation

◆ _button

Gtk::CheckButton* BoolOption::_button
protected

UI button.

Definition at line 251 of file option_editor.h.

◆ _get

sigc::slot<bool> BoolOption::_get
protected

slot to get the configuration variable's value

Definition at line 249 of file option_editor.h.

◆ _label

Gtk::Label* BoolOption::_label
protected

label for button, so we can use markup

Definition at line 252 of file option_editor.h.

◆ _set

sigc::slot<bool, bool> BoolOption::_set
protected

slot to set the configuration variable's value

Definition at line 250 of file option_editor.h.


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