2 Copyright (C) 2001-2009 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include <gtkmm/box.h>
22 #include <gtkmm/alignment.h>
23 #include "gtkmm2ext/utils.h"
25 #include "ardour/dB.h"
26 #include "ardour/rc_configuration.h"
27 #include "ardour/session.h"
28 #include "ardour/types.h"
29 #include "ardour/utils.h"
31 #include "pbd/configuration.h"
32 #include "pbd/replace_all.h"
33 #include "pbd/strsplit.h"
35 #include "gui_thread.h"
36 #include "option_editor.h"
37 #include "public_editor.h"
43 using namespace Gtkmm2ext;
44 using namespace ARDOUR;
47 OptionEditorComponent::add_widget_to_page (OptionEditorPage* p, Gtk::Widget* w)
49 int const n = p->table.property_n_rows();
51 if (!_note.empty ()) {
55 p->table.resize (m, 3);
56 p->table.attach (*w, 1, 3, n, n + 1, FILL | EXPAND);
58 maybe_add_note (p, n + 1);
62 OptionEditorComponent::add_widgets_to_page (OptionEditorPage* p, Gtk::Widget* wa, Gtk::Widget* wb, bool expand)
64 int const n = p->table.property_n_rows();
66 if (!_note.empty ()) {
70 p->table.resize (m, 3);
71 p->table.attach (*wa, 1, 2, n, n + 1, FILL);
73 p->table.attach (*wb, 2, 3, n, n + 1, FILL | EXPAND);
75 Alignment* a = manage (new Alignment (0, 0.5, 0, 1.0));
77 p->table.attach (*a, 2, 3, n, n + 1, FILL | EXPAND);
79 maybe_add_note (p, n + 1);
83 OptionEditorComponent::maybe_add_note (OptionEditorPage* p, int n)
85 if (!_note.empty ()) {
86 Gtk::Label* l = manage (left_aligned_label (string_compose (X_("<i>%1</i>"), _note)));
87 l->set_use_markup (true);
88 l->set_line_wrap (true);
89 p->table.attach (*l, 1, 3, n, n + 1, FILL | EXPAND);
94 OptionEditorComponent::set_note (string const & n)
99 /*--------------------------*/
101 OptionEditorHeading::OptionEditorHeading (string const & h)
104 s << "<b>" << h << "</b>";
105 _label = manage (left_aligned_label (s.str()));
106 _label->set_use_markup (true);
109 /*--------------------------*/
112 OptionEditorHeading::add_to_page (OptionEditorPage* p)
114 int const n = p->table.property_n_rows();
115 if (!_note.empty ()) {
116 p->table.resize (n + 3, 3);
118 p->table.resize (n + 2, 3);
121 p->table.attach (*manage (new Label ("")), 0, 3, n, n + 1, FILL | EXPAND);
122 p->table.attach (*_label, 0, 3, n + 1, n + 2, FILL | EXPAND);
123 maybe_add_note (p, n + 2);
126 /*--------------------------*/
129 OptionEditorBlank::add_to_page (OptionEditorPage* p)
131 int const n = p->table.property_n_rows();
132 p->table.resize (n + 1, 3);
133 p->table.attach (_dummy, 2, 3, n, n + 1, FILL | EXPAND, SHRINK, 0, 0);
134 _dummy.set_size_request (-1, 1);
138 /*--------------------------*/
140 RcConfigDisplay::RcConfigDisplay (string const & i, string const & n, sigc::slot<string> g, char s)
145 _label = manage (right_aligned_label (n));
146 _info = manage (new Label);
147 _info-> set_line_wrap (true);
148 set_state_from_config ();
152 RcConfigDisplay::set_state_from_config ()
156 std::replace (p.begin(), p.end(), _sep, '\n');
162 RcConfigDisplay::parameter_changed (std::string const & p)
165 set_state_from_config ();
170 RcConfigDisplay::add_to_page (OptionEditorPage *p)
172 int const n = p->table.property_n_rows();
174 p->table.resize (m, 3);
175 p->table.attach (*_label, 1, 2, n, n + 1, FILL | EXPAND);
176 p->table.attach (*_info, 2, 3, n, n + 1, FILL | EXPAND);
179 /*--------------------------*/
181 RcActionButton::RcActionButton (std::string const & t, const Glib::SignalProxy0< void >::SlotType & slot, std::string const & l)
184 _button = manage (new Button (t));
185 _button->signal_clicked().connect (slot);
187 _label = manage (right_aligned_label (l));
192 RcActionButton::add_to_page (OptionEditorPage *p)
194 int const n = p->table.property_n_rows();
196 p->table.resize (m, 3);
198 p->table.attach (*_label, 1, 2, n, n + 1, FILL | EXPAND);
199 p->table.attach (*_button, 2, 3, n, n + 1, FILL | EXPAND);
201 p->table.attach (*_button, 1, 3, n, n + 1, FILL | EXPAND);
205 /*--------------------------*/
207 CheckOption::CheckOption (string const & i, string const & n, Glib::RefPtr<Gtk::Action> act)
209 _button = manage (new CheckButton);
210 _label = manage (new Label);
211 _label->set_markup (n);
212 _button->add (*_label);
213 _button->signal_toggled().connect (sigc::mem_fun (*this, &CheckOption::toggled));
215 Gtkmm2ext::Activatable::set_related_action (act);
218 action_sensitivity_changed ();
220 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
223 tact->signal_toggled().connect (sigc::mem_fun (*this, &CheckOption::action_toggled));
226 _action->connect_property_changed ("sensitive", sigc::mem_fun (*this, &CheckOption::action_sensitivity_changed));
231 CheckOption::action_toggled ()
233 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
235 _button->set_active(tact->get_active());
240 CheckOption::add_to_page (OptionEditorPage* p)
242 add_widget_to_page (p, _button);
246 CheckOption::toggled ()
248 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
250 tact->set_active( _button->get_active() );
254 /*--------------------------*/
256 BoolOption::BoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
261 _button = manage (new CheckButton);
262 _label = manage (new Label);
263 _label->set_markup (n);
264 _button->add (*_label);
265 _button->set_active (_get ());
266 _button->signal_toggled().connect (sigc::mem_fun (*this, &BoolOption::toggled));
270 BoolOption::add_to_page (OptionEditorPage* p)
272 add_widget_to_page (p, _button);
276 BoolOption::set_state_from_config ()
278 _button->set_active (_get ());
282 BoolOption::toggled ()
284 if (!_set (_button->get_active ())) {
285 _button->set_active (_get ());
289 /*--------------------------*/
291 RouteDisplayBoolOption::RouteDisplayBoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
292 : BoolOption (i, n, g, s)
297 RouteDisplayBoolOption::toggled ()
300 BoolOption::toggled ();
303 /*--------------------------*/
305 EntryOption::EntryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
310 _label = manage (left_aligned_label (n + ":"));
311 _entry = manage (new Entry);
312 _entry->signal_activate().connect (sigc::mem_fun (*this, &EntryOption::activated));
313 _entry->signal_focus_out_event().connect (sigc::mem_fun (*this, &EntryOption::focus_out));
314 _entry->signal_insert_text().connect (sigc::mem_fun (*this, &EntryOption::filter_text));
318 EntryOption::add_to_page (OptionEditorPage* p)
320 add_widgets_to_page (p, _label, _entry);
324 EntryOption::set_state_from_config ()
326 _entry->set_text (_get ());
330 EntryOption::set_sensitive (bool s)
332 _entry->set_sensitive (s);
336 EntryOption::filter_text (const Glib::ustring&, int*)
338 std::string text = _entry->get_text ();
339 for (size_t i = 0; i < _invalid.length(); ++i) {
340 text.erase (std::remove(text.begin(), text.end(), _invalid.at(i)), text.end());
342 if (text != _entry->get_text ()) {
343 _entry->set_text (text);
348 EntryOption::activated ()
350 _set (_entry->get_text ());
354 EntryOption::focus_out (GdkEventFocus*)
356 _set (_entry->get_text ());
360 /*--------------------------*/
361 HSliderOption::HSliderOption (
362 std::string const& i,
363 std::string const& n,
365 sigc::slot<bool, float> s,
366 double lower, double upper,
367 double step_increment,
368 double page_increment,
375 , _adj (lower, lower, upper, step_increment, page_increment, 0)
381 _label.set_alignment (0, 0.5);
382 _label.set_name ("OptionsLabel");
383 _adj.set_value (_get());
384 _adj.signal_value_changed().connect (sigc::mem_fun (*this, &HSliderOption::changed));
385 _hscale.set_update_policy (Gtk::UPDATE_DISCONTINUOUS);
389 HSliderOption::set_state_from_config ()
392 _adj.set_value (log10(_get()) / _mult);
394 _adj.set_value (_get() / _mult);
399 HSliderOption::changed ()
402 _set (pow (10, _adj.get_value () * _mult));
404 _set (_adj.get_value () * _mult);
409 HSliderOption::add_to_page (OptionEditorPage* p)
411 add_widgets_to_page (p, &_label, &_hscale);
415 HSliderOption::set_sensitive (bool yn)
417 _hscale.set_sensitive (yn);
420 /*--------------------------*/
422 ComboStringOption::ComboStringOption (
423 std::string const & i,
424 std::string const & n,
425 sigc::slot<std::string> g,
426 sigc::slot<bool, std::string> s
432 _label = Gtk::manage (new Gtk::Label (n + ":"));
433 _label->set_alignment (0, 0.5);
434 _combo = Gtk::manage (new Gtk::ComboBoxText);
435 _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboStringOption::changed));
439 ComboStringOption::set_state_from_config () {
440 _combo->set_active_text (_get());
444 ComboStringOption::add_to_page (OptionEditorPage* p)
446 add_widgets_to_page (p, _label, _combo);
449 /** Set the allowed strings for this option
450 * @param strings a vector of allowed strings
453 ComboStringOption::set_popdown_strings (const std::vector<std::string>& strings) {
454 _combo->clear_items ();
455 for (std::vector<std::string>::const_iterator i = strings.begin(); i != strings.end(); ++i) {
456 _combo->append_text (*i);
461 ComboStringOption::clear () {
462 _combo->clear_items();
466 ComboStringOption::changed () {
467 _set (_combo->get_active_text ());
471 ComboStringOption::set_sensitive (bool yn) {
472 _combo->set_sensitive (yn);
475 /*--------------------------*/
477 /** Construct a BoolComboOption.
479 * @param n User-visible name.
480 * @param t Text to give for the variable being true.
481 * @param f Text to give for the variable being false.
482 * @param g Slot to get the variable's value.
483 * @param s Slot to set the variable's value.
485 BoolComboOption::BoolComboOption (
486 string const & i, string const & n, string const & t, string const & f,
487 sigc::slot<bool> g, sigc::slot<bool, bool> s
493 _label = manage (new Label (n + ":"));
494 _label->set_alignment (0, 0.5);
495 _combo = manage (new ComboBoxText);
497 /* option 0 is the false option */
498 _combo->append_text (f);
499 /* and option 1 is the true */
500 _combo->append_text (t);
502 _combo->signal_changed().connect (sigc::mem_fun (*this, &BoolComboOption::changed));
506 BoolComboOption::set_state_from_config ()
508 _combo->set_active (_get() ? 1 : 0);
512 BoolComboOption::add_to_page (OptionEditorPage* p)
514 add_widgets_to_page (p, _label, _combo);
518 BoolComboOption::changed ()
520 _set (_combo->get_active_row_number () == 0 ? false : true);
524 BoolComboOption::set_sensitive (bool yn)
526 _combo->set_sensitive (yn);
529 /*--------------------------*/
531 FaderOption::FaderOption (string const & i, string const & n, sigc::slot<gain_t> g, sigc::slot<bool, gain_t> s)
533 , _db_adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
537 _db_slider = manage (new ArdourWidgets::HSliderController (&_db_adjustment, boost::shared_ptr<PBD::Controllable>(), 220, 18));
539 _label.set_text (n + ":");
540 _label.set_alignment (0, 0.5);
541 _label.set_name (X_("OptionsLabel"));
543 _fader_centering_box.pack_start (*_db_slider, true, false);
545 _box.set_spacing (4);
546 _box.set_homogeneous (false);
547 _box.pack_start (_fader_centering_box, false, false);
548 _box.pack_start (_db_display, false, false);
549 _box.pack_start (*manage (new Label ("dB")), false, false);
552 set_size_request_to_display_given_text (_db_display, "-99.00", 12, 0);
554 _db_adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &FaderOption::db_changed));
555 _db_display.signal_activate().connect (sigc::mem_fun (*this, &FaderOption::on_activate));
556 _db_display.signal_key_press_event().connect (sigc::mem_fun (*this, &FaderOption::on_key_press), false);
560 FaderOption::set_state_from_config ()
562 gain_t const val = _get ();
563 _db_adjustment.set_value (gain_to_slider_position_with_max (val, Config->get_max_gain ()));
568 snprintf (buf, sizeof (buf), "-inf");
570 snprintf (buf, sizeof (buf), "%.2f", accurate_coefficient_to_dB (val));
573 _db_display.set_text (buf);
577 FaderOption::db_changed ()
579 _set (slider_position_to_gain_with_max (_db_adjustment.get_value (), Config->get_max_gain()));
583 FaderOption::on_activate ()
585 float db_val = atof (_db_display.get_text ().c_str ());
586 gain_t coeff_val = dB_to_coefficient (db_val);
588 _db_adjustment.set_value (gain_to_slider_position_with_max (coeff_val, Config->get_max_gain ()));
592 FaderOption::on_key_press (GdkEventKey* ev)
594 if (ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (ev->keyval)) {
595 /* drop through to normal handling */
598 /* illegal key for gain entry */
603 FaderOption::add_to_page (OptionEditorPage* p)
605 add_widgets_to_page (p, &_label, &_box);
608 /*--------------------------*/
610 ClockOption::ClockOption (string const & i, string const & n, sigc::slot<std::string> g, sigc::slot<bool, std::string> s)
612 , _clock (X_("timecode-offset"), true, X_(""), true, false, true, false)
616 _label.set_text (n + ":");
617 _label.set_alignment (0, 0.5);
618 _label.set_name (X_("OptionsLabel"));
619 _clock.ValueChanged.connect (sigc::mem_fun (*this, &ClockOption::save_clock_time));
623 ClockOption::set_state_from_config ()
627 if (!Timecode::parse_timecode_format(_get(), TC)) {
628 _clock.set (0, true);
630 TC.rate = _session->samples_per_timecode_frame();
631 TC.drop = _session->timecode_drop_frames();
632 _session->timecode_to_sample(TC, when, false, false);
633 if (TC.negative) { when=-when; }
634 _clock.set (when, true);
638 ClockOption::save_clock_time ()
641 _session->sample_to_timecode(_clock.current_time(), TC, false, false);
642 _set (Timecode::timecode_format_time(TC));
646 ClockOption::add_to_page (OptionEditorPage* p)
648 add_widgets_to_page (p, &_label, &_clock);
652 ClockOption::set_session (Session* s)
655 _clock.set_session (s);
658 /*--------------------------*/
660 WidgetOption::WidgetOption (string const & i, string const & n, Gtk::Widget& w)
667 WidgetOption::add_to_page (OptionEditorPage* p)
669 add_widget_to_page (p, _widget);
672 /*--------------------------*/
674 OptionEditorPage::OptionEditorPage ()
680 OptionEditorPage::OptionEditorPage (Gtk::Notebook& n, std::string const & t)
684 box.pack_start (table, false, false);
685 box.set_border_width (4);
686 n.append_page (box, t);
690 OptionEditorPage::init ()
692 table.set_spacings (4);
693 table.set_col_spacing (0, 32);
696 /*--------------------------*/
699 OptionEditorMiniPage::add_to_page (OptionEditorPage* p)
701 int const n = p->table.property_n_rows();
703 if (!_note.empty ()) {
706 p->table.resize (m, 3);
707 p->table.attach (box, 0, 3, n, n + 1, FILL | EXPAND, SHRINK, 0, 0);
708 maybe_add_note (p, n + 1);
711 /*--------------------------*/
713 /** Construct an OptionEditor.
714 * @param o Configuration to edit.
715 * @param t Title for the dialog.
717 OptionEditor::OptionEditor (PBD::Configuration* c)
719 , option_tree (TreeStore::create (option_columns))
720 , option_treeview (option_tree)
722 using namespace Notebook_Helpers;
724 _notebook.set_show_tabs (false);
725 _notebook.set_show_border (true);
726 _notebook.set_name ("OptionsNotebook");
728 option_treeview.append_column ("", option_columns.name);
729 option_treeview.set_enable_search(true);
730 option_treeview.set_search_column(0);
731 option_treeview.set_name ("OptionsTreeView");
732 option_treeview.set_headers_visible (false);
734 option_treeview.get_selection()->set_mode (Gtk::SELECTION_SINGLE);
735 option_treeview.get_selection()->signal_changed().connect (sigc::mem_fun (*this, &OptionEditor::treeview_row_selected));
737 /* Watch out for changes to parameters */
738 _config->ParameterChanged.connect (config_connection, invalidator (*this), boost::bind (&OptionEditor::parameter_changed, this, _1), gui_context());
741 OptionEditor::~OptionEditor ()
743 for (std::map<std::string, OptionEditorPage*>::iterator i = _pages.begin(); i != _pages.end(); ++i) {
744 for (std::list<OptionEditorComponent*>::iterator j = i->second->components.begin(); j != i->second->components.end(); ++j) {
751 /** Called when a configuration parameter has been changed.
752 * @param p Parameter name.
755 OptionEditor::parameter_changed (std::string const & p)
757 ENSURE_GUI_THREAD (*this, &OptionEditor::parameter_changed, p)
759 for (std::map<std::string, OptionEditorPage*>::iterator i = _pages.begin(); i != _pages.end(); ++i) {
760 for (std::list<OptionEditorComponent*>::iterator j = i->second->components.begin(); j != i->second->components.end(); ++j) {
761 (*j)->parameter_changed (p);
767 OptionEditor::treeview_row_selected ()
769 Glib::RefPtr<Gtk::TreeSelection> selection = option_treeview.get_selection();
770 TreeModel::iterator iter = selection->get_selected();
773 TreeModel::Row row = *iter;
774 Gtk::Widget* w = row[option_columns.widget];
776 _notebook.set_current_page (_notebook.page_num (*w));
782 OptionEditor::find_path_in_treemodel (std::string const & pn, bool create_missing)
784 /* split page name, which is actually a path, into each component */
786 std::vector<std::string> components;
787 split (pn, components, '/');
789 /* start with top level children */
791 TreeModel::Children children = option_tree->children();
792 TreeModel::iterator iter;
794 /* foreach path component ... */
796 for (std::vector<std::string>::const_iterator s = components.begin(); s != components.end(); ++s) {
798 for (iter = children.begin(); iter != children.end(); ++iter) {
799 TreeModel::Row row = *iter;
800 const std::string row_name = row[option_columns.name];
801 if (row_name == (*s)) {
806 if (iter == children.end()) {
807 /* the current component is missing; bail out or create it */
808 if (!create_missing) {
809 return option_tree->get_iter(TreeModel::Path(""));
811 iter = option_tree->append (children);
812 TreeModel::Row row = *iter;
813 row[option_columns.name] = *s;
814 row[option_columns.widget] = 0;
818 /* from now on, iter points to a valid row, either the one we found or a new one */
819 /* set children to the row's children to continue searching */
820 children = (*iter)->children ();
828 OptionEditor::add_path_to_treeview (std::string const & pn, Gtk::Widget& widget)
830 option_treeview.set_model (Glib::RefPtr<TreeStore>());
832 TreeModel::iterator row_iter = find_path_in_treemodel(pn, true);
836 TreeModel::Row row = *row_iter;
837 row[option_columns.widget] = &widget;
839 option_treeview.set_model (option_tree);
840 option_treeview.expand_all ();
843 /** Add a component to a given page.
844 * @param pn Page name (will be created if it doesn't already exist)
845 * @param o Component.
848 OptionEditor::add_option (std::string const & pn, OptionEditorComponent* o)
850 if (_pages.find (pn) == _pages.end()) {
851 OptionEditorPage* oep = new OptionEditorPage (_notebook, pn);
854 add_path_to_treeview (pn, oep->box);
857 OptionEditorPage* p = _pages[pn];
858 p->components.push_back (o);
861 o->set_state_from_config ();
865 * @param pn Page name (will be created if it doesn't already exist)
866 * @param w widget that fills the page
869 OptionEditor::add_page (std::string const & pn, Gtk::Widget& w)
871 if (_pages.find (pn) == _pages.end()) {
872 OptionEditorPage* oep = new OptionEditorPage (_notebook, pn);
874 add_path_to_treeview (pn, oep->box);
877 OptionEditorPage* p = _pages[pn];
878 p->box.pack_start (w, true, true);
882 OptionEditor::set_current_page (string const & p)
884 TreeModel::iterator row_iter = find_path_in_treemodel(p);
887 option_treeview.get_selection()->select(row_iter);
892 /*--------------------------*/
894 DirectoryOption::DirectoryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
899 _file_chooser.set_action (Gtk::FILE_CHOOSER_ACTION_SELECT_FOLDER);
900 _file_chooser.signal_selection_changed().connect (sigc::mem_fun (*this, &DirectoryOption::selection_changed));
904 DirectoryOption::set_state_from_config ()
906 _file_chooser.set_current_folder (poor_mans_glob(_get ()));
910 DirectoryOption::add_to_page (OptionEditorPage* p)
912 Gtk::Label *label = manage (new Label (_name));
913 label->set_alignment (0, 0.5);
914 label->set_name (X_("OptionsLabel"));
915 add_widgets_to_page (p, label, &_file_chooser);
919 DirectoryOption::selection_changed ()
921 _set (poor_mans_glob(_file_chooser.get_filename ()));
924 /*--------------------------*/
926 OptionEditorContainer::OptionEditorContainer (PBD::Configuration* c, string const& str)
929 set_border_width (4);
930 Frame* f = manage (new Frame ());
932 f->set_shadow_type (Gtk::SHADOW_OUT);
933 f->set_border_width (0);
934 hpacker.pack_start (*f, false, false, 4);
935 hpacker.pack_start (notebook(), false, false);
936 pack_start (hpacker, true, true);
941 OptionEditorWindow::OptionEditorWindow (PBD::Configuration* c, string const& str)
945 container.set_border_width (4);
946 Frame* f = manage (new Frame ());
948 f->set_shadow_type (Gtk::SHADOW_OUT);
949 f->set_border_width (0);
950 hpacker.pack_start (*f, false, false);
951 hpacker.pack_start (notebook(), true, true, 4);
953 container.pack_start (hpacker, true, true);