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 _callback_connection = 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));
229 CheckOption::~CheckOption ()
231 _callback_connection.disconnect ();
235 CheckOption::action_toggled ()
237 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
239 _button->set_active (tact->get_active());
244 CheckOption::add_to_page (OptionEditorPage* p)
246 add_widget_to_page (p, _button);
250 CheckOption::toggled ()
252 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic (_action);
254 tact->set_active (_button->get_active ());
258 /*--------------------------*/
260 BoolOption::BoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
265 _button = manage (new CheckButton);
266 _label = manage (new Label);
267 _label->set_markup (n);
268 _button->add (*_label);
269 _button->set_active (_get ());
270 _button->signal_toggled().connect (sigc::mem_fun (*this, &BoolOption::toggled));
274 BoolOption::add_to_page (OptionEditorPage* p)
276 add_widget_to_page (p, _button);
280 BoolOption::set_state_from_config ()
282 _button->set_active (_get ());
286 BoolOption::toggled ()
288 if (!_set (_button->get_active ())) {
289 _button->set_active (_get ());
293 /*--------------------------*/
295 RouteDisplayBoolOption::RouteDisplayBoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
296 : BoolOption (i, n, g, s)
301 RouteDisplayBoolOption::toggled ()
304 BoolOption::toggled ();
307 /*--------------------------*/
309 EntryOption::EntryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
314 _label = manage (left_aligned_label (n + ":"));
315 _entry = manage (new Entry);
316 _entry->signal_activate().connect (sigc::mem_fun (*this, &EntryOption::activated));
317 _entry->signal_focus_out_event().connect (sigc::mem_fun (*this, &EntryOption::focus_out));
318 _entry->signal_insert_text().connect (sigc::mem_fun (*this, &EntryOption::filter_text));
322 EntryOption::add_to_page (OptionEditorPage* p)
324 add_widgets_to_page (p, _label, _entry);
328 EntryOption::set_state_from_config ()
330 _entry->set_text (_get ());
334 EntryOption::set_sensitive (bool s)
336 _entry->set_sensitive (s);
340 EntryOption::filter_text (const Glib::ustring&, int*)
342 std::string text = _entry->get_text ();
343 for (size_t i = 0; i < _invalid.length(); ++i) {
344 text.erase (std::remove(text.begin(), text.end(), _invalid.at(i)), text.end());
346 if (text != _entry->get_text ()) {
347 _entry->set_text (text);
352 EntryOption::activated ()
354 _set (_entry->get_text ());
358 EntryOption::focus_out (GdkEventFocus*)
360 _set (_entry->get_text ());
364 /*--------------------------*/
365 HSliderOption::HSliderOption (
366 std::string const& i,
367 std::string const& n,
369 sigc::slot<bool, float> s,
370 double lower, double upper,
371 double step_increment,
372 double page_increment,
379 , _adj (lower, lower, upper, step_increment, page_increment, 0)
385 _label.set_alignment (0, 0.5);
386 _label.set_name ("OptionsLabel");
387 _adj.set_value (_get());
388 _adj.signal_value_changed().connect (sigc::mem_fun (*this, &HSliderOption::changed));
389 _hscale.set_update_policy (Gtk::UPDATE_DISCONTINUOUS);
393 HSliderOption::set_state_from_config ()
396 _adj.set_value (log10(_get()) / _mult);
398 _adj.set_value (_get() / _mult);
403 HSliderOption::changed ()
406 _set (pow (10, _adj.get_value () * _mult));
408 _set (_adj.get_value () * _mult);
413 HSliderOption::add_to_page (OptionEditorPage* p)
415 add_widgets_to_page (p, &_label, &_hscale);
419 HSliderOption::set_sensitive (bool yn)
421 _hscale.set_sensitive (yn);
424 /*--------------------------*/
426 ComboStringOption::ComboStringOption (
427 std::string const & i,
428 std::string const & n,
429 sigc::slot<std::string> g,
430 sigc::slot<bool, std::string> s
436 _label = Gtk::manage (new Gtk::Label (n + ":"));
437 _label->set_alignment (0, 0.5);
438 _combo = Gtk::manage (new Gtk::ComboBoxText);
439 _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboStringOption::changed));
443 ComboStringOption::set_state_from_config () {
444 _combo->set_active_text (_get());
448 ComboStringOption::add_to_page (OptionEditorPage* p)
450 add_widgets_to_page (p, _label, _combo);
453 /** Set the allowed strings for this option
454 * @param strings a vector of allowed strings
457 ComboStringOption::set_popdown_strings (const std::vector<std::string>& strings) {
458 _combo->clear_items ();
459 for (std::vector<std::string>::const_iterator i = strings.begin(); i != strings.end(); ++i) {
460 _combo->append_text (*i);
465 ComboStringOption::clear () {
466 _combo->clear_items();
470 ComboStringOption::changed () {
471 _set (_combo->get_active_text ());
475 ComboStringOption::set_sensitive (bool yn) {
476 _combo->set_sensitive (yn);
479 /*--------------------------*/
481 /** Construct a BoolComboOption.
483 * @param n User-visible name.
484 * @param t Text to give for the variable being true.
485 * @param f Text to give for the variable being false.
486 * @param g Slot to get the variable's value.
487 * @param s Slot to set the variable's value.
489 BoolComboOption::BoolComboOption (
490 string const & i, string const & n, string const & t, string const & f,
491 sigc::slot<bool> g, sigc::slot<bool, bool> s
497 _label = manage (new Label (n + ":"));
498 _label->set_alignment (0, 0.5);
499 _combo = manage (new ComboBoxText);
501 /* option 0 is the false option */
502 _combo->append_text (f);
503 /* and option 1 is the true */
504 _combo->append_text (t);
506 _combo->signal_changed().connect (sigc::mem_fun (*this, &BoolComboOption::changed));
510 BoolComboOption::set_state_from_config ()
512 _combo->set_active (_get() ? 1 : 0);
516 BoolComboOption::add_to_page (OptionEditorPage* p)
518 add_widgets_to_page (p, _label, _combo);
522 BoolComboOption::changed ()
524 _set (_combo->get_active_row_number () == 0 ? false : true);
528 BoolComboOption::set_sensitive (bool yn)
530 _combo->set_sensitive (yn);
533 /*--------------------------*/
535 FaderOption::FaderOption (string const & i, string const & n, sigc::slot<gain_t> g, sigc::slot<bool, gain_t> s)
537 , _db_adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
541 _db_slider = manage (new ArdourWidgets::HSliderController (&_db_adjustment, boost::shared_ptr<PBD::Controllable>(), 220, 18));
543 _label.set_text (n + ":");
544 _label.set_alignment (0, 0.5);
545 _label.set_name (X_("OptionsLabel"));
547 _fader_centering_box.pack_start (*_db_slider, true, false);
549 _box.set_spacing (4);
550 _box.set_homogeneous (false);
551 _box.pack_start (_fader_centering_box, false, false);
552 _box.pack_start (_db_display, false, false);
553 _box.pack_start (*manage (new Label ("dB")), false, false);
556 set_size_request_to_display_given_text (_db_display, "-99.00", 12, 0);
558 _db_adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &FaderOption::db_changed));
559 _db_display.signal_activate().connect (sigc::mem_fun (*this, &FaderOption::on_activate));
560 _db_display.signal_key_press_event().connect (sigc::mem_fun (*this, &FaderOption::on_key_press), false);
564 FaderOption::set_state_from_config ()
566 gain_t const val = _get ();
567 _db_adjustment.set_value (gain_to_slider_position_with_max (val, Config->get_max_gain ()));
572 snprintf (buf, sizeof (buf), "-inf");
574 snprintf (buf, sizeof (buf), "%.2f", accurate_coefficient_to_dB (val));
577 _db_display.set_text (buf);
581 FaderOption::db_changed ()
583 _set (slider_position_to_gain_with_max (_db_adjustment.get_value (), Config->get_max_gain()));
587 FaderOption::on_activate ()
589 float db_val = atof (_db_display.get_text ().c_str ());
590 gain_t coeff_val = dB_to_coefficient (db_val);
592 _db_adjustment.set_value (gain_to_slider_position_with_max (coeff_val, Config->get_max_gain ()));
596 FaderOption::on_key_press (GdkEventKey* ev)
598 if (ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (ev->keyval)) {
599 /* drop through to normal handling */
602 /* illegal key for gain entry */
607 FaderOption::add_to_page (OptionEditorPage* p)
609 add_widgets_to_page (p, &_label, &_box);
612 /*--------------------------*/
614 ClockOption::ClockOption (string const & i, string const & n, sigc::slot<std::string> g, sigc::slot<bool, std::string> s)
616 , _clock (X_("timecode-offset"), true, X_(""), true, false, true, false)
620 _label.set_text (n + ":");
621 _label.set_alignment (0, 0.5);
622 _label.set_name (X_("OptionsLabel"));
623 _clock.ValueChanged.connect (sigc::mem_fun (*this, &ClockOption::save_clock_time));
627 ClockOption::set_state_from_config ()
631 if (!Timecode::parse_timecode_format(_get(), TC)) {
632 _clock.set (0, true);
634 TC.rate = _session->samples_per_timecode_frame();
635 TC.drop = _session->timecode_drop_frames();
636 _session->timecode_to_sample(TC, when, false, false);
637 if (TC.negative) { when=-when; }
638 _clock.set (when, true);
642 ClockOption::save_clock_time ()
645 _session->sample_to_timecode(_clock.current_time(), TC, false, false);
646 _set (Timecode::timecode_format_time(TC));
650 ClockOption::add_to_page (OptionEditorPage* p)
652 add_widgets_to_page (p, &_label, &_clock);
656 ClockOption::set_session (Session* s)
659 _clock.set_session (s);
662 /*--------------------------*/
664 WidgetOption::WidgetOption (string const & i, string const & n, Gtk::Widget& w)
671 WidgetOption::add_to_page (OptionEditorPage* p)
673 add_widget_to_page (p, _widget);
676 /*--------------------------*/
678 OptionEditorPage::OptionEditorPage ()
684 OptionEditorPage::OptionEditorPage (Gtk::Notebook& n, std::string const & t)
688 box.pack_start (table, false, false);
689 box.set_border_width (4);
690 n.append_page (box, t);
694 OptionEditorPage::init ()
696 table.set_spacings (4);
697 table.set_col_spacing (0, 32);
700 /*--------------------------*/
703 OptionEditorMiniPage::add_to_page (OptionEditorPage* p)
705 int const n = p->table.property_n_rows();
707 if (!_note.empty ()) {
710 p->table.resize (m, 3);
711 p->table.attach (box, 0, 3, n, n + 1, FILL | EXPAND, SHRINK, 0, 0);
712 maybe_add_note (p, n + 1);
715 /*--------------------------*/
717 /** Construct an OptionEditor.
718 * @param o Configuration to edit.
719 * @param t Title for the dialog.
721 OptionEditor::OptionEditor (PBD::Configuration* c)
723 , option_tree (TreeStore::create (option_columns))
724 , option_treeview (option_tree)
726 using namespace Notebook_Helpers;
728 _notebook.set_show_tabs (false);
729 _notebook.set_show_border (true);
730 _notebook.set_name ("OptionsNotebook");
732 option_treeview.append_column ("", option_columns.name);
733 option_treeview.set_enable_search(true);
734 option_treeview.set_search_column(0);
735 option_treeview.set_name ("OptionsTreeView");
736 option_treeview.set_headers_visible (false);
738 option_treeview.get_selection()->set_mode (Gtk::SELECTION_SINGLE);
739 option_treeview.get_selection()->signal_changed().connect (sigc::mem_fun (*this, &OptionEditor::treeview_row_selected));
741 /* Watch out for changes to parameters */
742 _config->ParameterChanged.connect (config_connection, invalidator (*this), boost::bind (&OptionEditor::parameter_changed, this, _1), gui_context());
745 OptionEditor::~OptionEditor ()
747 for (std::map<std::string, OptionEditorPage*>::iterator i = _pages.begin(); i != _pages.end(); ++i) {
748 for (std::list<OptionEditorComponent*>::iterator j = i->second->components.begin(); j != i->second->components.end(); ++j) {
755 /** Called when a configuration parameter has been changed.
756 * @param p Parameter name.
759 OptionEditor::parameter_changed (std::string const & p)
761 ENSURE_GUI_THREAD (*this, &OptionEditor::parameter_changed, p)
763 for (std::map<std::string, OptionEditorPage*>::iterator i = _pages.begin(); i != _pages.end(); ++i) {
764 for (std::list<OptionEditorComponent*>::iterator j = i->second->components.begin(); j != i->second->components.end(); ++j) {
765 (*j)->parameter_changed (p);
771 OptionEditor::treeview_row_selected ()
773 Glib::RefPtr<Gtk::TreeSelection> selection = option_treeview.get_selection();
774 TreeModel::iterator iter = selection->get_selected();
777 TreeModel::Row row = *iter;
778 Gtk::Widget* w = row[option_columns.widget];
780 _notebook.set_current_page (_notebook.page_num (*w));
786 OptionEditor::find_path_in_treemodel (std::string const & pn, bool create_missing)
788 /* split page name, which is actually a path, into each component */
790 std::vector<std::string> components;
791 split (pn, components, '/');
793 /* start with top level children */
795 TreeModel::Children children = option_tree->children();
796 TreeModel::iterator iter;
798 /* foreach path component ... */
800 for (std::vector<std::string>::const_iterator s = components.begin(); s != components.end(); ++s) {
802 for (iter = children.begin(); iter != children.end(); ++iter) {
803 TreeModel::Row row = *iter;
804 const std::string row_name = row[option_columns.name];
805 if (row_name == (*s)) {
810 if (iter == children.end()) {
811 /* the current component is missing; bail out or create it */
812 if (!create_missing) {
813 return option_tree->get_iter(TreeModel::Path(""));
815 iter = option_tree->append (children);
816 TreeModel::Row row = *iter;
817 row[option_columns.name] = *s;
818 row[option_columns.widget] = 0;
822 /* from now on, iter points to a valid row, either the one we found or a new one */
823 /* set children to the row's children to continue searching */
824 children = (*iter)->children ();
832 OptionEditor::add_path_to_treeview (std::string const & pn, Gtk::Widget& widget)
834 option_treeview.set_model (Glib::RefPtr<TreeStore>());
836 TreeModel::iterator row_iter = find_path_in_treemodel(pn, true);
840 TreeModel::Row row = *row_iter;
841 row[option_columns.widget] = &widget;
843 option_treeview.set_model (option_tree);
844 option_treeview.expand_all ();
847 /** Add a component to a given page.
848 * @param pn Page name (will be created if it doesn't already exist)
849 * @param o Component.
852 OptionEditor::add_option (std::string const & pn, OptionEditorComponent* o)
854 if (_pages.find (pn) == _pages.end()) {
855 OptionEditorPage* oep = new OptionEditorPage (_notebook, pn);
858 add_path_to_treeview (pn, oep->box);
861 OptionEditorPage* p = _pages[pn];
862 p->components.push_back (o);
865 o->set_state_from_config ();
869 * @param pn Page name (will be created if it doesn't already exist)
870 * @param w widget that fills the page
873 OptionEditor::add_page (std::string const & pn, Gtk::Widget& w)
875 if (_pages.find (pn) == _pages.end()) {
876 OptionEditorPage* oep = new OptionEditorPage (_notebook, pn);
878 add_path_to_treeview (pn, oep->box);
881 OptionEditorPage* p = _pages[pn];
882 p->box.pack_start (w, true, true);
886 OptionEditor::set_current_page (string const & p)
888 TreeModel::iterator row_iter = find_path_in_treemodel(p);
891 option_treeview.get_selection()->select(row_iter);
896 /*--------------------------*/
898 DirectoryOption::DirectoryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
903 _file_chooser.set_action (Gtk::FILE_CHOOSER_ACTION_SELECT_FOLDER);
904 _file_chooser.signal_selection_changed().connect (sigc::mem_fun (*this, &DirectoryOption::selection_changed));
908 DirectoryOption::set_state_from_config ()
910 _file_chooser.set_current_folder (poor_mans_glob(_get ()));
914 DirectoryOption::add_to_page (OptionEditorPage* p)
916 Gtk::Label *label = manage (new Label (_name));
917 label->set_alignment (0, 0.5);
918 label->set_name (X_("OptionsLabel"));
919 add_widgets_to_page (p, label, &_file_chooser);
923 DirectoryOption::selection_changed ()
925 _set (poor_mans_glob(_file_chooser.get_filename ()));
928 /*--------------------------*/
930 OptionEditorContainer::OptionEditorContainer (PBD::Configuration* c, string const& str)
933 set_border_width (4);
934 Frame* f = manage (new Frame ());
936 f->set_shadow_type (Gtk::SHADOW_OUT);
937 f->set_border_width (0);
938 hpacker.pack_start (*f, false, false, 4);
939 hpacker.pack_start (notebook(), false, false);
940 pack_start (hpacker, true, true);
945 OptionEditorWindow::OptionEditorWindow (PBD::Configuration* c, string const& str)
949 container.set_border_width (4);
950 Frame* f = manage (new Frame ());
952 f->set_shadow_type (Gtk::SHADOW_OUT);
953 f->set_border_width (0);
954 hpacker.pack_start (*f, false, false);
955 hpacker.pack_start (notebook(), true, true, 4);
957 container.pack_start (hpacker, true, true);