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 "ardour_dialog.h"
30 /** @file option_editor.h
31 * @brief Base class for option editing dialog boxes.
33 * Code to provided the basis for dialogs which allow the user to edit options
34 * from an ARDOUR::Configuration class.
36 * The idea is that we have an OptionEditor class which is the dialog box.
37 * This is essentially a GTK Notebook. OptionEditorComponent objects can
38 * then be added to the OptionEditor, and these components are arranged on
39 * the pages of the Notebook. There is also an OptionEditorComponent hierarchy
40 * here, providing things like boolean and combobox option components.
42 * It is intended that OptionEditor be subclassed to implement a particular
50 class OptionEditorPage;
52 /** Base class for components of an OptionEditor dialog */
53 class OptionEditorComponent
56 /** Called when a configuration parameter's value has changed.
57 * @param p parameter name
59 virtual void parameter_changed (std::string const & p) = 0;
61 /** Called to instruct the object to set its UI state from the configuration */
62 virtual void set_state_from_config () = 0;
64 /** Called to instruct the object to add itself to an OptionEditorPage */
65 virtual void add_to_page (OptionEditorPage *) = 0;
67 void add_widget_to_page (OptionEditorPage*, Gtk::Widget*);
68 void add_widgets_to_page (OptionEditorPage*, Gtk::Widget*, Gtk::Widget*);
71 /** A component which provides a subheading within the dialog */
72 class OptionEditorHeading : public OptionEditorComponent
75 OptionEditorHeading (std::string const &);
77 void parameter_changed (std::string const &) {}
78 void set_state_from_config () {}
79 void add_to_page (OptionEditorPage *);
82 Gtk::Label* _label; ///< the label used for the heading
85 /** A component which provides a box into which a subclass can put arbitrary widgets */
86 class OptionEditorBox : public OptionEditorComponent
90 /** Construct an OpenEditorBox */
93 _box = Gtk::manage (new Gtk::VBox);
94 _box->set_spacing (4);
97 void parameter_changed (std::string const &) = 0;
98 void set_state_from_config () = 0;
99 void add_to_page (OptionEditorPage *);
103 Gtk::VBox* _box; ///< constituent box for subclasses to add widgets to
106 /** Base class for components which provide UI to change an option */
107 class Option : public OptionEditorComponent {
110 /** Construct an Option.
111 * @param i Option id (e.g. "plugins-stop-with-transport")
112 * @param n User-visible name (e.g. "Stop plugins when the transport is stopped")
114 Option (std::string const & i,
115 std::string const & n
121 void parameter_changed (std::string const & p)
124 set_state_from_config ();
128 virtual void set_state_from_config () = 0;
129 virtual void add_to_page (OptionEditorPage*) = 0;
131 std::string id () const {
141 /** Component which provides the UI to handle a boolean option using a GTK CheckButton */
142 class BoolOption : public Option {
146 BoolOption (std::string const &, std::string const &, sigc::slot<bool>, sigc::slot<bool, bool>);
147 void set_state_from_config ();
148 void add_to_page (OptionEditorPage*);
154 sigc::slot<bool> _get; ///< slot to get the configuration variable's value
155 sigc::slot<bool, bool> _set; ///< slot to set the configuration variable's value
156 Gtk::CheckButton* _button; ///< UI button
159 /** Component which provides the UI to handle a string option using a GTK Entry */
160 class EntryOption : public Option {
164 EntryOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
165 void set_state_from_config ();
166 void add_to_page (OptionEditorPage*);
172 sigc::slot<std::string> _get; ///< slot to get the configuration variable's value
173 sigc::slot<bool, std::string> _set; ///< slot to set the configuration variable's value
174 Gtk::Label* _label; ///< UI label
175 Gtk::Entry* _entry; ///< UI entry
179 /** Component which provides the UI to handle an enumerated option using a GTK CheckButton.
180 * The template parameter is the enumeration.
183 class ComboOption : public Option {
187 /** Construct an ComboOption.
189 * @param n User-visible name.
190 * @param g Slot to get the variable's value.
191 * @param s Slot to set the variable's value.
194 std::string const & i,
195 std::string const & n,
197 sigc::slot<bool, T> s
203 _label = manage (new Gtk::Label (n + ":"));
204 _label->set_alignment (1, 0.5);
205 _combo = manage (new Gtk::ComboBoxText);
206 _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboOption::changed));
209 void set_state_from_config () {
211 while (r < _options.size() && _get () != _options[r]) {
215 if (r < _options.size()) {
216 _combo->set_active (r);
220 void add_to_page (OptionEditorPage* p)
222 add_widgets_to_page (p, _label, _combo);
225 /** Add an allowed value for this option.
226 * @param e Enumeration.
227 * @param o User-visible name for this value.
229 void add (T e, std::string const & o) {
230 _options.push_back (e);
231 _combo->append_text (o);
235 uint32_t const r = _combo->get_active_row_number ();
236 if (r < _options.size()) {
244 sigc::slot<bool, T> _set;
246 Gtk::ComboBoxText* _combo;
247 std::vector<T> _options;
251 /** Component which provides the UI to handle an numeric option using a GTK SpinButton */
253 class SpinOption : public Option
256 /** Construct an SpinOption.
258 * @param n User-visible name.
259 * @param g Slot to get the variable's value.
260 * @param s Slot to set the variable's value.
261 * @param min Variable minimum value.
262 * @param max Variable maximum value.
263 * @param step Step for the spin button.
264 * @param page Page step for the spin button.
265 * @param unit Unit name.
266 * @param scale Scaling factor (such that for a value x in the spinbutton, x * scale is written to the config)
269 std::string const & i,
270 std::string const & n,
272 sigc::slot<bool, T> s,
277 std::string const & unit = "",
285 _label = manage (new Gtk::Label (n + ":"));
286 _label->set_alignment (1, 0.5);
288 _spin = manage (new Gtk::SpinButton);
289 _spin->set_range (min, max);
290 _spin->set_increments (step, page);
292 _box = manage (new Gtk::HBox);
293 _box->pack_start (*_spin, true, true);
294 _box->set_spacing (4);
296 _box->pack_start (*manage (new Gtk::Label (unit)), false, false);
299 _spin->signal_value_changed().connect (sigc::mem_fun (*this, &SpinOption::changed));
302 void set_state_from_config ()
304 _spin->set_value (_get () / _scale);
307 void add_to_page (OptionEditorPage* p)
309 add_widgets_to_page (p, _label, _box);
314 _set (static_cast<T> (_spin->get_value ()) * _scale);
319 sigc::slot<bool, T> _set;
323 Gtk::SpinButton* _spin;
326 /** Class to represent a single page in an OptionEditor's notebook.
327 * Pages are laid out using a 3-column table; the 1st column is used
328 * to indent non-headings, and the 2nd and 3rd for actual content.
330 class OptionEditorPage
333 OptionEditorPage (Gtk::Notebook&, std::string const &);
337 std::list<OptionEditorComponent*> components;
340 /** The OptionEditor dialog base class */
341 class OptionEditor : public ArdourDialog
344 OptionEditor (ARDOUR::Configuration *, std::string const &);
347 void add_option (std::string const &, OptionEditorComponent *);
351 ARDOUR::Configuration* _config;
355 void parameter_changed (std::string const &);
357 Gtk::Notebook _notebook;
358 std::map<std::string, OptionEditorPage*> _pages;
361 #endif /* __gtk_ardour_option_editor_h__ */