gtk2_ardour/option_editor.h

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __gtk_ardour_option_editor_h__
  21 #define __gtk_ardour_option_editor_h__
  22
  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"
  32
  33 /** @file option_editor.h
  34  *  @brief Base class for option editing dialog boxes.
  35  *
  36  *  Code to provided the basis for dialogs which allow the user to edit options
  37  *  from an ARDOUR::Configuration class.
  38  *
  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.
  44  *
  45  *  It is intended that OptionEditor be subclassed to implement a particular
  46  *  options dialog.
  47  */
  48
  49 namespace ARDOUR {
  50         class Configuration;
  51 }
  52
  53 class OptionEditorPage;
  54
  55 /** Base class for components of an OptionEditor dialog */
  56 class OptionEditorComponent
  57 {
  58 public:
  59         virtual ~OptionEditorComponent() {}
  60
  61         /** Called when a configuration parameter's value has changed.
  62          *  @param p parameter name
  63          */
  64         virtual void parameter_changed (std::string const & p) = 0;
  65
  66         /** Called to instruct the object to set its UI state from the configuration */
  67         virtual void set_state_from_config () = 0;
  68
  69         /** Called to instruct the object to add itself to an OptionEditorPage */
  70         virtual void add_to_page (OptionEditorPage *) = 0;
  71
  72         void add_widget_to_page (OptionEditorPage*, Gtk::Widget*);
  73         void add_widgets_to_page (OptionEditorPage*, Gtk::Widget*, Gtk::Widget*);
  74
  75         void set_note (std::string const &);
  76
  77         virtual Gtk::Widget& tip_widget() = 0;
  78
  79 private:
  80         void maybe_add_note (OptionEditorPage *, int);
  81
  82         std::string _note;
  83 };
  84
  85 /** A component which provides a subheading within the dialog */
  86 class OptionEditorHeading : public OptionEditorComponent
  87 {
  88 public:
  89         OptionEditorHeading (std::string const &);
  90
  91         void parameter_changed (std::string const &) {}
  92         void set_state_from_config () {}
  93         void add_to_page (OptionEditorPage *);
  94
  95         Gtk::Widget& tip_widget() { return *_label; }
  96
  97 private:
  98         Gtk::Label* _label; ///< the label used for the heading
  99 };
 100
 101 /** A component which provides a box into which a subclass can put arbitrary widgets */
 102 class OptionEditorBox : public OptionEditorComponent
 103 {
 104 public:
 105
 106         /** Construct an OpenEditorBox */
 107         OptionEditorBox ()
 108         {
 109                 _box = Gtk::manage (new Gtk::VBox);
 110                 _box->set_spacing (4);
 111         }
 112
 113         void parameter_changed (std::string const &) = 0;
 114         void set_state_from_config () = 0;
 115         void add_to_page (OptionEditorPage *);
 116
 117         Gtk::Widget& tip_widget() { return *_box->children().front().get_widget(); }
 118
 119 protected:
 120
 121         Gtk::VBox* _box; ///< constituent box for subclasses to add widgets to
 122 };
 123
 124 /** Base class for components which provide UI to change an option */
 125 class Option : public OptionEditorComponent
 126 {
 127 public:
 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")
 131          */
 132         Option (std::string const & i,
 133                 std::string const & n
 134                 )
 135                 : _id (i),
 136                   _name (n)
 137         {}
 138
 139         void parameter_changed (std::string const & p)
 140         {
 141                 if (p == _id) {
 142                         set_state_from_config ();
 143                 }
 144         }
 145
 146         virtual void set_state_from_config () = 0;
 147         virtual void add_to_page (OptionEditorPage*) = 0;
 148
 149         std::string id () const {
 150                 return _id;
 151         }
 152
 153 protected:
 154
 155         std::string _id;
 156         std::string _name;
 157 };
 158
 159 /** Component which provides the UI to handle a boolean option using a GTK CheckButton */
 160 class BoolOption : public Option
 161 {
 162 public:
 163
 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*);
 167
 168         void set_sensitive (bool yn) {
 169                 _button->set_sensitive (yn);
 170         }
 171
 172         Gtk::Widget& tip_widget() { return *_button; }
 173
 174 private:
 175
 176         void toggled ();
 177
 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
 182 };
 183
 184 /** Component which provides the UI to handle a string option using a GTK Entry */
 185 class EntryOption : public Option
 186 {
 187 public:
 188
 189         EntryOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
 190         void set_state_from_config ();
 191         void add_to_page (OptionEditorPage*);
 192
 193         Gtk::Widget& tip_widget() { return *_entry; }
 194
 195 private:
 196
 197         void activated ();
 198
 199         sigc::slot<std::string> _get; ///< slot to get the configuration variable's value
 200         sigc::slot<bool, std::string> _set;  ///< slot to set the configuration variable's value
 201         Gtk::Label* _label; ///< UI label
 202         Gtk::Entry* _entry; ///< UI entry
 203 };
 204
 205
 206 /** Component which provides the UI to handle an enumerated option using a GTK ComboBox.
 207  *  The template parameter is the enumeration.
 208  */
 209 template <class T>
 210 class ComboOption : public Option
 211 {
 212 public:
 213
 214         /** Construct an ComboOption.
 215          *  @param i id
 216          *  @param n User-visible name.
 217          *  @param g Slot to get the variable's value.
 218          *  @param s Slot to set the variable's value.
 219          */
 220         ComboOption (
 221                 std::string const & i,
 222                 std::string const & n,
 223                 sigc::slot<T> g,
 224                 sigc::slot<bool, T> s
 225                 )
 226                 : Option (i, n),
 227                   _get (g),
 228                   _set (s)
 229         {
 230                 _label = manage (new Gtk::Label (n + ":"));
 231                 _label->set_alignment (0, 0.5);
 232                 _combo = manage (new Gtk::ComboBoxText);
 233                 _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboOption::changed));
 234         }
 235
 236         void set_state_from_config () {
 237                 uint32_t r = 0;
 238                 while (r < _options.size() && _get () != _options[r]) {
 239                         ++r;
 240                 }
 241
 242                 if (r < _options.size()) {
 243                         _combo->set_active (r);
 244                 }
 245         }
 246
 247         void add_to_page (OptionEditorPage* p)
 248         {
 249                 add_widgets_to_page (p, _label, _combo);
 250         }
 251
 252         /** Add an allowed value for this option.
 253          *  @param e Enumeration.
 254          *  @param o User-visible name for this value.
 255          */
 256         void add (T e, std::string const & o) {
 257                 _options.push_back (e);
 258                 _combo->append_text (o);
 259         }
 260
 261         void clear () {
 262                 _combo->clear_items();
 263                 _options.clear ();
 264         }
 265
 266         void changed () {
 267                 uint32_t const r = _combo->get_active_row_number ();
 268                 if (r < _options.size()) {
 269                         _set (_options[r]);
 270                 }
 271         }
 272
 273         void set_sensitive (bool yn) {
 274                 _combo->set_sensitive (yn);
 275         }
 276
 277         Gtk::Widget& tip_widget() { return *_combo; }
 278
 279 private:
 280
 281         sigc::slot<T> _get;
 282         sigc::slot<bool, T> _set;
 283         Gtk::Label* _label;
 284         Gtk::ComboBoxText* _combo;
 285         std::vector<T> _options;
 286 };
 287
 288
 289 /** Component which provides the UI for a GTK HScale.
 290  */
 291 class HSliderOption : public Option
 292 {
 293 public:
 294
 295         /** Construct an ComboOption.
 296          *  @param i id
 297          *  @param n User-visible name.
 298          *  @param g Slot to get the variable's value.
 299          *  @param s Slot to set the variable's value.
 300          */
 301         HSliderOption (
 302                 std::string const & i,
 303                 std::string const & n,
 304                 Gtk::Adjustment &adj
 305                 )
 306                 : Option (i, n)
 307         {
 308                 _label = manage (new Gtk::Label (n + ":"));
 309                 _label->set_alignment (0, 0.5);
 310                 _hscale = manage (new Gtk::HScale(adj));
 311         }
 312
 313         void set_state_from_config () { }
 314
 315         void add_to_page (OptionEditorPage* p)
 316         {
 317                 add_widgets_to_page (p, _label, _hscale);
 318         }
 319
 320         void set_sensitive (bool yn) {
 321                 _hscale->set_sensitive (yn);
 322         }
 323
 324         Gtk::Widget& tip_widget() { return *_hscale; }
 325
 326 private:
 327         Gtk::Label* _label;
 328         Gtk::HScale* _hscale;
 329 };
 330
 331 /** Component which provides the UI to handle an enumerated option using a GTK ComboBox.
 332  *  The template parameter is the enumeration.
 333  */
 334 class ComboStringOption : public Option
 335 {
 336 public:
 337
 338         /** Construct an ComboOption.
 339          *  @param i id
 340          *  @param n User-visible name.
 341          *  @param g Slot to get the variable's value.
 342          *  @param s Slot to set the variable's value.
 343          */
 344         ComboStringOption (
 345                 std::string const & i,
 346                 std::string const & n,
 347                 sigc::slot<std::string> g,
 348                 sigc::slot<bool, std::string> s
 349                 )
 350                 : Option (i, n),
 351                   _get (g),
 352                   _set (s)
 353         {
 354                 _label = manage (new Gtk::Label (n + ":"));
 355                 _label->set_alignment (0, 0.5);
 356                 _combo = manage (new Gtk::ComboBoxText);
 357                 _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboStringOption::changed));
 358         }
 359
 360         void set_state_from_config () {
 361                 _combo->set_active_text (_get());
 362         }
 363
 364         void add_to_page (OptionEditorPage* p)
 365         {
 366                 add_widgets_to_page (p, _label, _combo);
 367         }
 368
 369         /** Set the allowed strings for this option
 370          *  @param strings a vector of allowed strings
 371          */
 372         void set_popdown_strings (const std::vector<std::string>& strings) {
 373                 _combo->clear_items ();
 374                 for (std::vector<std::string>::const_iterator i = strings.begin(); i != strings.end(); ++i) {
 375                         _combo->append_text (*i);
 376                 }
 377         }
 378
 379         void clear () {
 380                 _combo->clear_items();
 381         }
 382
 383         void changed () {
 384                 _set (_combo->get_active_text ());
 385         }
 386
 387         void set_sensitive (bool yn) {
 388                 _combo->set_sensitive (yn);
 389         }
 390
 391         Gtk::Widget& tip_widget() { return *_combo; }
 392
 393 private:
 394         sigc::slot<std::string> _get;
 395         sigc::slot<bool, std::string> _set;
 396         Gtk::Label* _label;
 397         Gtk::ComboBoxText* _combo;
 398 };
 399
 400
 401 /** Component which provides the UI to handle a boolean option which needs
 402  *  to be represented as a ComboBox to be clear to the user.
 403  */
 404 class BoolComboOption : public Option
 405 {
 406 public:
 407
 408         BoolComboOption (
 409                 std::string const &,
 410                 std::string const &,
 411                 std::string const &,
 412                 std::string const &,
 413                 sigc::slot<bool>,
 414                 sigc::slot<bool, bool>
 415                 );
 416
 417         void set_state_from_config ();
 418         void add_to_page (OptionEditorPage *);
 419         void changed ();
 420         void set_sensitive (bool);
 421
 422         Gtk::Widget& tip_widget() { return *_combo; }
 423
 424 private:
 425
 426         sigc::slot<bool> _get;
 427         sigc::slot<bool, bool> _set;
 428         Gtk::Label* _label;
 429         Gtk::ComboBoxText* _combo;
 430 };
 431
 432
 433
 434 /** Component which provides the UI to handle an numeric option using a GTK SpinButton */
 435 template <class T>
 436 class SpinOption : public Option
 437 {
 438 public:
 439         /** Construct an SpinOption.
 440          *  @param i id
 441          *  @param n User-visible name.
 442          *  @param g Slot to get the variable's value.
 443          *  @param s Slot to set the variable's value.
 444          *  @param min Variable minimum value.
 445          *  @param max Variable maximum value.
 446          *  @param step Step for the spin button.
 447          *  @param page Page step for the spin button.
 448          *  @param unit Unit name.
 449          *  @param scale Scaling factor (such that for a value x in the spinbutton, x * scale is written to the config)
 450          */
 451         SpinOption (
 452                 std::string const & i,
 453                 std::string const & n,
 454                 sigc::slot<T> g,
 455                 sigc::slot<bool, T> s,
 456                 T min,
 457                 T max,
 458                 T step,
 459                 T page,
 460                 std::string const & unit = "",
 461                 float scale = 1
 462                 )
 463                 : Option (i, n),
 464                   _get (g),
 465                   _set (s),
 466                   _scale (scale)
 467         {
 468                 _label = manage (new Gtk::Label (n + ":"));
 469                 _label->set_alignment (0, 0.5);
 470
 471                 _spin = manage (new Gtk::SpinButton);
 472                 _spin->set_range (min, max);
 473                 _spin->set_increments (step, page);
 474
 475                 _box = manage (new Gtk::HBox);
 476                 _box->pack_start (*_spin, true, true);
 477                 _box->set_spacing (4);
 478                 if (unit.length()) {
 479                         _box->pack_start (*manage (new Gtk::Label (unit)), false, false);
 480                 }
 481
 482                 _spin->signal_value_changed().connect (sigc::mem_fun (*this, &SpinOption::changed));
 483         }
 484
 485         void set_state_from_config ()
 486         {
 487                 _spin->set_value (_get () / _scale);
 488         }
 489
 490         void add_to_page (OptionEditorPage* p)
 491         {
 492                 add_widgets_to_page (p, _label, _box);
 493         }
 494
 495         void changed ()
 496         {
 497                 _set (static_cast<T> (_spin->get_value ()) * _scale);
 498         }
 499
 500         Gtk::Widget& tip_widget() { return *_spin; }
 501
 502 private:
 503         sigc::slot<T> _get;
 504         sigc::slot<bool, T> _set;
 505         float _scale;
 506         Gtk::Label* _label;
 507         Gtk::HBox* _box;
 508         Gtk::SpinButton* _spin;
 509 };
 510
 511 class FaderOption : public Option
 512 {
 513 public:
 514
 515         FaderOption (std::string const &, std::string const &, sigc::slot<ARDOUR::gain_t> g, sigc::slot<bool, ARDOUR::gain_t> s);
 516         void set_state_from_config ();
 517         void add_to_page (OptionEditorPage *);
 518
 519         Gtk::Widget& tip_widget() { return *_db_slider; }
 520
 521 private:
 522         void db_changed ();
 523
 524         Gtk::Adjustment _db_adjustment;
 525         Gtkmm2ext::HSliderController* _db_slider;
 526         Gtk::Entry _db_display;
 527         Gtk::Label _label;
 528         Gtk::HBox _box;
 529         Gtk::VBox _fader_centering_box;
 530         sigc::slot<ARDOUR::gain_t> _get;
 531         sigc::slot<bool, ARDOUR::gain_t> _set;
 532 };
 533
 534 class ClockOption : public Option
 535 {
 536 public:
 537         ClockOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
 538         void set_state_from_config ();
 539         void add_to_page (OptionEditorPage *);
 540         void set_session (ARDOUR::Session *);
 541
 542         Gtk::Widget& tip_widget() { return _clock; }
 543         AudioClock& clock() { return _clock; }
 544
 545 private:
 546         void save_clock_time ();
 547         Gtk::Label _label;
 548         AudioClock _clock;
 549         sigc::slot<std::string> _get;
 550         sigc::slot<bool, std::string> _set;
 551         ARDOUR::Session *_session;
 552 };
 553
 554 class DirectoryOption : public Option
 555 {
 556 public:
 557         DirectoryOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
 558
 559         void set_state_from_config ();
 560         void add_to_page (OptionEditorPage *);
 561
 562         Gtk::Widget& tip_widget() { return _file_chooser; }
 563
 564 private:
 565         void file_set ();
 566         void current_folder_set ();
 567
 568         sigc::slot<std::string> _get; ///< slot to get the configuration variable's value
 569         sigc::slot<bool, std::string> _set;  ///< slot to set the configuration variable's value
 570         Gtk::FileChooserButton _file_chooser;
 571 };
 572
 573 /** Class to represent a single page in an OptionEditor's notebook.
 574  *  Pages are laid out using a 3-column table; the 1st column is used
 575  *  to indent non-headings, and the 2nd and 3rd for actual content.
 576  */
 577 class OptionEditorPage
 578 {
 579 public:
 580         OptionEditorPage (Gtk::Notebook&, std::string const &);
 581
 582         Gtk::VBox box;
 583         Gtk::Table table;
 584         std::list<OptionEditorComponent*> components;
 585 };
 586
 587 /** The OptionEditor dialog base class */
 588 class OptionEditor : public ArdourWindow
 589 {
 590 public:
 591         OptionEditor (ARDOUR::Configuration *, std::string const &);
 592         ~OptionEditor ();
 593
 594         void add_option (std::string const &, OptionEditorComponent *);
 595
 596         void set_current_page (std::string const &);
 597
 598 protected:
 599
 600         virtual void parameter_changed (std::string const &);
 601
 602         ARDOUR::Configuration* _config;
 603
 604 private:
 605
 606         PBD::ScopedConnection config_connection;
 607
 608         Gtk::Notebook _notebook;
 609         std::map<std::string, OptionEditorPage*> _pages;
 610 };
 611
 612 #endif /* __gtk_ardour_option_editor_h__ */
 613
 614