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
183 /** Component which provides the UI to handle a string option using a GTK Entry */
184 class EntryOption : public Option
188 EntryOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
189 void set_state_from_config ();
190 void add_to_page (OptionEditorPage*);
192 Gtk::Widget& tip_widget() { return *_entry; }
198 sigc::slot<std::string> _get; ///< slot to get the configuration variable's value
199 sigc::slot<bool, std::string> _set; ///< slot to set the configuration variable's value
200 Gtk::Label* _label; ///< UI label
201 Gtk::Entry* _entry; ///< UI entry
205 /** Component which provides the UI to handle an enumerated option using a GTK ComboBox.
206 * The template parameter is the enumeration.
209 class ComboOption : public Option
213 /** Construct an ComboOption.
215 * @param n User-visible name.
216 * @param g Slot to get the variable's value.
217 * @param s Slot to set the variable's value.
220 std::string const & i,
221 std::string const & n,
223 sigc::slot<bool, T> s
229 _label = manage (new Gtk::Label (n + ":"));
230 _label->set_alignment (0, 0.5);
231 _combo = manage (new Gtk::ComboBoxText);
232 _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboOption::changed));
235 void set_state_from_config () {
237 while (r < _options.size() && _get () != _options[r]) {
241 if (r < _options.size()) {
242 _combo->set_active (r);
246 void add_to_page (OptionEditorPage* p)
248 add_widgets_to_page (p, _label, _combo);
251 /** Add an allowed value for this option.
252 * @param e Enumeration.
253 * @param o User-visible name for this value.
255 void add (T e, std::string const & o) {
256 _options.push_back (e);
257 _combo->append_text (o);
261 _combo->clear_items();
266 uint32_t const r = _combo->get_active_row_number ();
267 if (r < _options.size()) {
272 void set_sensitive (bool yn) {
273 _combo->set_sensitive (yn);
276 Gtk::Widget& tip_widget() { return *_combo; }
281 sigc::slot<bool, T> _set;
283 Gtk::ComboBoxText* _combo;
284 std::vector<T> _options;
288 /** Component which provides the UI for a GTK HScale.
290 class HSliderOption : public Option
294 /** Construct an ComboOption.
296 * @param n User-visible name.
297 * @param g Slot to get the variable's value.
298 * @param s Slot to set the variable's value.
301 std::string const & i,
302 std::string const & n,
307 _label = manage (new Gtk::Label (n + ":"));
308 _label->set_alignment (0, 0.5);
309 _hscale = manage (new Gtk::HScale(adj));
312 void set_state_from_config () { }
314 void add_to_page (OptionEditorPage* p)
316 add_widgets_to_page (p, _label, _hscale);
319 void set_sensitive (bool yn) {
320 _hscale->set_sensitive (yn);
323 Gtk::Widget& tip_widget() { return *_hscale; }
327 Gtk::HScale* _hscale;
330 /** Component which provides the UI to handle an enumerated option using a GTK ComboBox.
331 * The template parameter is the enumeration.
333 class ComboStringOption : public Option
337 /** Construct an ComboOption.
339 * @param n User-visible name.
340 * @param g Slot to get the variable's value.
341 * @param s Slot to set the variable's value.
344 std::string const & i,
345 std::string const & n,
346 sigc::slot<std::string> g,
347 sigc::slot<bool, std::string> s
353 _label = manage (new Gtk::Label (n + ":"));
354 _label->set_alignment (0, 0.5);
355 _combo = manage (new Gtk::ComboBoxText);
356 _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboStringOption::changed));
359 void set_state_from_config () {
360 _combo->set_active_text (_get());
363 void add_to_page (OptionEditorPage* p)
365 add_widgets_to_page (p, _label, _combo);
368 /** Set the allowed strings for this option
369 * @param strings a vector of allowed strings
371 void set_popdown_strings (const std::vector<std::string>& strings) {
372 _combo->clear_items ();
373 for (std::vector<std::string>::const_iterator i = strings.begin(); i != strings.end(); ++i) {
374 _combo->append_text (*i);
379 _combo->clear_items();
383 _set (_combo->get_active_text ());
386 void set_sensitive (bool yn) {
387 _combo->set_sensitive (yn);
390 Gtk::Widget& tip_widget() { return *_combo; }
393 sigc::slot<std::string> _get;
394 sigc::slot<bool, std::string> _set;
396 Gtk::ComboBoxText* _combo;
400 /** Component which provides the UI to handle a boolean option which needs
401 * to be represented as a ComboBox to be clear to the user.
403 class BoolComboOption : public Option
413 sigc::slot<bool, bool>
416 void set_state_from_config ();
417 void add_to_page (OptionEditorPage *);
419 void set_sensitive (bool);
421 Gtk::Widget& tip_widget() { return *_combo; }
425 sigc::slot<bool> _get;
426 sigc::slot<bool, bool> _set;
428 Gtk::ComboBoxText* _combo;
433 /** Component which provides the UI to handle an numeric option using a GTK SpinButton */
435 class SpinOption : public Option
438 /** Construct an SpinOption.
440 * @param n User-visible name.
441 * @param g Slot to get the variable's value.
442 * @param s Slot to set the variable's value.
443 * @param min Variable minimum value.
444 * @param max Variable maximum value.
445 * @param step Step for the spin button.
446 * @param page Page step for the spin button.
447 * @param unit Unit name.
448 * @param scale Scaling factor (such that for a value x in the spinbutton, x * scale is written to the config)
451 std::string const & i,
452 std::string const & n,
454 sigc::slot<bool, T> s,
459 std::string const & unit = "",
467 _label = manage (new Gtk::Label (n + ":"));
468 _label->set_alignment (0, 0.5);
470 _spin = manage (new Gtk::SpinButton);
471 _spin->set_range (min, max);
472 _spin->set_increments (step, page);
474 _box = manage (new Gtk::HBox);
475 _box->pack_start (*_spin, true, true);
476 _box->set_spacing (4);
478 _box->pack_start (*manage (new Gtk::Label (unit)), false, false);
481 _spin->signal_value_changed().connect (sigc::mem_fun (*this, &SpinOption::changed));
484 void set_state_from_config ()
486 _spin->set_value (_get () / _scale);
489 void add_to_page (OptionEditorPage* p)
491 add_widgets_to_page (p, _label, _box);
496 _set (static_cast<T> (_spin->get_value ()) * _scale);
499 Gtk::Widget& tip_widget() { return *_spin; }
503 sigc::slot<bool, T> _set;
507 Gtk::SpinButton* _spin;
510 class FaderOption : public Option
514 FaderOption (std::string const &, std::string const &, sigc::slot<ARDOUR::gain_t> g, sigc::slot<bool, ARDOUR::gain_t> s);
515 void set_state_from_config ();
516 void add_to_page (OptionEditorPage *);
518 Gtk::Widget& tip_widget() { return *_db_slider; }
523 Gtk::Adjustment _db_adjustment;
524 Gtkmm2ext::HSliderController* _db_slider;
525 Gtk::Entry _db_display;
528 Gtk::VBox _fader_centering_box;
529 sigc::slot<ARDOUR::gain_t> _get;
530 sigc::slot<bool, ARDOUR::gain_t> _set;
533 class ClockOption : public Option
536 ClockOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
537 void set_state_from_config ();
538 void add_to_page (OptionEditorPage *);
539 void set_session (ARDOUR::Session *);
541 Gtk::Widget& tip_widget() { return _clock; }
542 AudioClock& clock() { return _clock; }
545 void save_clock_time ();
548 sigc::slot<std::string> _get;
549 sigc::slot<bool, std::string> _set;
550 ARDOUR::Session *_session;
553 class DirectoryOption : public Option
556 DirectoryOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
558 void set_state_from_config ();
559 void add_to_page (OptionEditorPage *);
561 Gtk::Widget& tip_widget() { return _file_chooser; }
565 void current_folder_set ();
567 sigc::slot<std::string> _get; ///< slot to get the configuration variable's value
568 sigc::slot<bool, std::string> _set; ///< slot to set the configuration variable's value
569 Gtk::FileChooserButton _file_chooser;
572 /** Class to represent a single page in an OptionEditor's notebook.
573 * Pages are laid out using a 3-column table; the 1st column is used
574 * to indent non-headings, and the 2nd and 3rd for actual content.
576 class OptionEditorPage
579 OptionEditorPage (Gtk::Notebook&, std::string const &);
583 std::list<OptionEditorComponent*> components;
586 /** The OptionEditor dialog base class */
587 class OptionEditor : public ArdourWindow
590 OptionEditor (ARDOUR::Configuration *, std::string const &);
593 void add_option (std::string const &, OptionEditorComponent *);
595 void set_current_page (std::string const &);
599 virtual void parameter_changed (std::string const &);
601 ARDOUR::Configuration* _config;
605 PBD::ScopedConnection config_connection;
607 Gtk::Notebook _notebook;
608 std::map<std::string, OptionEditorPage*> _pages;
611 #endif /* __gtk_ardour_option_editor_h__ */