Tidy up the region menu a bit, and hopefully clarify what regions will be
[ardour.git] / gtk2_ardour / editor_route_groups.cc
1 /*
2     Copyright (C) 2000 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 #include <cstdlib>
21 #include <cmath>
22
23 #include <gtkmm2ext/gtk_ui.h>
24 #include "ardour/route_group.h"
25
26 #include "editor.h"
27 #include "keyboard.h"
28 #include "marker.h"
29 #include "time_axis_view.h"
30 #include "prompter.h"
31 #include "gui_thread.h"
32 #include "editor_group_tabs.h"
33 #include "route_group_dialog.h"
34 #include "route_time_axis.h"
35 #include "editor_routes.h"
36 #include "editor_route_groups.h"
37
38 #include "ardour/route.h"
39 #include "ardour/session.h"
40
41 #include "i18n.h"
42
43 using namespace std;
44 using namespace ARDOUR;
45 using namespace PBD;
46 using namespace Gtk;
47 using Gtkmm2ext::Keyboard;
48
49 EditorRouteGroups::EditorRouteGroups (Editor* e)
50         : EditorComponent (e)
51         , _all_group_active_button (_("No Selection = All Tracks"))
52         , _in_row_change (false)
53
54 {
55         _model = ListStore::create (_columns);
56         _display.set_model (_model);
57
58         _display.append_column (_("Name"), _columns.text);
59
60         _display.append_column (_("G"), _columns.gain);
61         _display.append_column (_("R"), _columns.record);
62         _display.append_column (_("M"), _columns.mute);
63         _display.append_column (_("S"), _columns.solo);
64         _display.append_column (_("Sel"), _columns.select);
65         _display.append_column (_("E"), _columns.edits);
66
67         _display.append_column (_("Show"), _columns.is_visible);
68
69         _display.get_column (0)->set_data (X_("colnum"), GUINT_TO_POINTER(0));
70         _display.get_column (1)->set_data (X_("colnum"), GUINT_TO_POINTER(1));
71         _display.get_column (2)->set_data (X_("colnum"), GUINT_TO_POINTER(2));
72         _display.get_column (3)->set_data (X_("colnum"), GUINT_TO_POINTER(3));
73         _display.get_column (4)->set_data (X_("colnum"), GUINT_TO_POINTER(4));
74         _display.get_column (5)->set_data (X_("colnum"), GUINT_TO_POINTER(5));
75         _display.get_column (6)->set_data (X_("colnum"), GUINT_TO_POINTER(6));
76         _display.get_column (7)->set_data (X_("colnum"), GUINT_TO_POINTER(7));
77
78         _display.get_column (0)->set_expand (true);
79         _display.get_column (1)->set_expand (false);
80         _display.get_column (2)->set_expand (false);
81         _display.get_column (3)->set_expand (false);
82         _display.get_column (4)->set_expand (false);
83         _display.get_column (5)->set_expand (false);
84         _display.get_column (6)->set_expand (false);
85         _display.get_column (7)->set_expand (false);
86
87         _display.set_headers_visible (true);
88
89         /* name is directly editable */
90
91         CellRendererText* name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
92         name_cell->property_editable() = true;
93         name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRouteGroups::name_edit));
94
95         /* use checkbox for the active + visible columns */
96
97         CellRendererToggle* active_cell = dynamic_cast<CellRendererToggle*>(_display.get_column_cell_renderer (1));
98         active_cell->property_activatable() = true;
99         active_cell->property_radio() = false;
100
101         active_cell = dynamic_cast<CellRendererToggle*>(_display.get_column_cell_renderer (2));
102         active_cell->property_activatable() = true;
103         active_cell->property_radio() = false;
104
105         active_cell = dynamic_cast<CellRendererToggle*>(_display.get_column_cell_renderer (3));
106         active_cell->property_activatable() = true;
107         active_cell->property_radio() = false;
108
109         active_cell = dynamic_cast<CellRendererToggle*>(_display.get_column_cell_renderer (4));
110         active_cell->property_activatable() = true;
111         active_cell->property_radio() = false;
112
113         active_cell = dynamic_cast<CellRendererToggle*>(_display.get_column_cell_renderer (5));
114         active_cell->property_activatable() = true;
115         active_cell->property_radio() = false;
116
117         active_cell = dynamic_cast<CellRendererToggle*>(_display.get_column_cell_renderer (6));
118         active_cell->property_activatable() = true;
119         active_cell->property_radio() = false;
120
121         active_cell = dynamic_cast<CellRendererToggle*>(_display.get_column_cell_renderer (7));
122         active_cell->property_activatable() = true;
123         active_cell->property_radio() = false;
124
125         _model->signal_row_changed().connect (sigc::mem_fun (*this, &EditorRouteGroups::row_change));
126
127         _display.set_name ("EditGroupList");
128         _display.get_selection()->set_mode (SELECTION_SINGLE);
129         _display.set_headers_visible (true);
130         _display.set_reorderable (false);
131         _display.set_rules_hint (true);
132         _display.set_size_request (75, -1);
133
134         _scroller.add (_display);
135         _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
136
137         _display.signal_button_press_event().connect (sigc::mem_fun(*this, &EditorRouteGroups::button_press_event), false);
138
139         HBox* button_box = manage (new HBox());
140         button_box->set_homogeneous (true);
141
142         Button* add_button = manage (new Button ());
143         Button* remove_button = manage (new Button ());
144
145         Widget* w;
146
147         w = manage (new Image (Stock::ADD, ICON_SIZE_BUTTON));
148         w->show();
149         add_button->add (*w);
150
151         w = manage (new Image (Stock::REMOVE, ICON_SIZE_BUTTON));
152         w->show();
153         remove_button->add (*w);
154
155         add_button->signal_clicked().connect (sigc::hide_return (sigc::mem_fun (*this, &EditorRouteGroups::run_new_group_dialog)));
156         remove_button->signal_clicked().connect (sigc::mem_fun (*this, &EditorRouteGroups::remove_selected));
157
158         button_box->pack_start (*add_button);
159         button_box->pack_start (*remove_button);
160
161         _all_group_active_button.show ();
162
163         _display_packer.pack_start (_scroller, true, true);
164         _display_packer.pack_start (_all_group_active_button, false, false);
165         _display_packer.pack_start (*button_box, false, false);
166
167         _all_group_active_button.signal_toggled().connect (sigc::mem_fun (*this, &EditorRouteGroups::all_group_toggled));
168 }
169
170 void
171 EditorRouteGroups::remove_selected ()
172 {
173         Glib::RefPtr<TreeSelection> selection = _display.get_selection();
174         TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
175
176         if (rows.empty()) {
177                 return;
178         }
179
180         TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
181         TreeIter iter;
182
183         /* selection mode is single, so rows.begin() is it */
184
185         if ((iter = _model->get_iter (*i))) {
186
187                 RouteGroup* rg = (*iter)[_columns.routegroup];
188
189                 if (rg) {
190                         _session->remove_route_group (*rg);
191                 }
192         }
193 }
194
195 void
196 EditorRouteGroups::button_clicked ()
197 {
198         run_new_group_dialog ();
199 }
200
201 gint
202 EditorRouteGroups::button_press_event (GdkEventButton* ev)
203 {
204         TreeModel::Path path;
205         TreeIter iter;
206         RouteGroup* group = 0;
207         TreeViewColumn* column;
208         int cellx;
209         int celly;
210
211         bool const p = _display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly);
212
213         if (p) {
214                 iter = _model->get_iter (path);
215         }
216
217         if (iter) {
218                 group = (*iter)[_columns.routegroup];
219         }
220
221         if (Keyboard::is_context_menu_event (ev)) {
222                 _editor->_group_tabs->get_menu(group)->popup (1, ev->time);
223                 return true;
224         }
225
226         if (!p) {
227                 return 1;
228         }
229
230         switch (GPOINTER_TO_UINT (column->get_data (X_("colnum")))) {
231         case 0:
232                 if (Keyboard::is_edit_event (ev)) {
233                         if ((iter = _model->get_iter (path))) {
234                                 if ((group = (*iter)[_columns.routegroup]) != 0) {
235                                         // edit_route_group (group);
236 #ifdef GTKOSX
237                                         _display.queue_draw();
238 #endif
239                                         return true;
240                                 }
241                         }
242
243                 }
244                 break;
245
246         case 1:
247                 if ((iter = _model->get_iter (path))) {
248                         bool gain = (*iter)[_columns.gain];
249                         (*iter)[_columns.gain] = !gain;
250 #ifdef GTKOSX
251                         _display.queue_draw();
252 #endif
253                         return true;
254                 }
255                 break;
256
257         case 2:
258                 if ((iter = _model->get_iter (path))) {
259                         bool record = (*iter)[_columns.record];
260                         (*iter)[_columns.record] = !record;
261 #ifdef GTKOSX
262                         _display.queue_draw();
263 #endif
264                         return true;
265                 }
266                 break;
267
268         case 3:
269                 if ((iter = _model->get_iter (path))) {
270                         bool mute = (*iter)[_columns.mute];
271                         (*iter)[_columns.mute] = !mute;
272 #ifdef GTKOSX
273                         _display.queue_draw();
274 #endif
275                         return true;
276                 }
277                 break;
278
279         case 4:
280                 if ((iter = _model->get_iter (path))) {
281                         bool solo = (*iter)[_columns.solo];
282                         (*iter)[_columns.solo] = !solo;
283 #ifdef GTKOSX
284                         _display.queue_draw();
285 #endif
286                         return true;
287                 }
288                 break;
289
290         case 5:
291                 if ((iter = _model->get_iter (path))) {
292                         bool select = (*iter)[_columns.select];
293                         (*iter)[_columns.select] = !select;
294 #ifdef GTKOSX
295                         _display.queue_draw();
296 #endif
297                         return true;
298                 }
299                 break;
300
301         case 6:
302                 if ((iter = _model->get_iter (path))) {
303                         bool edits = (*iter)[_columns.edits];
304                         (*iter)[_columns.edits] = !edits;
305 #ifdef GTKOSX
306                         _display.queue_draw();
307 #endif
308                         return true;
309                 }
310                 break;
311
312         case 7:
313                 if ((iter = _model->get_iter (path))) {
314                         bool visible = (*iter)[_columns.is_visible];
315                         (*iter)[_columns.is_visible] = !visible;
316 #ifdef GTKOSX
317                         _display.queue_draw();
318 #endif
319                         return true;
320                 }
321                 break;
322
323         default:
324                 break;
325         }
326
327         return false;
328  }
329
330 void
331 EditorRouteGroups::row_change (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator& iter)
332 {
333         RouteGroup* group;
334
335         if (_in_row_change) {
336                 return;
337         }
338
339         if ((group = (*iter)[_columns.routegroup]) == 0) {
340                 return;
341         }
342
343         if ((*iter)[_columns.is_visible]) {
344                 for (TrackViewList::const_iterator j = _editor->get_track_views().begin(); j != _editor->get_track_views().end(); ++j) {
345                         if ((*j)->route_group() == group) {
346                                 _editor->_routes->show_track_in_display (**j);
347                         }
348                 }
349         } else {
350                 for (TrackViewList::const_iterator j = _editor->get_track_views().begin(); j != _editor->get_track_views().end(); ++j) {
351                         if ((*j)->route_group() == group) {
352                                 _editor->hide_track_in_display (*j);
353                         }
354                 }
355         }
356
357         PropertyList plist;
358         bool val = (*iter)[_columns.gain];
359         plist.add (Properties::gain, val);
360         val = (*iter)[_columns.record];
361         plist.add (Properties::recenable, val);
362         val = (*iter)[_columns.mute];
363         plist.add (Properties::mute, val);
364         val = (*iter)[_columns.solo];
365         plist.add (Properties::solo, val);
366         val = (*iter)[_columns.select];
367         plist.add (Properties::select, val);
368         val = (*iter)[_columns.edits];
369         plist.add (Properties::edit, val);
370         plist.add (Properties::name, string ((*iter)[_columns.text]));
371         
372         group->set_hidden (!(*iter)[_columns.is_visible], this);
373         
374         group->apply_changes (plist);
375 }
376
377 void
378 EditorRouteGroups::add (RouteGroup* group)
379 {
380         ENSURE_GUI_THREAD (*this, &EditorRouteGroups::add, group)
381         bool focus = false;
382
383         TreeModel::Row row = *(_model->append());
384
385         row[_columns.is_visible] = !group->is_hidden();
386         row[_columns.gain] = group->is_gain ();
387         row[_columns.record] = group->is_recenable();
388         row[_columns.mute] = group->is_mute ();
389         row[_columns.solo] = group->is_solo ();
390         row[_columns.select] = group->is_select ();
391         row[_columns.edits] = group->is_edit ();
392
393         _in_row_change = true;
394
395         row[_columns.routegroup] = group;
396
397         if (!group->name().empty()) {
398                 row[_columns.text] = group->name();
399         } else {
400                 row[_columns.text] = _("unnamed");
401                 focus = true;
402         }
403
404         group->PropertyChanged.connect (property_changed_connection, MISSING_INVALIDATOR, ui_bind (&EditorRouteGroups::property_changed, this, group, _1), gui_context());
405
406         if (focus) {
407                 TreeViewColumn* col = _display.get_column (0);
408                 CellRendererText* name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
409                 _display.set_cursor (_model->get_path (row), *col, *name_cell, true);
410         }
411
412         _in_row_change = false;
413
414         _editor->_group_tabs->set_dirty ();
415 }
416
417 void
418 EditorRouteGroups::groups_changed ()
419 {
420         ENSURE_GUI_THREAD (*this, &EditorRouteGroups::groups_changed)
421
422         /* just rebuild the while thing */
423
424         _model->clear ();
425
426         if (_session) {
427                 _session->foreach_route_group (sigc::mem_fun (*this, &EditorRouteGroups::add));
428         }
429 }
430
431 void
432 EditorRouteGroups::property_changed (RouteGroup* group, const PropertyChange& change)
433 {
434         _in_row_change = true;
435
436         Gtk::TreeModel::Children children = _model->children();
437
438         for(Gtk::TreeModel::Children::iterator iter = children.begin(); iter != children.end(); ++iter) {
439                 if (group == (*iter)[_columns.routegroup]) {
440                         (*iter)[_columns.is_visible] = !group->is_hidden();
441                         (*iter)[_columns.text] = group->name();
442                         (*iter)[_columns.gain] = group->is_gain ();
443                         (*iter)[_columns.record] = group->is_recenable ();
444                         (*iter)[_columns.mute] = group->is_mute ();
445                         (*iter)[_columns.solo] = group->is_solo ();
446                         (*iter)[_columns.select] = group->is_select ();
447                         (*iter)[_columns.edits] = group->is_edit ();
448                 }
449         }
450
451         _in_row_change = false;
452
453         if (change.contains (Properties::name) || change.contains (Properties::active)) {
454                 _editor->_group_tabs->set_dirty ();
455         }
456 }
457
458 void
459 EditorRouteGroups::name_edit (const std::string& path, const std::string& new_text)
460 {
461         RouteGroup* group;
462         TreeIter iter;
463
464         if ((iter = _model->get_iter (path))) {
465
466                 if ((group = (*iter)[_columns.routegroup]) == 0) {
467                         return;
468                 }
469
470                 if (new_text != group->name()) {
471                         group->set_name (new_text);
472                 }
473         }
474 }
475
476 void
477 EditorRouteGroups::clear ()
478 {
479         _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
480         _model->clear ();
481         _display.set_model (_model);
482 }
483
484 void
485 EditorRouteGroups::set_session (Session* s)
486 {
487         SessionHandlePtr::set_session (s);
488
489         if (_session) {
490
491                 RouteGroup& arg (_session->all_route_group());
492                 
493                 arg.PropertyChanged.connect (property_changed_connection, MISSING_INVALIDATOR, ui_bind (&EditorRouteGroups::all_group_changed, this, _1), gui_context());
494
495                 _session->route_group_added.connect (_session_connections, MISSING_INVALIDATOR, ui_bind (&EditorRouteGroups::add, this, _1), gui_context());
496                 _session->route_group_removed.connect (_session_connections, MISSING_INVALIDATOR, boost::bind (&EditorRouteGroups::groups_changed, this), gui_context());
497         }
498
499         PBD::PropertyChange pc;
500         pc.add (Properties::select);
501         pc.add (Properties::active);
502         all_group_changed (pc);
503
504         groups_changed ();
505 }
506
507 void
508 EditorRouteGroups::run_new_group_dialog ()
509 {
510         RouteList rl;
511         
512         return _editor->_group_tabs->run_new_group_dialog (rl);
513 }
514
515 void
516 EditorRouteGroups::all_group_toggled ()
517 {
518         if (_session) {
519                 _session->all_route_group().set_select (_all_group_active_button.get_active());
520         }
521 }
522
523 void
524 EditorRouteGroups::all_group_changed (const PropertyChange&)
525 {
526         if (_session) {
527                 RouteGroup& arg (_session->all_route_group());
528                 _all_group_active_button.set_active (arg.is_active() && arg.is_select());
529         } else {
530                 _all_group_active_button.set_active (false);
531         }
532
533 }
534