fix OSX compilation
[ardour.git] / gtk2_ardour / option_editor.h
index e3f8bf312dec890debe710003dc8feb5862981b0..53c671287831a4288383490cf2abd5a933715644 100644 (file)
 #include <gtkmm/comboboxtext.h>
 #include <gtkmm/spinbutton.h>
 #include <gtkmm/table.h>
+#include <gtkmm/window.h>
+
 #include "gtkmm2ext/slider_controller.h"
-#include "ardour_dialog.h"
+
+#include "ardour_window.h"
 #include "audio_clock.h"
 #include "ardour/types.h"
 
@@ -46,7 +49,7 @@
  *  options dialog.
  */
 
-namespace ARDOUR {
+namespace PBD {
        class Configuration;
 }
 
@@ -71,6 +74,15 @@ public:
 
        void add_widget_to_page (OptionEditorPage*, Gtk::Widget*);
        void add_widgets_to_page (OptionEditorPage*, Gtk::Widget*, Gtk::Widget*);
+
+       void set_note (std::string const &);
+
+        virtual Gtk::Widget& tip_widget() = 0;
+
+private:
+       void maybe_add_note (OptionEditorPage *, int);
+
+       std::string _note;
 };
 
 /** A component which provides a subheading within the dialog */
@@ -83,6 +95,8 @@ public:
        void set_state_from_config () {}
        void add_to_page (OptionEditorPage *);
 
+        Gtk::Widget& tip_widget() { return *_label; }
+
 private:
        Gtk::Label* _label; ///< the label used for the heading
 };
@@ -103,11 +117,45 @@ public:
        void set_state_from_config () = 0;
        void add_to_page (OptionEditorPage *);
 
+        Gtk::Widget& tip_widget() { return *_box->children().front().get_widget(); }
+
 protected:
 
        Gtk::VBox* _box; ///< constituent box for subclasses to add widgets to
 };
 
+class RcConfigDisplay : public OptionEditorComponent
+{
+public:
+       RcConfigDisplay (std::string const &, std::string const &, sigc::slot<std::string>, char s = '\0');
+       void add_to_page (OptionEditorPage *);
+       void parameter_changed (std::string const & p);
+       void set_state_from_config ();
+       Gtk::Widget& tip_widget() { return *_info; }
+protected:
+       sigc::slot<std::string> _get;
+       Gtk::Label* _label;
+       Gtk::Label* _info;
+       std::string _id;
+       char _sep;
+};
+
+class RcActionButton : public OptionEditorComponent
+{
+public:
+       RcActionButton (std::string const & t, const Glib::SignalProxy0< void >::SlotType & slot, std::string const & l = "");
+       void add_to_page (OptionEditorPage *);
+
+       void parameter_changed (std::string const & p) {}
+       void set_state_from_config () {}
+       Gtk::Widget& tip_widget() { return *_button; }
+
+protected:
+       Gtk::Button* _button;
+       Gtk::Label* _label;
+       std::string _name;
+};
+
 /** Base class for components which provide UI to change an option */
 class Option : public OptionEditorComponent
 {
@@ -155,14 +203,42 @@ public:
        void set_sensitive (bool yn) {
                _button->set_sensitive (yn);
        }
-       
-private:
 
-       void toggled ();
+       Gtk::Widget& tip_widget() { return *_button; }
+
+protected:
 
-       sigc::slot<bool> _get; ///< slot to get the configuration variable's value
+       virtual void toggled ();
+
+       sigc::slot<bool>       _get; ///< slot to get the configuration variable's value
        sigc::slot<bool, bool> _set;  ///< slot to set the configuration variable's value
-       Gtk::CheckButton* _button; ///< UI button
+       Gtk::CheckButton*      _button; ///< UI button
+       Gtk::Label*            _label; ///< label for button, so we can use markup
+};
+
+class RouteDisplayBoolOption : public BoolOption
+{
+public:
+       RouteDisplayBoolOption (std::string const &, std::string const &, sigc::slot<bool>, sigc::slot<bool, bool>);
+protected:
+       virtual void toggled ();
+};
+
+/** Component which allows to add any GTK Widget - intended for single buttons and custom stateless objects */
+class FooOption : public OptionEditorComponent
+{
+public:
+       FooOption (Gtk::Widget *w) : _w (w) {}
+
+       void add_to_page (OptionEditorPage* p) {
+               add_widget_to_page (p, _w);
+       }
+
+       Gtk::Widget& tip_widget() { return *_w; }
+       void set_state_from_config () {}
+       void parameter_changed (std::string const &) {}
+private:
+       Gtk::Widget *_w;
 };
 
 /** Component which provides the UI to handle a string option using a GTK Entry */
@@ -173,19 +249,26 @@ public:
        EntryOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
        void set_state_from_config ();
        void add_to_page (OptionEditorPage*);
+       void set_sensitive (bool);
+       void set_invalid_chars (std::string i) { _invalid = i; }
+
+       Gtk::Widget& tip_widget() { return *_entry; }
 
 private:
 
        void activated ();
+       bool focus_out (GdkEventFocus*);
+       void filter_text (const Glib::ustring&, int*);
 
        sigc::slot<std::string> _get; ///< slot to get the configuration variable's value
        sigc::slot<bool, std::string> _set;  ///< slot to set the configuration variable's value
        Gtk::Label* _label; ///< UI label
        Gtk::Entry* _entry; ///< UI entry
+       std::string _invalid;
 };
 
 
-/** Component which provides the UI to handle an enumerated option using a GTK CheckButton.
+/** Component which provides the UI to handle an enumerated option using a GTK ComboBox.
  *  The template parameter is the enumeration.
  */
 template <class T>
@@ -209,9 +292,9 @@ public:
                  _get (g),
                  _set (s)
        {
-               _label = manage (new Gtk::Label (n + ":"));
+               _label = Gtk::manage (new Gtk::Label (n + ":"));
                _label->set_alignment (0, 0.5);
-               _combo = manage (new Gtk::ComboBoxText);
+               _combo = Gtk::manage (new Gtk::ComboBoxText);
                _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboOption::changed));
        }
 
@@ -256,6 +339,8 @@ public:
                _combo->set_sensitive (yn);
        }
 
+        Gtk::Widget& tip_widget() { return *_combo; }
+
 private:
 
        sigc::slot<T> _get;
@@ -266,6 +351,180 @@ private:
 };
 
 
+/** Component which provides the UI for a GTK HScale.
+ */
+class HSliderOption : public Option
+{
+public:
+
+       /** Construct an ComboOption.
+        *  @param i id
+        *  @param n User-visible name.
+        *  @param g Slot to get the variable's value.
+        *  @param s Slot to set the variable's value.
+        */
+       HSliderOption (
+               std::string const & i,
+               std::string const & n,
+               Gtk::Adjustment &adj
+               )
+               : Option (i, n)
+       {
+               _label = Gtk::manage (new Gtk::Label (n + ":"));
+               _label->set_alignment (0, 0.5);
+               _hscale = Gtk::manage (new Gtk::HScale(adj));
+               _adj = NULL;
+       }
+
+       HSliderOption (
+               std::string const & i,
+               std::string const & n,
+               Gtk::Adjustment *adj,
+               sigc::slot<float> g,
+               sigc::slot<bool, float> s
+               )
+               : Option (i, n)
+               , _get (g)
+               , _set (s)
+               , _adj (adj)
+       {
+               _label = Gtk::manage (new Gtk::Label (n + ":"));
+               _label->set_alignment (0, 0.5);
+               _hscale = Gtk::manage (new Gtk::HScale(*_adj));
+               _adj->signal_value_changed().connect (sigc::mem_fun (*this, &HSliderOption::changed));
+       }
+
+       void set_state_from_config () {
+               if (_adj) _adj->set_value (_get());
+       }
+
+       void changed () {
+               if (_adj) _set (_adj->get_value ());
+       }
+
+       void add_to_page (OptionEditorPage* p)
+       {
+               add_widgets_to_page (p, _label, _hscale);
+       }
+
+       void set_sensitive (bool yn) {
+               _hscale->set_sensitive (yn);
+       }
+
+       Gtk::Widget& tip_widget() { return *_hscale; }
+       Gtk::HScale& scale() { return *_hscale; }
+
+private:
+       sigc::slot<float> _get;
+       sigc::slot<bool, float> _set;
+       Gtk::Label* _label;
+       Gtk::HScale* _hscale;
+       Gtk::Adjustment* _adj;
+};
+
+/** Component which provides the UI to handle an enumerated option using a GTK ComboBox.
+ *  The template parameter is the enumeration.
+ */
+class ComboStringOption : public Option
+{
+public:
+
+       /** Construct an ComboOption.
+        *  @param i id
+        *  @param n User-visible name.
+        *  @param g Slot to get the variable's value.
+        *  @param s Slot to set the variable's value.
+        */
+       ComboStringOption (
+               std::string const & i,
+               std::string const & n,
+               sigc::slot<std::string> g,
+               sigc::slot<bool, std::string> s
+               )
+               : Option (i, n),
+                 _get (g),
+                 _set (s)
+       {
+               _label = Gtk::manage (new Gtk::Label (n + ":"));
+               _label->set_alignment (0, 0.5);
+               _combo = Gtk::manage (new Gtk::ComboBoxText);
+               _combo->signal_changed().connect (sigc::mem_fun (*this, &ComboStringOption::changed));
+       }
+
+       void set_state_from_config () {
+               _combo->set_active_text (_get());
+       }
+
+       void add_to_page (OptionEditorPage* p)
+       {
+               add_widgets_to_page (p, _label, _combo);
+       }
+
+       /** Set the allowed strings for this option
+        *  @param strings a vector of allowed strings
+        */
+        void set_popdown_strings (const std::vector<std::string>& strings) {
+               _combo->clear_items ();
+               for (std::vector<std::string>::const_iterator i = strings.begin(); i != strings.end(); ++i) {
+                       _combo->append_text (*i);
+               }
+       }
+
+       void clear () {
+               _combo->clear_items();
+       }
+
+       void changed () {
+               _set (_combo->get_active_text ());
+       }
+
+       void set_sensitive (bool yn) {
+               _combo->set_sensitive (yn);
+       }
+
+        Gtk::Widget& tip_widget() { return *_combo; }
+
+private:
+        sigc::slot<std::string> _get;
+        sigc::slot<bool, std::string> _set;
+       Gtk::Label* _label;
+       Gtk::ComboBoxText* _combo;
+};
+
+
+/** Component which provides the UI to handle a boolean option which needs
+ *  to be represented as a ComboBox to be clear to the user.
+ */
+class BoolComboOption : public Option
+{
+public:
+
+       BoolComboOption (
+               std::string const &,
+               std::string const &,
+               std::string const &,
+               std::string const &,
+               sigc::slot<bool>,
+               sigc::slot<bool, bool>
+               );
+
+       void set_state_from_config ();
+       void add_to_page (OptionEditorPage *);
+       void changed ();
+       void set_sensitive (bool);
+
+        Gtk::Widget& tip_widget() { return *_combo; }
+
+private:
+
+       sigc::slot<bool> _get;
+       sigc::slot<bool, bool> _set;
+       Gtk::Label* _label;
+       Gtk::ComboBoxText* _combo;
+};
+
+
+
 /** Component which provides the UI to handle an numeric option using a GTK SpinButton */
 template <class T>
 class SpinOption : public Option
@@ -282,6 +541,7 @@ public:
         *  @param page Page step for the spin button.
         *  @param unit Unit name.
         *  @param scale Scaling factor (such that for a value x in the spinbutton, x * scale is written to the config)
+        *  @param digits Number of decimal digits to show.
         */
        SpinOption (
                std::string const & i,
@@ -293,25 +553,27 @@ public:
                T step,
                T page,
                std::string const & unit = "",
-               float scale = 1
+               float scale = 1,
+               unsigned digits = 0
                )
                : Option (i, n),
                  _get (g),
                  _set (s),
                  _scale (scale)
        {
-               _label = manage (new Gtk::Label (n + ":"));
+               _label = Gtk::manage (new Gtk::Label (n + ":"));
                _label->set_alignment (0, 0.5);
 
-               _spin = manage (new Gtk::SpinButton);
+               _spin = Gtk::manage (new Gtk::SpinButton);
                _spin->set_range (min, max);
                _spin->set_increments (step, page);
+               _spin->set_digits(digits);
 
-               _box = manage (new Gtk::HBox);
+               _box = Gtk::manage (new Gtk::HBox);
                _box->pack_start (*_spin, true, true);
                _box->set_spacing (4);
                if (unit.length()) {
-                       _box->pack_start (*manage (new Gtk::Label (unit)), false, false);
+                       _box->pack_start (*Gtk::manage (new Gtk::Label (unit)), false, false);
                }
 
                _spin->signal_value_changed().connect (sigc::mem_fun (*this, &SpinOption::changed));
@@ -332,6 +594,8 @@ public:
                _set (static_cast<T> (_spin->get_value ()) * _scale);
        }
 
+        Gtk::Widget& tip_widget() { return *_spin; }
+
 private:
        sigc::slot<T> _get;
        sigc::slot<bool, T> _set;
@@ -349,15 +613,19 @@ public:
        void set_state_from_config ();
        void add_to_page (OptionEditorPage *);
 
+        Gtk::Widget& tip_widget() { return *_db_slider; }
+
 private:
        void db_changed ();
-       
+       void on_activate ();
+       bool on_key_press (GdkEventKey* ev);
+
        Gtk::Adjustment _db_adjustment;
        Gtkmm2ext::HSliderController* _db_slider;
-       Glib::RefPtr<Gdk::Pixbuf> _pix;
        Gtk::Entry _db_display;
        Gtk::Label _label;
        Gtk::HBox _box;
+       Gtk::VBox _fader_centering_box;
        sigc::slot<ARDOUR::gain_t> _get;
        sigc::slot<bool, ARDOUR::gain_t> _set;
 };
@@ -365,16 +633,39 @@ private:
 class ClockOption : public Option
 {
 public:
-       ClockOption (std::string const &, std::string const &, sigc::slot<ARDOUR::framecnt_t>, sigc::slot<bool, ARDOUR::framecnt_t>);
+       ClockOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
        void set_state_from_config ();
        void add_to_page (OptionEditorPage *);
        void set_session (ARDOUR::Session *);
 
+        Gtk::Widget& tip_widget() { return _clock; }
+        AudioClock& clock() { return _clock; }
+
 private:
+       void save_clock_time ();
        Gtk::Label _label;
        AudioClock _clock;
-       sigc::slot<ARDOUR::framecnt_t> _get;
-       sigc::slot<bool, ARDOUR::framecnt_t> _set;
+       sigc::slot<std::string> _get;
+       sigc::slot<bool, std::string> _set;
+       ARDOUR::Session *_session;
+};
+
+class DirectoryOption : public Option
+{
+public:
+       DirectoryOption (std::string const &, std::string const &, sigc::slot<std::string>, sigc::slot<bool, std::string>);
+
+       void set_state_from_config ();
+       void add_to_page (OptionEditorPage *);
+
+        Gtk::Widget& tip_widget() { return _file_chooser; }
+
+private:
+       void selection_changed ();
+
+       sigc::slot<std::string> _get; ///< slot to get the configuration variable's value
+       sigc::slot<bool, std::string> _set;  ///< slot to set the configuration variable's value
+       Gtk::FileChooserButton _file_chooser;
 };
 
 /** Class to represent a single page in an OptionEditor's notebook.
@@ -392,28 +683,68 @@ public:
 };
 
 /** The OptionEditor dialog base class */
-class OptionEditor : public ArdourDialog
+class OptionEditor : virtual public sigc::trackable
 {
 public:
-       OptionEditor (ARDOUR::Configuration *, std::string const &);
-       ~OptionEditor ();
+       OptionEditor (PBD::Configuration *);
+       virtual ~OptionEditor ();
 
        void add_option (std::string const &, OptionEditorComponent *);
+       void add_page (std::string const &, Gtk::Widget& page_widget);
 
-protected:
+       void set_current_page (std::string const &);
 
+protected:
        virtual void parameter_changed (std::string const &);
-       
-       ARDOUR::Configuration* _config;
 
-private:
+       PBD::Configuration* _config;
+       Gtk::Notebook& notebook() { return _notebook; }
+       Gtk::TreeView& treeview() { return option_treeview; }
 
-       PBD::ScopedConnection config_connection;
+       class OptionColumns : public Gtk::TreeModel::ColumnRecord
+       {
+          public:
+               Gtk::TreeModelColumn<std::string> name;
+               Gtk::TreeModelColumn<Gtk::Widget*> widget;
+
+               OptionColumns() {
+                       add (name);
+                       add (widget);
+               }
+       };
+
+       OptionColumns option_columns;
+       Glib::RefPtr<Gtk::TreeStore> option_tree;
 
+private:
+       PBD::ScopedConnection config_connection;
        Gtk::Notebook _notebook;
+       Gtk::TreeView option_treeview;
        std::map<std::string, OptionEditorPage*> _pages;
+
+       void add_path_to_treeview (std::string const &, Gtk::Widget&);
+       void treeview_row_selected ();
 };
 
-#endif /* __gtk_ardour_option_editor_h__ */
+/** The OptionEditor dialog-as-container base class */
+class OptionEditorContainer : public OptionEditor, public Gtk::VBox
+{
+public:
+       OptionEditorContainer (PBD::Configuration *, std::string const &);
+       ~OptionEditorContainer() {}
+private:
+       Gtk::HBox hpacker;
+};
 
+/** The OptionEditor dialog-as-container base class */
+class OptionEditorWindow : public OptionEditor, public ArdourWindow
+{
+public:
+       OptionEditorWindow (PBD::Configuration *, std::string const &);
+       ~OptionEditorWindow() {}
+private:
+       Gtk::VBox container;
+       Gtk::HBox hpacker;
+};
 
+#endif /* __gtk_ardour_option_editor_h__ */