mp4chaps Lua script: don't clutter global environment
[ardour.git] / gtk2_ardour / add_route_dialog.cc
index e9480c1daceb277ba8dbc04110f651a746d84928..bf218fb8d876973c81e3d2e2176907bfd846c134 100644 (file)
@@ -58,7 +58,7 @@ using namespace ARDOUR;
 using namespace ARDOUR_UI_UTILS;
 
 std::vector<std::string> AddRouteDialog::channel_combo_strings;
-std::vector<std::string> AddRouteDialog::builtin_types;
+std::vector<std::pair<std::string,std::string> > AddRouteDialog::builtin_types;
 
 AddRouteDialog::AddRouteDialog ()
        : ArdourDialog (_("Add Track/Bus/VCA"))
@@ -88,12 +88,91 @@ AddRouteDialog::AddRouteDialog ()
        refill_track_modes ();
 
        if (builtin_types.empty()) {
-               builtin_types.push_back (_("Audio Tracks"));
-               builtin_types.push_back (_("MIDI Tracks"));
-               builtin_types.push_back (_("Audio+MIDI Tracks"));
-               builtin_types.push_back (_("Audio Busses"));
-               builtin_types.push_back (_("MIDI Busses"));
-               builtin_types.push_back (_("VCA Masters"));
+               builtin_types.push_back (
+                       std::pair<string,string>(_("Audio Tracks"),  _( " \
+Use the settings, below, to create 1 or more new Audio tracks.\n \
+\n\n \
+You may select:\n \
+* The number of tracks to add.\n \
+* A Name for the new track(s).\n \
+* Mono, Stereo, or Multichannel operation for the new track(s).\n \
+* A Group which the track will be assigned to.\n \
+* The Pin Connections mode. (see tooltip for details).\n \
+* Normal (non-destructive) or Tape (destructive) recording mode.\n \
+\n \
+The track will be added in the location specified by \"Position\".\n \
+")
+               ));
+               builtin_types.push_back (
+                       std::pair<string,string>(_("MIDI Tracks"),  _(" \
+Use the settings, below, to create 1 or more new MIDI tracks.\n \
+\n\n \
+You may select:\n \
+* The number of tracks to add.\n \
+* A Name for the track(s).\n \
+* An Instrument plugin (or select \"None\" to drive an external device)\n \
+* A Group which the track will be assigned to.\n \
+* The Pin Connections mode. (see tooltip for details)\n \
+\n \
+The track will be added in the location specified by \"Position\".\n \
+")
+               ));
+               builtin_types.push_back (
+                       std::pair<string,string>(_("Audio+MIDI Tracks"),   _(" \
+Use the settings, below, to create 1 or more new Audio+MIDI tracks.\n \
+\n\n \
+You may select:\n \
+* The number of tracks to add.\n \
+* A Name for the track(s).\n \
+* An Instrument plugin (or select \"None\" to drive an external device)\n \
+* A Group which will be assigned to the track(s).\n \
+* Pin Connections mode. (see tooltip for details).\n \
+* Normal (non-destructive) or Tape (destructive) recording mode.\n \
+\n \
+The track will be added in the location specified by \"Position\".\n \
+")
+               ));
+               builtin_types.push_back (
+                       std::pair<string,string>(_("Audio Busses"),  _(" \
+Use the settings, below, to create new Audio Tracks.\n \
+\n\n \
+You may select:\n \
+* The number of buses to add.\n \
+* A Name for the track(s).\n \
+* An Instrument plugin (or select \"None\" to drive an external device)\n \
+* A Group which will be assigned to the track(s).\n \
+* Pin Connections mode. (see tooltip for details).\n \
+* Normal (non-destructive) or Tape (destructive) recording mode.\n \
+\n \
+The track will be added in the location specified by \"Position\".\n \
+")
+               ));
+               builtin_types.push_back (
+                       std::pair<string,string>(_("MIDI Busses"),  _(" \
+Use the settings, below, to create new MIDI Busses.\n \
+\n \
+MIDI Busses can combine the output of multiple tracks. \n \
+MIDI Buses are sometimes used to host a single \"heavy\" instrument plugin which is fed from multiple MIDI tracks.  \
+\n\n \
+You may select:\n \
+* The number of buses to add.\n \
+* A Name for the track(s).\n \
+* An Instrument plugin (or select \"None\" to drive an external device)\n \
+* A Group which will be assigned to the track(s).\n \
+* Pin Connections mode. (see tooltip for details).\n \
+\n \
+The track will be added in the location specified by \"Position\".\n \
+")
+               ));
+               builtin_types.push_back (
+                       std::pair<string,string>(_("VCA Masters"),   _(" \
+Use the settings, below, to create 1 or more VCA Master(s).\n \
+\n\n \
+You may select:\n \
+* The number of buses to add.\n \
+* A name for the new VCAs.  \"%n\" will be replaced by an index number for each VCA.\n \
+")
+               ));
        }
 
        insert_at_combo.append_text (_("First"));
@@ -106,16 +185,17 @@ AddRouteDialog::AddRouteDialog ()
        strict_io_combo.append_text (_("Strict-I/O"));
        strict_io_combo.set_active (Config->get_strict_io () ? 1 : 0);
 
+       //top-level VBox
        VBox* vbox = manage (new VBox);
-
        get_vbox()->set_spacing (4);
-
        vbox->set_spacing (18);
        vbox->set_border_width (5);
 
+       //this box contains the template chooser, and the template details
        HBox* template_hbox = manage (new HBox);
        template_hbox->set_spacing (8);
 
+       //scrollbars for the template chooser and template descriptions....
        Gtk::ScrolledWindow *template_scroller = manage (new Gtk::ScrolledWindow());
        template_scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
        template_scroller->add (trk_template_chooser);
@@ -124,11 +204,12 @@ AddRouteDialog::AddRouteDialog ()
        desc_scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
        desc_scroller->add (trk_template_desc);
 
-       template_hbox->pack_start (*template_scroller, true, true);
+       //this is the outer frame that surrounds the description and the settings-table
+       trk_template_outer_frame.set_name (X_("TextHighlightFrame"));
 
+       //this is the "inner frame" that surrounds the description text
        trk_template_desc_frame.set_name (X_("TextHighlightFrame"));
        trk_template_desc_frame.add (*desc_scroller);
-       template_hbox->pack_start (trk_template_desc_frame, true, true);
 
        /* template_chooser is the treeview showing available templates */
        trk_template_model = TreeStore::create (track_template_columns);
@@ -150,54 +231,67 @@ AddRouteDialog::AddRouteDialog ()
        trk_template_desc.set_name (X_("TextOnBackground"));
        trk_template_desc.set_border_width (6);
 
+       Table *settings_table = manage (new Table (2, 6, false));
+       settings_table->set_row_spacings (8);
+       settings_table->set_col_spacings        (4);
+       settings_table->set_col_spacing (3, 20);
+       settings_table->set_border_width        (12);
+
+       VBox* settings_vbox = manage (new VBox);
+       settings_vbox->pack_start(trk_template_desc_frame , true, true);
+       settings_vbox->pack_start(*settings_table , true, true);
+       settings_vbox->set_border_width (4);
+
+       trk_template_outer_frame.add (*settings_vbox);
+
+       template_hbox->pack_start (*template_scroller, true, true);
+       template_hbox->pack_start (trk_template_outer_frame, true, true);
+
        vbox->pack_start (*template_hbox, true, true);
 
+
+       //Now pack the "settings table" with manual controls (these controls are sensitized by the left-side selection) 
+
+       int n = 0;
+
        HBox *separator_hbox = manage (new HBox);
        separator_hbox->pack_start (manual_label, false, false);
        separator_hbox->pack_start (*(manage (new Gtk::HSeparator)), true, true);
        separator_hbox->set_spacing (6);
-       vbox->pack_start (*separator_hbox, true, true);
+       settings_table->attach (*separator_hbox, 0, 6, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
 
-       /* track/bus choice */
-
-       Table *add_table = manage (new Table (8, 6, false));
-       add_table->set_row_spacings (8);
-       add_table->set_col_spacings     (4);
-       add_table->set_col_spacing      (3, 20);
-       add_table->set_border_width     (0);
-
-       int n = 0;
+       ++n;
 
        // Number
        add_label.set_alignment (Gtk::ALIGN_RIGHT, Gtk::ALIGN_CENTER);
-       add_table->attach (add_label, 0, 1, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       settings_table->attach (add_label, 0, 1, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
        Gtk::Alignment *align = manage (new Alignment (0, .5, 0, 0));
        align->add (routes_spinner);
-       add_table->attach (*align, 1, 2, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       settings_table->attach (*align, 1, 2, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
 
        ++n;
 
        // Name
        name_label.set_alignment (Gtk::ALIGN_RIGHT, Gtk::ALIGN_CENTER);
-       add_table->attach (name_label, 0, 1, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
-       add_table->attach (name_template_entry, 1, 3, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       settings_table->attach (name_label, 0, 1, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       settings_table->attach (name_template_entry, 1, 3, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
 
        // Route configuration
        configuration_label.set_alignment (Gtk::ALIGN_RIGHT, Gtk::ALIGN_CENTER);
-       add_table->attach (configuration_label, 4, 5, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
-       add_table->attach (channel_combo, 5, 6, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       settings_table->attach (configuration_label, 4, 5, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       settings_table->attach (channel_combo, 5, 6, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
 
        ++n;
 
        // instrument choice (for MIDI)
        instrument_label.set_alignment (Gtk::ALIGN_RIGHT, Gtk::ALIGN_CENTER);
-       add_table->attach (instrument_label, 0, 1, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
-       add_table->attach (instrument_combo, 1, 3, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       settings_table->attach (instrument_label, 0, 1, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       settings_table->attach (instrument_combo, 1, 3, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
 
        // Group choice
        group_label.set_alignment (Gtk::ALIGN_RIGHT, Gtk::ALIGN_CENTER);
-       add_table->attach (group_label, 4, 5, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
-       add_table->attach (route_group_combo, 5, 6, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       settings_table->attach (group_label, 4, 5, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       settings_table->attach (route_group_combo, 5, 6, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
 
        ++n;
 
@@ -206,36 +300,35 @@ AddRouteDialog::AddRouteDialog ()
                strict_io_combo.set_active (1);
        } else {
                strict_io_label.set_alignment (Gtk::ALIGN_RIGHT, Gtk::ALIGN_CENTER);
-               add_table->attach (strict_io_label, 0, 1, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
-               add_table->attach (strict_io_combo, 1, 3, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+               settings_table->attach (strict_io_label, 0, 1, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+               settings_table->attach (strict_io_combo, 1, 3, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
 
                ArdourWidgets::set_tooltip (strict_io_combo,
                                _("With strict-i/o enabled, Effect Processors will not modify the number of channels on a track. The number of output channels will always match the number of input channels."));
 
                // recording mode
                mode_label.set_alignment (Gtk::ALIGN_RIGHT, Gtk::ALIGN_CENTER);
-               add_table->attach (mode_label, 4, 5, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
-               add_table->attach (mode_combo, 5, 6, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+               settings_table->attach (mode_label, 4, 5, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+               settings_table->attach (mode_combo, 5, 6, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
 
                ++n;
        }
 
-
-       add_table->attach (*(manage (new Gtk::HSeparator)), 0, 6, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
-
-       ++n;
+       HBox* outer_box = manage (new HBox);
+       outer_box->set_spacing (4);
 
        // New route will be inserted at..
        insert_label.set_alignment (Gtk::ALIGN_RIGHT, Gtk::ALIGN_CENTER);
-       add_table->attach (insert_label, 0, 1, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
-       add_table->attach (insert_at_combo, 1, 3, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       outer_box->pack_start (insert_label, false, false);
+       outer_box->pack_start (insert_at_combo, false, false);
 
+       //quick-add button  (add item but don't close dialog)
        Gtk::Button* addnoclose_button = manage (new Gtk::Button(_("Add selected items (and leave dialog open)")));
        addnoclose_button->set_can_default ();
        addnoclose_button->signal_clicked ().connect (sigc::bind (sigc::mem_fun (*this, &Gtk::Dialog::response), Add));
-       add_table->attach (*addnoclose_button, 4, 6, n, n + 1, Gtk::FILL, Gtk::SHRINK, 0, 0);
+       outer_box->pack_end (*addnoclose_button, false, false);
 
-       vbox->pack_start (*add_table, false, true);
+       vbox->pack_start (*outer_box, true, true);
 
        get_vbox()->pack_start (*vbox, false, false);
 
@@ -246,6 +339,10 @@ AddRouteDialog::AddRouteDialog ()
        route_group_combo.set_row_separator_func (sigc::mem_fun (*this, &AddRouteDialog::route_separator));
        route_group_combo.signal_changed ().connect (sigc::mem_fun (*this, &AddRouteDialog::group_changed));
 
+       routes_spinner.signal_activate ().connect (sigc::bind (sigc::mem_fun (*this, &Gtk::Dialog::response), AddAndClose));
+       name_template_entry.signal_activate ().connect (sigc::bind (sigc::mem_fun (*this, &Gtk::Dialog::response), AddAndClose));
+       trk_template_chooser.signal_row_activated ().connect (sigc::hide (sigc::hide (sigc::bind (sigc::mem_fun (*this, &Gtk::Dialog::response), AddAndClose))));
+
        show_all_children ();
 
        /* track template info will be managed whenever
@@ -266,7 +363,7 @@ AddRouteDialog::~AddRouteDialog ()
 void
 AddRouteDialog::on_response (int r)
 {
-       name_edited_by_user = false;
+       reset_name_edited ();
        /* Don't call ArdourDialog::on_response() because that will
           automatically hide the dialog.
        */
@@ -325,7 +422,10 @@ AddRouteDialog::trk_template_row_selected ()
 
                if ((it = rs.find ("name")) != rs.end()) {
                        name_template_entry.set_text (it->second);
+               } else {
+                       name_template_entry.set_text ("");
                }
+       
 
                if ((it = rs.find ("how_many")) != rs.end()) {
                        if (atoi (it->second.c_str()) > 0) {
@@ -407,13 +507,21 @@ AddRouteDialog::trk_template_row_selected ()
 void
 AddRouteDialog::name_template_entry_insertion (Glib::ustring const &,int*)
 {
-       name_edited_by_user = true;
+       if (name_template ().empty ()) {
+               name_edited_by_user = false;
+       } else {
+               name_edited_by_user = true;
+       }
 }
 
 void
 AddRouteDialog::name_template_entry_deletion (int, int)
 {
-       name_edited_by_user = true;
+       if (name_template ().empty ()) {
+               name_edited_by_user = false;
+       } else {
+               name_edited_by_user = true;
+       }
 }
 
 void
@@ -495,7 +603,8 @@ AddRouteDialog::maybe_update_name_template_entry ()
                name_template_entry.set_text (VCA::default_name_template());
                break;
        }
-       name_edited_by_user = false;
+       /* ignore programatic change, restore false */
+       reset_name_edited ();
 }
 
 void
@@ -503,26 +612,46 @@ AddRouteDialog::track_type_chosen ()
 {
        switch (type_wanted()) {
        case AudioTrack:
-               mode_combo.set_sensitive (true);
-               channel_combo.set_sensitive (true);
-               instrument_combo.set_sensitive (false);
+
                configuration_label.set_sensitive (true);
+               channel_combo.set_sensitive (true);
+
                mode_label.set_sensitive (true);
+               mode_combo.set_sensitive (true);
+
                instrument_label.set_sensitive (false);
+               instrument_combo.set_sensitive (false);
+
+               group_label.set_sensitive (true);
                route_group_combo.set_sensitive (true);
+
+               strict_io_label.set_sensitive (true);
                strict_io_combo.set_sensitive (true);
+
+               insert_label.set_sensitive (true);
                insert_at_combo.set_sensitive (true);
+               
                break;
        case MidiTrack:
-               channel_combo.set_sensitive (false);
-               mode_combo.set_sensitive (false);
-               instrument_combo.set_sensitive (true);
+
                configuration_label.set_sensitive (false);
+               channel_combo.set_sensitive (false);
+
                mode_label.set_sensitive (false);
+               mode_combo.set_sensitive (false);
+
                instrument_label.set_sensitive (true);
+               instrument_combo.set_sensitive (true);
+
+               group_label.set_sensitive (true);
                route_group_combo.set_sensitive (true);
+
+               strict_io_label.set_sensitive (true);
                strict_io_combo.set_sensitive (true);
+
+               insert_label.set_sensitive (true);
                insert_at_combo.set_sensitive (true);
+               
                break;
        case MixedTrack:
                {
@@ -532,47 +661,88 @@ AddRouteDialog::track_type_chosen ()
                        msg.set_position (WIN_POS_MOUSE);
                        msg.run ();
                }
-               channel_combo.set_sensitive (true);
-               mode_combo.set_sensitive (true);
-               instrument_combo.set_sensitive (true);
+
                configuration_label.set_sensitive (true);
+               channel_combo.set_sensitive (true);
+
                mode_label.set_sensitive (true);
+               mode_combo.set_sensitive (true);
+
                instrument_label.set_sensitive (true);
+               instrument_combo.set_sensitive (true);
+
+               group_label.set_sensitive (true);
                route_group_combo.set_sensitive (true);
+
+               strict_io_label.set_sensitive (true);
                strict_io_combo.set_sensitive (true);
+
+               insert_label.set_sensitive (true);
                insert_at_combo.set_sensitive (true);
+
                break;
        case AudioBus:
-               mode_combo.set_sensitive (false);
-               channel_combo.set_sensitive (true);
-               instrument_combo.set_sensitive (false);
+
                configuration_label.set_sensitive (true);
-               mode_label.set_sensitive (true);
+               channel_combo.set_sensitive (true);
+
+               mode_label.set_sensitive (false);
+               mode_combo.set_sensitive (false);
+
                instrument_label.set_sensitive (false);
+               instrument_combo.set_sensitive (false);
+
+               group_label.set_sensitive (true);
                route_group_combo.set_sensitive (true);
+
+               strict_io_label.set_sensitive (true);
                strict_io_combo.set_sensitive (true);
+
+               insert_label.set_sensitive (true);
                insert_at_combo.set_sensitive (true);
+
                break;
        case VCAMaster:
-               mode_combo.set_sensitive (false);
-               channel_combo.set_sensitive (false);
-               instrument_combo.set_sensitive (false);
+
                configuration_label.set_sensitive (false);
+               channel_combo.set_sensitive (false);
+
                mode_label.set_sensitive (false);
+               mode_combo.set_sensitive (false);
+
                instrument_label.set_sensitive (false);
+               instrument_combo.set_sensitive (false);
+
+               group_label.set_sensitive (false);
                route_group_combo.set_sensitive (false);
+
+               strict_io_label.set_sensitive (false);
                strict_io_combo.set_sensitive (false);
+
+               insert_label.set_sensitive (false);
                insert_at_combo.set_sensitive (false);
+               
                break;
        case MidiBus:
-               mode_combo.set_sensitive (false);
-               channel_combo.set_sensitive (false);
-               instrument_combo.set_sensitive (true);
+
                configuration_label.set_sensitive (false);
-               mode_label.set_sensitive (true);
+               channel_combo.set_sensitive (false);
+
+               mode_label.set_sensitive (false);
+               mode_combo.set_sensitive (false);
+
                instrument_label.set_sensitive (true);
+               instrument_combo.set_sensitive (true);
+
+               group_label.set_sensitive (true);
+               route_group_combo.set_sensitive (true);
+
+               strict_io_label.set_sensitive (true);
                strict_io_combo.set_sensitive (true);
+
+               insert_label.set_sensitive (true);
                insert_at_combo.set_sensitive (true);
+
                break;
        }
 
@@ -684,7 +854,7 @@ void
 AddRouteDialog::on_show ()
 {
        routes_spinner.grab_focus ();
-       name_edited_by_user = false;
+       reset_name_edited ();
 
        refill_route_groups ();
 
@@ -750,11 +920,11 @@ AddRouteDialog::refill_channel_setups ()
        trk_template_model->clear();
        bool selected_default = false;
 
-       for (std::vector<std::string>::const_iterator i = builtin_types.begin(); i != builtin_types.end(); ++i) {
+       for (std::vector<std::pair<std::string,std::string> >::const_iterator i = builtin_types.begin(); i != builtin_types.end(); ++i) {
                TreeModel::Row row = *(trk_template_model->append ());
-               row[track_template_columns.name] = (*i);
+               row[track_template_columns.name] = (*i).first;
                row[track_template_columns.path] = "";
-               row[track_template_columns.description] = _("Use the controls below");
+               row[track_template_columns.description] = (*i).second;
                row[track_template_columns.created_with] = "";
 
                if (!selected_default && !Profile->get_mixbus ()) {