2 Copyright (C) 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.
20 #ifndef __gtk_ardour_option_editor_h__
21 #define __gtk_ardour_option_editor_h__
23 #include <gtkmm/notebook.h>
24 #include <gtkmm/checkbutton.h>
25 #include <gtkmm/comboboxtext.h>
26 #include <gtkmm/spinbutton.h>
27 #include <gtkmm/table.h>
28 #include "gtkmm2ext/slider_controller.h"
29 #include "ardour_window.h"
30 #include "audio_clock.h"
31 #include "ardour/types.h"
33 /** @file option_editor.h
34 * @brief Base class for option editing dialog boxes.
36 * Code to provided the basis for dialogs which allow the user to edit options
37 * from an ARDOUR::Configuration class.
39 * The idea is that we have an OptionEditor class which is the dialog box.
40 * This is essentially a GTK Notebook. OptionEditorComponent objects can
41 * then be added to the OptionEditor, and these components are arranged on
42 * the pages of the Notebook. There is also an OptionEditorComponent hierarchy
43 * here, providing things like boolean and combobox option components.
45 * It is intended that OptionEditor be subclassed to implement a particular
53 class OptionEditorPage;
55 /** Base class for components of an OptionEditor dialog */
56 class OptionEditorComponent
59 virtual ~OptionEditorComponent() {}
61 /** Called when a configuration parameter's value has changed.
62 * @param p parameter name
64 virtual void parameter_changed (std::string const & p) = 0;
66 /** Called to instruct the object to set its UI state from the configuration */
67 virtual void set_state_from_config () = 0;
69 /** Called to instruct the object to add itself to an OptionEditorPage */
70 virtual void add_to_page (OptionEditorPage *) = 0;
72 void add_widget_to_page (OptionEditorPage*, Gtk::Widget*);
73 void add_widgets_to_page (OptionEditorPage*, Gtk::Widget*, Gtk::Widget*);
75 void set_note (std::string const &);
77 virtual Gtk::Widget& tip_widget() = 0;
80 void maybe_add_note (OptionEditorPage *, int);
85 /** A component which provides a subheading within the dialog */
86 class OptionEditorHeading : public OptionEditorComponent
89 OptionEditorHeading (std::string const &);
91 void parameter_changed (std::string const &) {}
92 void set_state_from_config () {}
93 void add_to_page (OptionEditorPage *);
95 Gtk::Widget& tip_widget() { return *_label; }
98 Gtk::Label* _label; ///< the label used for the heading
101 /** A component which provides a box into which a subclass can put arbitrary widgets */
102 class OptionEditorBox : public OptionEditorComponent
106 /** Construct an OpenEditorBox */
109 _box = Gtk::manage (new Gtk::VBox);
110 _box->set_spacing (4);
113 void parameter_changed (std::string const &) = 0;
114 void set_state_from_config () = 0;
115 void add_to_page (OptionEditorPage *);
117 Gtk::Widget& tip_widget() { return *_box->children().front().get_widget(); }
121 Gtk::VBox* _box; ///< constituent box for subclasses to add widgets to
124 /** Base class for components which provide UI to change an option */
125 class Option : public OptionEditorComponent
128 /** Construct an Option.
129 * @param i Option id (e.g. "plugins-stop-with-transport")
130 * @param n User-visible name (e.g. "Stop plugins when the transport is stopped")
132 Option (std::string const & i,
133 std::string const & n
139 void parameter_changed (std::string const & p)
142 set_state_from_config ();
146 virtual void set_state_from_config () = 0;
147 virtual void add_to_page (OptionEditorPage*) = 0;
149 std::string id () const {
159 /** Component which provides the UI to handle a boolean option using a GTK CheckButton */
160 class BoolOption : public Option
164 BoolOption (std::string const &, std::string const &, sigc::slot<bool>, sigc::slot<bool, bool>);
165 void set_state_from_config ();
166 void add_to_page (OptionEditorPage*);
168 void set_sensitive (bool yn) {
169 _button->set_sensitive (yn);
172 Gtk::Widget& tip_widget() { return *_button; }
178 sigc::slot<bool> _get; ///< slot to get the configuration variable's value
179 sigc::slot<bool, bool> _set; ///< slot to set the configuration variable's value
180 Gtk::CheckButton* _button; ///< UI button
181 Gtk::Label* _label; ///< label for button, so we can use markup
184 /** Component which allows to add any GTK Widget - intended for single buttons and custom stateless objects */
185 class FooOption : public OptionEditorComponent
188 FooOption (Gtk::Widget *w) : _w (w) {}
190 void add_to_page (OptionEditorPage* p) {
191 add_widget_to_page (p, _w);
194 Gtk::Widget& tip_widget() { return *_w; }
195 void set_state_from_config () {}
196 void parameter_changed (std::string const &) {}
201 /** Component which provides the UI to handle a string option using a GTK Entry */
202 class EntryOption : public Option
206 EntryOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
207 void set_state_from_config ();
208 void add_to_page (OptionEditorPage*);
209 void set_sensitive (bool);
210 void set_invalid_chars (std::string i) { _invalid = i; }
212 Gtk::Widget& tip_widget() { return *_entry; }
217 bool focus_out (GdkEventFocus*);
218 void filter_text (const Glib::ustring&, int*);
220 sigc::slot<std::string> _get; ///< slot to get the configuration variable's value
221 sigc::slot<bool, std::string> _set; ///< slot to set the configuration variable's value
222 Gtk::Label* _label; ///< UI label
223 Gtk::Entry* _entry; ///< UI entry
224 std::string _invalid;
228 /** Component which provides the UI to handle an enumerated option using a GTK ComboBox.
229 * The template parameter is the enumeration.
232 class ComboOption : public Option
236 /** Construct an ComboOption.
238 * @param n User-visible name.
239 * @param g Slot to get the variable's value.
240 * @param s Slot to set the variable's value.
243 std::string const & i,
244 std::string const & n,
246 sigc::slot<bool, T> s
252 _label = Gtk::manage (new Gtk::Label (n + ":"));
253 _label->set_alignment (0, 0.5);
254 _combo = Gtk::manage (new Gtk::ComboBoxText);
255 _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboOption::changed));
258 void set_state_from_config () {
260 while (r < _options.size() && _get () != _options[r]) {
264 if (r < _options.size()) {
265 _combo->set_active (r);
269 void add_to_page (OptionEditorPage* p)
271 add_widgets_to_page (p, _label, _combo);
274 /** Add an allowed value for this option.
275 * @param e Enumeration.
276 * @param o User-visible name for this value.
278 void add (T e, std::string const & o) {
279 _options.push_back (e);
280 _combo->append_text (o);
284 _combo->clear_items();
289 uint32_t const r = _combo->get_active_row_number ();
290 if (r < _options.size()) {
295 void set_sensitive (bool yn) {
296 _combo->set_sensitive (yn);
299 Gtk::Widget& tip_widget() { return *_combo; }
304 sigc::slot<bool, T> _set;
306 Gtk::ComboBoxText* _combo;
307 std::vector<T> _options;
311 /** Component which provides the UI for a GTK HScale.
313 class HSliderOption : public Option
317 /** Construct an ComboOption.
319 * @param n User-visible name.
320 * @param g Slot to get the variable's value.
321 * @param s Slot to set the variable's value.
324 std::string const & i,
325 std::string const & n,
330 _label = Gtk::manage (new Gtk::Label (n + ":"));
331 _label->set_alignment (0, 0.5);
332 _hscale = Gtk::manage (new Gtk::HScale(adj));
337 std::string const & i,
338 std::string const & n,
339 Gtk::Adjustment *adj,
341 sigc::slot<bool, float> s
348 _label = Gtk::manage (new Gtk::Label (n + ":"));
349 _label->set_alignment (0, 0.5);
350 _hscale = Gtk::manage (new Gtk::HScale(*_adj));
351 _adj->signal_value_changed().connect (sigc::mem_fun (*this, &HSliderOption::changed));
354 void set_state_from_config () {
355 if (_adj) _adj->set_value (_get());
359 if (_adj) _set (_adj->get_value ());
362 void add_to_page (OptionEditorPage* p)
364 add_widgets_to_page (p, _label, _hscale);
367 void set_sensitive (bool yn) {
368 _hscale->set_sensitive (yn);
371 Gtk::Widget& tip_widget() { return *_hscale; }
372 Gtk::HScale& scale() { return *_hscale; }
375 sigc::slot<float> _get;
376 sigc::slot<bool, float> _set;
378 Gtk::HScale* _hscale;
379 Gtk::Adjustment* _adj;
382 /** Component which provides the UI to handle an enumerated option using a GTK ComboBox.
383 * The template parameter is the enumeration.
385 class ComboStringOption : public Option
389 /** Construct an ComboOption.
391 * @param n User-visible name.
392 * @param g Slot to get the variable's value.
393 * @param s Slot to set the variable's value.
396 std::string const & i,
397 std::string const & n,
398 sigc::slot<std::string> g,
399 sigc::slot<bool, std::string> s
405 _label = Gtk::manage (new Gtk::Label (n + ":"));
406 _label->set_alignment (0, 0.5);
407 _combo = Gtk::manage (new Gtk::ComboBoxText);
408 _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboStringOption::changed));
411 void set_state_from_config () {
412 _combo->set_active_text (_get());
415 void add_to_page (OptionEditorPage* p)
417 add_widgets_to_page (p, _label, _combo);
420 /** Set the allowed strings for this option
421 * @param strings a vector of allowed strings
423 void set_popdown_strings (const std::vector<std::string>& strings) {
424 _combo->clear_items ();
425 for (std::vector<std::string>::const_iterator i = strings.begin(); i != strings.end(); ++i) {
426 _combo->append_text (*i);
431 _combo->clear_items();
435 _set (_combo->get_active_text ());
438 void set_sensitive (bool yn) {
439 _combo->set_sensitive (yn);
442 Gtk::Widget& tip_widget() { return *_combo; }
445 sigc::slot<std::string> _get;
446 sigc::slot<bool, std::string> _set;
448 Gtk::ComboBoxText* _combo;
452 /** Component which provides the UI to handle a boolean option which needs
453 * to be represented as a ComboBox to be clear to the user.
455 class BoolComboOption : public Option
465 sigc::slot<bool, bool>
468 void set_state_from_config ();
469 void add_to_page (OptionEditorPage *);
471 void set_sensitive (bool);
473 Gtk::Widget& tip_widget() { return *_combo; }
477 sigc::slot<bool> _get;
478 sigc::slot<bool, bool> _set;
480 Gtk::ComboBoxText* _combo;
485 /** Component which provides the UI to handle an numeric option using a GTK SpinButton */
487 class SpinOption : public Option
490 /** Construct an SpinOption.
492 * @param n User-visible name.
493 * @param g Slot to get the variable's value.
494 * @param s Slot to set the variable's value.
495 * @param min Variable minimum value.
496 * @param max Variable maximum value.
497 * @param step Step for the spin button.
498 * @param page Page step for the spin button.
499 * @param unit Unit name.
500 * @param scale Scaling factor (such that for a value x in the spinbutton, x * scale is written to the config)
503 std::string const & i,
504 std::string const & n,
506 sigc::slot<bool, T> s,
511 std::string const & unit = "",
519 _label = Gtk::manage (new Gtk::Label (n + ":"));
520 _label->set_alignment (0, 0.5);
522 _spin = Gtk::manage (new Gtk::SpinButton);
523 _spin->set_range (min, max);
524 _spin->set_increments (step, page);
526 _box = Gtk::manage (new Gtk::HBox);
527 _box->pack_start (*_spin, true, true);
528 _box->set_spacing (4);
530 _box->pack_start (*Gtk::manage (new Gtk::Label (unit)), false, false);
533 _spin->signal_value_changed().connect (sigc::mem_fun (*this, &SpinOption::changed));
536 void set_state_from_config ()
538 _spin->set_value (_get () / _scale);
541 void add_to_page (OptionEditorPage* p)
543 add_widgets_to_page (p, _label, _box);
548 _set (static_cast<T> (_spin->get_value ()) * _scale);
551 Gtk::Widget& tip_widget() { return *_spin; }
555 sigc::slot<bool, T> _set;
559 Gtk::SpinButton* _spin;
562 class FaderOption : public Option
566 FaderOption (std::string const &, std::string const &, sigc::slot<ARDOUR::gain_t> g, sigc::slot<bool, ARDOUR::gain_t> s);
567 void set_state_from_config ();
568 void add_to_page (OptionEditorPage *);
570 Gtk::Widget& tip_widget() { return *_db_slider; }
575 Gtk::Adjustment _db_adjustment;
576 Gtkmm2ext::HSliderController* _db_slider;
577 Gtk::Entry _db_display;
580 Gtk::VBox _fader_centering_box;
581 sigc::slot<ARDOUR::gain_t> _get;
582 sigc::slot<bool, ARDOUR::gain_t> _set;
585 class ClockOption : public Option
588 ClockOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
589 void set_state_from_config ();
590 void add_to_page (OptionEditorPage *);
591 void set_session (ARDOUR::Session *);
593 Gtk::Widget& tip_widget() { return _clock; }
594 AudioClock& clock() { return _clock; }
597 void save_clock_time ();
600 sigc::slot<std::string> _get;
601 sigc::slot<bool, std::string> _set;
602 ARDOUR::Session *_session;
605 class DirectoryOption : public Option
608 DirectoryOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
610 void set_state_from_config ();
611 void add_to_page (OptionEditorPage *);
613 Gtk::Widget& tip_widget() { return _file_chooser; }
617 void current_folder_set ();
619 sigc::slot<std::string> _get; ///< slot to get the configuration variable's value
620 sigc::slot<bool, std::string> _set; ///< slot to set the configuration variable's value
621 Gtk::FileChooserButton _file_chooser;
624 /** Class to represent a single page in an OptionEditor's notebook.
625 * Pages are laid out using a 3-column table; the 1st column is used
626 * to indent non-headings, and the 2nd and 3rd for actual content.
628 class OptionEditorPage
631 OptionEditorPage (Gtk::Notebook&, std::string const &);
635 std::list<OptionEditorComponent*> components;
638 /** The OptionEditor dialog base class */
639 class OptionEditor : public ArdourWindow
642 OptionEditor (ARDOUR::Configuration *, std::string const &);
645 void add_option (std::string const &, OptionEditorComponent *);
647 void set_current_page (std::string const &);
651 virtual void parameter_changed (std::string const &);
653 ARDOUR::Configuration* _config;
657 PBD::ScopedConnection config_connection;
659 Gtk::Notebook _notebook;
660 std::map<std::string, OptionEditorPage*> _pages;
663 #endif /* __gtk_ardour_option_editor_h__ */