X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=gtk2_ardour%2Foption_editor.h;h=93e217f7e7b3f88789fe9f911f771e5376eaf1a0;hb=ae3c50c495ffadbc62103cc1d3a61af2b48f423e;hp=a6b1a74e5ca9be587843d6ba9f423821caf37af0;hpb=e0aaed6d65f160c328cb8b56d7c6552ee15d65e2;p=ardour.git diff --git a/gtk2_ardour/option_editor.h b/gtk2_ardour/option_editor.h index a6b1a74e5c..93e217f7e7 100644 --- a/gtk2_ardour/option_editor.h +++ b/gtk2_ardour/option_editor.h @@ -1,8 +1,5 @@ -#ifndef __gtk_ardour_option_editor_h__ -#define __gtk_ardour_option_editor_h__ - /* - Copyright (C) 2001 Paul Davis + Copyright (C) 2009 Paul Davis This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -17,225 +14,682 @@ You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ -#include +#ifndef __gtk_ardour_option_editor_h__ +#define __gtk_ardour_option_editor_h__ #include #include -#include -#include -#include -#include -#include -#include -#include -#include #include +#include +#include +#include -#include "ardour/session.h" +#include "gtkmm2ext/slider_controller.h" -#include "ardour_dialog.h" -#include "editing.h" +#include "ardour_window.h" #include "audio_clock.h" +#include "ardour/types.h" + +/** @file option_editor.h + * @brief Base class for option editing dialog boxes. + * + * Code to provided the basis for dialogs which allow the user to edit options + * from an ARDOUR::Configuration class. + * + * The idea is that we have an OptionEditor class which is the dialog box. + * This is essentially a GTK Notebook. OptionEditorComponent objects can + * then be added to the OptionEditor, and these components are arranged on + * the pages of the Notebook. There is also an OptionEditorComponent hierarchy + * here, providing things like boolean and combobox option components. + * + * It is intended that OptionEditor be subclassed to implement a particular + * options dialog. + */ + +namespace PBD { + class Configuration; +} + +class OptionEditorPage; + +/** Base class for components of an OptionEditor dialog */ +class OptionEditorComponent +{ +public: + virtual ~OptionEditorComponent() {} + + /** Called when a configuration parameter's value has changed. + * @param p parameter name + */ + virtual void parameter_changed (std::string const & p) = 0; + + /** Called to instruct the object to set its UI state from the configuration */ + virtual void set_state_from_config () = 0; + + /** Called to instruct the object to add itself to an OptionEditorPage */ + virtual void add_to_page (OptionEditorPage *) = 0; + + void add_widget_to_page (OptionEditorPage*, Gtk::Widget*); + void add_widgets_to_page (OptionEditorPage*, Gtk::Widget*, Gtk::Widget*, bool expand = true); + + void set_note (std::string const &); + + virtual Gtk::Widget& tip_widget() = 0; + +protected: + void maybe_add_note (OptionEditorPage *, int); -class ARDOUR_UI; -class PublicEditor; -class Mixer_UI; -class IOSelector; -class GainMeter; -class PannerUI; + std::string _note; +}; -class OptionEditor : public ArdourDialog +/** A component which provides a subheading within the dialog */ +class OptionEditorHeading : public OptionEditorComponent { - public: - OptionEditor (ARDOUR_UI&, PublicEditor&, Mixer_UI&); - ~OptionEditor (); +public: + OptionEditorHeading (std::string const &); - void set_session (ARDOUR::Session *); - void save (); + void parameter_changed (std::string const &) {} + 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 +}; + +/** Expanding layout helper to push elements to the left on a single column page */ +class OptionEditorBlank : public OptionEditorComponent +{ +public: + OptionEditorBlank () {} + + void parameter_changed (std::string const &) {} + void set_state_from_config () {} + void add_to_page (OptionEditorPage *); + + Gtk::Widget& tip_widget() { return _dummy; } - private: - ARDOUR::Session *session; - ARDOUR_UI& ui; - PublicEditor& editor; - Mixer_UI& mixer; +private: + Gtk::EventBox _dummy; +}; - Gtk::Notebook notebook; +class RcConfigDisplay : public OptionEditorComponent +{ +public: + RcConfigDisplay (std::string const &, std::string const &, sigc::slot, 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 _get; + Gtk::Label* _label; + Gtk::Label* _info; + std::string _id; + char _sep; +}; - /* Generic */ +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; +}; - gint wm_close (GdkEventAny *); - bool focus_out_event_handler (GdkEventFocus*, void (OptionEditor::*pmf)()); - void parameter_changed (const char* name); +/** Base class for components which provide UI to change an option */ +class Option : public OptionEditorComponent +{ +public: + /** Construct an Option. + * @param i Option id (e.g. "plugins-stop-with-transport") + * @param n User-visible name (e.g. "Stop plugins when the transport is stopped") + */ + Option (std::string const & i, + std::string const & n + ) + : _id (i), + _name (n) + {} + + void parameter_changed (std::string const & p) + { + if (p == _id) { + set_state_from_config (); + } + } + + virtual void set_state_from_config () = 0; + virtual void add_to_page (OptionEditorPage*) = 0; + + std::string id () const { + return _id; + } + +protected: + std::string _id; + std::string _name; +}; - /* paths */ +/** Component which provides the UI to handle a boolean option using a GTK CheckButton */ +class BoolOption : public Option +{ +public: + BoolOption (std::string const &, std::string const &, sigc::slot, sigc::slot); + void set_state_from_config (); + void add_to_page (OptionEditorPage*); - Gtk::Table path_table; - Gtk::Entry session_raid_entry; + void set_sensitive (bool yn) { + _button->set_sensitive (yn); + } - void setup_path_options(); - void add_session_paths (); - void remove_session_paths (); - void raid_path_changed (); + Gtk::Widget& tip_widget() { return *_button; } - /* misc */ +protected: + virtual void toggled (); - Gtk::VBox misc_packer; + sigc::slot _get; ///< slot to get the configuration variable's value + sigc::slot _set; ///< slot to set the configuration variable's value + Gtk::CheckButton* _button; ///< UI button + Gtk::Label* _label; ///< label for button, so we can use markup +}; - Gtk::Adjustment short_xfade_adjustment; - Gtk::HScale short_xfade_slider; - Gtk::Adjustment destructo_xfade_adjustment; - Gtk::HScale destructo_xfade_slider; +class RouteDisplayBoolOption : public BoolOption +{ +public: + RouteDisplayBoolOption (std::string const &, std::string const &, sigc::slot, sigc::slot); - void setup_misc_options(); +protected: + virtual void toggled (); +}; - void short_xfade_adjustment_changed (); - void destructo_xfade_adjustment_changed (); +/** 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; +}; - Gtk::Adjustment history_depth; - Gtk::Adjustment saved_history_depth; - Gtk::SpinButton history_depth_spinner; - Gtk::SpinButton saved_history_depth_spinner; - Gtk::CheckButton limit_history_button; - Gtk::CheckButton save_history_button; +/** Component which provides the UI to handle a string option using a GTK Entry */ +class EntryOption : public Option +{ +public: + EntryOption (std::string const &, std::string const &, sigc::slot, sigc::slot); + 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 _get; ///< slot to get the configuration variable's value + sigc::slot _set; ///< slot to set the configuration variable's value + Gtk::Label* _label; ///< UI label + Gtk::Entry* _entry; ///< UI entry + std::string _invalid; +}; - void history_depth_changed(); - void saved_history_depth_changed(); - void save_history_toggled (); - void limit_history_toggled (); - /* Sync */ +/** Component which provides the UI to handle an enumerated option using a GTK ComboBox. + * The template parameter is the enumeration. + */ +template +class ComboOption : 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. + */ + ComboOption ( + std::string const & i, + std::string const & n, + sigc::slot g, + sigc::slot 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, &ComboOption::changed)); + } + + void set_state_from_config () + { + uint32_t r = 0; + while (r < _options.size() && _get () != _options[r]) { + ++r; + } + + if (r < _options.size()) { + _combo->set_active (r); + } + } + + void add_to_page (OptionEditorPage* p) + { + add_widgets_to_page (p, _label, _combo); + } + + /** Add an allowed value for this option. + * @param e Enumeration. + * @param o User-visible name for this value. + */ + void add (T e, std::string const & o) + { + _options.push_back (e); + _combo->append_text (o); + } + + void clear () + { + _combo->clear_items(); + _options.clear (); + } + + void changed () + { + uint32_t const r = _combo->get_active_row_number (); + if (r < _options.size()) { + _set (_options[r]); + } + } + void set_sensitive (bool yn) + { + _combo->set_sensitive (yn); + } + + Gtk::Widget& tip_widget() { return *_combo; } + +private: + sigc::slot _get; + sigc::slot _set; + Gtk::Label* _label; + Gtk::ComboBoxText* _combo; + std::vector _options; +}; - Gtk::VBox sync_packer; - Gtk::ComboBoxText slave_type_combo; - AudioClock smpte_offset_clock; - Gtk::CheckButton smpte_offset_negative_button; - Gtk::CheckButton synced_timecode_button; +/** Component which provides the UI for a GTK HScale. + */ +class HSliderOption : public Option +{ +public: + HSliderOption ( + std::string const& i, + std::string const& n, + sigc::slot g, + sigc::slot s, + double lower, double upper, + double step_increment = 1, + double page_increment = 10, + double mult = 1.0, + bool logarithmic = false + ); + + void set_state_from_config (); + virtual void changed (); + void add_to_page (OptionEditorPage* p); + void set_sensitive (bool yn); + + Gtk::Widget& tip_widget() { return _hscale; } + Gtk::HScale& scale() { return _hscale; } + +protected: + sigc::slot _get; + sigc::slot _set; + Gtk::Adjustment _adj; + Gtk::HScale _hscale; + Gtk::Label _label; + double _mult; + bool _log; +}; - void setup_sync_options (); - void smpte_offset_chosen (); - void smpte_offset_negative_clicked (); - void synced_timecode_toggled (); +/** 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 g, + sigc::slot s + ); + + void set_state_from_config (); + void add_to_page (OptionEditorPage* p); + + /** Set the allowed strings for this option + * @param strings a vector of allowed strings + */ + void set_popdown_strings (const std::vector& strings); + + void clear (); + void changed (); + void set_sensitive (bool yn); + + Gtk::Widget& tip_widget() { return *_combo; } + +private: + sigc::slot _get; + sigc::slot _set; + Gtk::Label* _label; + Gtk::ComboBoxText* _combo; +}; - /* MIDI */ - Gtk::VBox midi_packer; +/** 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, + sigc::slot + ); + + 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 _get; + sigc::slot _set; + Gtk::Label* _label; + Gtk::ComboBoxText* _combo; +}; - Gtk::RadioButton::Group mtc_button_group; - Gtk::RadioButton::Group mmc_button_group; - Gtk::RadioButton::Group midi_button_group; - Gtk::RadioButton::Group midi_clock_button_group; - Gtk::Table midi_port_table; - std::vector midi_port_table_widgets; - Gtk::Adjustment mmc_receive_device_id_adjustment; - Gtk::SpinButton mmc_receive_device_id_spinner; - Gtk::Adjustment mmc_send_device_id_adjustment; - Gtk::SpinButton mmc_send_device_id_spinner; - Gtk::Button add_midi_port_button; - Gtk::Adjustment initial_program_change_adjustment; - Gtk::SpinButton initial_program_change_spinner; +/** Component which provides the UI to handle an numeric option using a GTK SpinButton */ +template +class SpinOption : public Option +{ +public: + /** Construct an SpinOption. + * @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. + * @param min Variable minimum value. + * @param max Variable maximum value. + * @param step Step for the spin button. + * @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, + std::string const & n, + sigc::slot g, + sigc::slot s, + T min, + T max, + T step, + T page, + std::string const & unit = "", + float scale = 1, + unsigned digits = 0 + ) + : Option (i, n) + , _get (g) + , _set (s) + , _scale (scale) + { + _label = Gtk::manage (new Gtk::Label (n + ":")); + _label->set_alignment (0, 0.5); + + _spin = Gtk::manage (new Gtk::SpinButton); + _spin->set_range (min, max); + _spin->set_increments (step, page); + _spin->set_digits(digits); + + _box = Gtk::manage (new Gtk::HBox); + _box->pack_start (*_spin, true, true); + _box->set_spacing (4); + if (unit.length()) { + _box->pack_start (*Gtk::manage (new Gtk::Label (unit)), false, false); + } + + _spin->signal_value_changed().connect (sigc::mem_fun (*this, &SpinOption::changed)); + } + + void set_state_from_config () + { + _spin->set_value (_get () / _scale); + } + + void add_to_page (OptionEditorPage* p) + { + add_widgets_to_page (p, _label, _box, false); + } + + void changed () + { + _set (static_cast (_spin->get_value ()) * _scale); + } + + Gtk::Widget& tip_widget() { return *_spin; } + +private: + sigc::slot _get; + sigc::slot _set; + float _scale; + Gtk::Label* _label; + Gtk::HBox* _box; + Gtk::SpinButton* _spin; +}; - void add_midi_port (); - void remove_midi_port (MIDI::Port*); - void redisplay_midi_ports (); +class FaderOption : public Option +{ +public: + + FaderOption (std::string const &, std::string const &, sigc::slot g, sigc::slot s); + 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; + Gtk::Entry _db_display; + Gtk::Label _label; + Gtk::HBox _box; + Gtk::VBox _fader_centering_box; + sigc::slot _get; + sigc::slot _set; +}; - void port_online_toggled (MIDI::Port*,Gtk::ToggleButton*); - void port_trace_in_toggled (MIDI::Port*,Gtk::ToggleButton*); - void port_trace_out_toggled (MIDI::Port*,Gtk::ToggleButton*); +class ClockOption : public Option +{ +public: + ClockOption (std::string const &, std::string const &, sigc::slot, sigc::slot); + void set_state_from_config (); + void add_to_page (OptionEditorPage *); + void set_session (ARDOUR::Session *); - void mmc_port_chosen (MIDI::Port*,Gtk::RadioButton*, Gtk::Button*); - void mtc_port_chosen (MIDI::Port*,Gtk::RadioButton*, Gtk::Button*); - void midi_port_chosen (MIDI::Port*,Gtk::RadioButton*, Gtk::Button*); - void midi_clock_port_chosen (MIDI::Port*,Gtk::RadioButton*, Gtk::Button*); - bool port_removable (MIDI::Port*); + Gtk::Widget& tip_widget() { return _clock; } + AudioClock& clock() { return _clock; } - void mmc_receive_device_id_adjusted (); - void mmc_send_device_id_adjusted (); +private: + void save_clock_time (); + Gtk::Label _label; + AudioClock _clock; + sigc::slot _get; + sigc::slot _set; + ARDOUR::Session *_session; +}; - void initial_program_change_adjusted (); +class DirectoryOption : public Option +{ +public: + DirectoryOption (std::string const &, std::string const &, sigc::slot, sigc::slot); - void map_port_online (MIDI::Port*, Gtk::ToggleButton*); + void set_state_from_config (); + void add_to_page (OptionEditorPage *); - void setup_midi_options(); + Gtk::Widget& tip_widget() { return _file_chooser; } - enum PortIndex { - MtcIndex = 0, - MmcIndex = 1, - MidiIndex = 2, - MidiClockIndex = 3 - }; +private: + void selection_changed (); - std::map > port_toggle_buttons; + sigc::slot _get; ///< slot to get the configuration variable's value + sigc::slot _set; ///< slot to set the configuration variable's value + Gtk::FileChooserButton _file_chooser; +}; - /* Click */ +/** Class to represent a single page in an OptionEditor's notebook. + * Pages are laid out using a 3-column table; the 1st column is used + * to indent non-headings, and the 2nd and 3rd for actual content. + */ +class OptionEditorPage +{ +public: + OptionEditorPage (Gtk::Notebook&, std::string const &); + OptionEditorPage (); - IOSelector* click_io_selector; - GainMeter* click_gpm; - PannerUI* click_panner; - bool first_click_setup; - Gtk::HBox click_hpacker; - Gtk::VBox click_packer; - Gtk::Table click_table; - Gtk::Entry click_path_entry; - Gtk::Entry click_emphasis_path_entry; - Gtk::Button click_browse_button; - Gtk::Button click_emphasis_browse_button; + Gtk::VBox box; + Gtk::Table table; + std::list components; - void setup_click_editor (); - void clear_click_editor (); +private: + void init (); +}; - void click_chosen (const string & paths); - void click_emphasis_chosen (const string & paths); +class OptionEditorMiniPage : public OptionEditorComponent, public OptionEditorPage +{ +public: + OptionEditorMiniPage () + { + box.pack_start (table, false, false); + box.set_border_width (0); + } + + void parameter_changed (std::string const &) = 0; + void set_state_from_config () = 0; + virtual void add_to_page (OptionEditorPage*); + + Gtk::Widget& tip_widget() { return *table.children().front().get_widget(); } +}; - void click_browse_clicked (); - void click_emphasis_browse_clicked (); +/** The OptionEditor dialog base class */ +class OptionEditor : virtual public sigc::trackable +{ +public: + OptionEditor (PBD::Configuration *); + virtual ~OptionEditor (); - void click_sound_changed (); - void click_emphasis_sound_changed (); + void add_option (std::string const &, OptionEditorComponent *); + void add_page (std::string const &, Gtk::Widget& page_widget); - /* Auditioner */ + void set_current_page (std::string const &); - Gtk::VBox audition_packer; - Gtk::HBox audition_hpacker; - Gtk::Label audition_label; - IOSelector* auditioner_io_selector; - GainMeter* auditioner_gpm; - PannerUI* auditioner_panner; +protected: + virtual void parameter_changed (std::string const &); - void setup_auditioner_editor (); - void clear_auditioner_editor (); - void connect_audition_editor (); + PBD::Configuration* _config; + Gtk::Notebook& notebook() { return _notebook; } + Gtk::TreeView& treeview() { return option_treeview; } - /* keyboard/mouse */ + class OptionColumns : public Gtk::TreeModel::ColumnRecord + { + public: + Gtk::TreeModelColumn name; + Gtk::TreeModelColumn widget; - Gtk::Table keyboard_mouse_table; - Gtk::ComboBoxText keyboard_layout_selector; - Gtk::ComboBoxText edit_modifier_combo; - Gtk::ComboBoxText delete_modifier_combo; - Gtk::ComboBoxText snap_modifier_combo; - Gtk::Adjustment delete_button_adjustment; - Gtk::SpinButton delete_button_spin; - Gtk::Adjustment edit_button_adjustment; - Gtk::SpinButton edit_button_spin; + OptionColumns() { + add (name); + add (widget); + } + }; - std::map bindings_files; + OptionColumns option_columns; + Glib::RefPtr option_tree; - void setup_keyboard_options (); - void delete_modifier_chosen (); - void edit_modifier_chosen (); - void snap_modifier_chosen (); - void edit_button_changed (); - void delete_button_changed (); - void bindings_changed (); +private: + PBD::ScopedConnection config_connection; + Gtk::Notebook _notebook; + Gtk::TreeView option_treeview; + std::map _pages; - void fixup_combo_size (Gtk::ComboBoxText&, std::vector& strings); + void add_path_to_treeview (std::string const &, Gtk::Widget&); + Gtk::TreeModel::iterator find_path_in_treemodel (std::string const & pn, + bool create_missing = false); + 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__ */