Ardour  9.0-pre0-582-g084a23a80d
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
OptionEditor Class Reference

#include <option_editor.h>

Inheritance diagram for OptionEditor:
[legend]

Classes

class  OptionColumns
 
struct  SearchResult
 

Public Member Functions

 OptionEditor (PBD::Configuration *)
 
virtual ~OptionEditor ()
 
void add_option (std::string const &, OptionEditorComponent *)
 
void add_page (std::string const &, Gtk::Widget &page_widget)
 
std::string current_page ()
 
void set_current_page (std::string const &)
 
std::map< std::string, OptionEditorPage * > & pages ()
 

Protected Types

typedef std::vector< SearchResult > SearchResults
 
typedef std::vector< std::string > SearchTargets
 

Protected Member Functions

virtual void parameter_changed (std::string const &)
 
Gtk::Notebook & notebook ()
 
Gtk::TreeView & treeview ()
 
void search ()
 
void search_highlight (std::string const &page_title, OptionEditorComponent &)
 
bool not_found_callback ()
 
bool search_key_press (GdkEventKey *)
 
bool search_key_focus (GdkEventFocus *)
 
void not_found ()
 

Protected Attributes

PBD::Configuration * _config
 
OptionColumns option_columns
 
Glib::RefPtr< Gtk::TreeStore > option_tree
 
Gtk::Entry search_entry
 
Gtk::Label search_label
 
Gtk::Button search_button
 
Gtk::HBox search_packer
 
SearchResults * search_results
 
SearchTargets search_targets
 
SearchResults::iterator search_iterator
 
OptionEditorComponent * search_current_highlight
 
std::string last_search_string
 
int search_not_found_count
 
sigc::connection not_found_timeout
 

Private Member Functions

void add_path_to_treeview (std::string const &, Gtk::Widget &)
 
Gtk::TreeModel::iterator find_path_in_treemodel (std::string const &pn, bool create_missing=false)
 
void treeview_row_selected ()
 

Private Attributes

PBD::ScopedConnection config_connection
 
Gtk::Notebook _notebook
 
Gtk::TreeView option_treeview
 
std::map< std::string, OptionEditorPage * > _pages
 

Detailed Description

The OptionEditor dialog base class

Definition at line 708 of file option_editor.h.

Member Typedef Documentation

◆ SearchResults

typedef std::vector<SearchResult> OptionEditor::SearchResults
protected

Definition at line 755 of file option_editor.h.

◆ SearchTargets

typedef std::vector<std::string> OptionEditor::SearchTargets
protected

Definition at line 757 of file option_editor.h.

Constructor & Destructor Documentation

◆ OptionEditor()

OptionEditor::OptionEditor ( PBD::Configuration *  )

◆ ~OptionEditor()

virtual OptionEditor::~OptionEditor ( )
virtual

Member Function Documentation

◆ add_option()

void OptionEditor::add_option ( std::string const &  ,
OptionEditorComponent *   
)

◆ add_page()

void OptionEditor::add_page ( std::string const &  ,
Gtk::Widget &  page_widget 
)

◆ add_path_to_treeview()

void OptionEditor::add_path_to_treeview ( std::string const &  ,
Gtk::Widget &   
)
private

◆ current_page()

std::string OptionEditor::current_page ( )

◆ find_path_in_treemodel()

Gtk::TreeModel::iterator OptionEditor::find_path_in_treemodel ( std::string const &  pn,
bool  create_missing = false 
)
private

◆ not_found()

void OptionEditor::not_found ( )
protected

◆ not_found_callback()

bool OptionEditor::not_found_callback ( )
protected

◆ notebook()

Gtk::Notebook& OptionEditor::notebook ( )
inlineprotected

Definition at line 725 of file option_editor.h.

◆ pages()

std::map<std::string, OptionEditorPage*>& OptionEditor::pages ( )
inline

Definition at line 719 of file option_editor.h.

◆ parameter_changed()

virtual void OptionEditor::parameter_changed ( std::string const &  )
protectedvirtual

Reimplemented in SessionOptionEditor, and RCOptionEditor.

◆ search()

void OptionEditor::search ( )
protected

◆ search_highlight()

void OptionEditor::search_highlight ( std::string const &  page_title,
OptionEditorComponent &   
)
protected

◆ search_key_focus()

bool OptionEditor::search_key_focus ( GdkEventFocus *  )
protected

◆ search_key_press()

bool OptionEditor::search_key_press ( GdkEventKey *  )
protected

◆ set_current_page()

void OptionEditor::set_current_page ( std::string const &  )

◆ treeview()

Gtk::TreeView& OptionEditor::treeview ( )
inlineprotected

Definition at line 726 of file option_editor.h.

◆ treeview_row_selected()

void OptionEditor::treeview_row_selected ( )
private

Member Data Documentation

◆ _config

PBD::Configuration* OptionEditor::_config
protected

Definition at line 724 of file option_editor.h.

◆ _notebook

Gtk::Notebook OptionEditor::_notebook
private

Definition at line 774 of file option_editor.h.

◆ _pages

std::map<std::string, OptionEditorPage*> OptionEditor::_pages
private

Definition at line 776 of file option_editor.h.

◆ config_connection

PBD::ScopedConnection OptionEditor::config_connection
private

Definition at line 773 of file option_editor.h.

◆ last_search_string

std::string OptionEditor::last_search_string
protected

Definition at line 761 of file option_editor.h.

◆ not_found_timeout

sigc::connection OptionEditor::not_found_timeout
protected

Definition at line 763 of file option_editor.h.

◆ option_columns

OptionColumns OptionEditor::option_columns
protected

Definition at line 740 of file option_editor.h.

◆ option_tree

Glib::RefPtr<Gtk::TreeStore> OptionEditor::option_tree
protected

Definition at line 741 of file option_editor.h.

◆ option_treeview

Gtk::TreeView OptionEditor::option_treeview
private

Definition at line 775 of file option_editor.h.

◆ search_button

Gtk::Button OptionEditor::search_button
protected

Definition at line 747 of file option_editor.h.

◆ search_current_highlight

OptionEditorComponent* OptionEditor::search_current_highlight
protected

Definition at line 760 of file option_editor.h.

◆ search_entry

Gtk::Entry OptionEditor::search_entry
protected

Definition at line 745 of file option_editor.h.

◆ search_iterator

SearchResults::iterator OptionEditor::search_iterator
protected

Definition at line 759 of file option_editor.h.

◆ search_label

Gtk::Label OptionEditor::search_label
protected

Definition at line 746 of file option_editor.h.

◆ search_not_found_count

int OptionEditor::search_not_found_count
protected

Definition at line 762 of file option_editor.h.

◆ search_packer

Gtk::HBox OptionEditor::search_packer
protected

Definition at line 748 of file option_editor.h.

◆ search_results

SearchResults* OptionEditor::search_results
protected

Definition at line 756 of file option_editor.h.

◆ search_targets

SearchTargets OptionEditor::search_targets
protected

Definition at line 758 of file option_editor.h.

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