suspend editor redisplay during batch changes
[ardour.git] / gtk2_ardour / editor_routes.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 __ardour_gtk_editor_route_h__
21 #define __ardour_gtk_editor_route_h__
22
23 #include "pbd/signals.h"
24 #include "gtkmm2ext/widget_state.h"
25 #include "editor_component.h"
26
27 class EditorRoutes : public EditorComponent, public PBD::ScopedConnectionList, public ARDOUR::SessionHandlePtr
28 {
29 public:
30         EditorRoutes (Editor *);
31
32         void set_session (ARDOUR::Session *);
33
34         Gtk::Widget& widget () {
35                 return _scroller;
36         }
37
38         void move_selected_tracks (bool);
39         void show_track_in_display (TimeAxisView &);
40
41         bool _redisplay_on_resume;
42
43         void suspend_redisplay () {
44                 _redisplay_on_resume = false;
45                 _no_redisplay = true;
46         }
47
48         void resume_redisplay () {
49                 _no_redisplay = false;
50                 if (_redisplay_on_resume) {
51                         redisplay ();
52                 }
53         }
54
55         void redisplay ();
56         void update_visibility ();
57         void routes_added (std::list<RouteTimeAxisView*> routes);
58         void route_removed (TimeAxisView *);
59         void hide_track_in_display (TimeAxisView &);
60         std::list<TimeAxisView*> views () const;
61         void hide_all_tracks (bool);
62         void clear ();
63         void sync_order_keys_from_treeview ();
64         void reset_remote_control_ids ();
65
66 private:
67         void initial_display ();
68         void redisplay_real ();
69         void on_input_active_changed (std::string const &);
70         void on_tv_rec_enable_changed (std::string const &);
71         void on_tv_mute_enable_toggled (std::string const &);
72         void on_tv_solo_enable_toggled (std::string const &);
73         void on_tv_solo_isolate_toggled (std::string const &);
74         void on_tv_solo_safe_toggled (std::string const &);
75         void build_menu ();
76         void show_menu ();
77         void sync_treeview_from_order_keys ();
78         void row_deleted (Gtk::TreeModel::Path const &);
79         void visible_changed (std::string const &);
80         void active_changed (std::string const &);
81         void reordered (Gtk::TreeModel::Path const &, Gtk::TreeModel::iterator const &, int *);
82         bool button_press (GdkEventButton *);
83         void route_property_changed (const PBD::PropertyChange&, boost::weak_ptr<ARDOUR::Route>);
84         void handle_gui_changes (std::string const &, void *);
85         bool idle_update_mute_rec_solo_etc ();
86         void update_rec_display ();
87         void update_mute_display ();
88         void update_solo_display (bool);
89         void update_solo_isolate_display ();
90         void update_solo_safe_display ();
91         void update_input_active_display ();
92         void update_active_display ();
93         void set_all_tracks_visibility (bool);
94         void set_all_audio_midi_visibility (int, bool);
95         void show_all_routes ();
96         void hide_all_routes ();
97         void show_all_audiotracks ();
98         void hide_all_audiotracks ();
99         void show_all_audiobus ();
100         void hide_all_audiobus ();
101         void show_all_miditracks ();
102         void hide_all_miditracks ();
103         void show_tracks_with_regions_at_playhead ();
104         void selection_changed ();
105
106         void display_drag_data_received (
107                 Glib::RefPtr<Gdk::DragContext> const &, gint, gint, Gtk::SelectionData const &, guint, guint
108                 );
109
110         bool selection_filter (Glib::RefPtr<Gtk::TreeModel> const &, Gtk::TreeModel::Path const &, bool);
111         void name_edit (std::string const &, std::string const &);
112         void solo_changed_so_update_mute ();
113
114         struct ModelColumns : public Gtk::TreeModel::ColumnRecord {
115                 ModelColumns() {
116                         add (text);
117                         add (visible);
118                         add (rec_state);
119                         add (mute_state);
120                         add (solo_state);
121                         add (solo_visible);
122                         add (solo_isolate_state);
123                         add (solo_safe_state);
124                         add (is_track);
125                         add (tv);
126                         add (route);
127                         add (name_editable);
128                         add (is_input_active);
129                         add (is_midi);
130                         add (active);
131                 }
132
133                 Gtk::TreeModelColumn<std::string>    text;
134                 Gtk::TreeModelColumn<bool>           visible;
135                 Gtk::TreeModelColumn<uint32_t>       rec_state;
136                 Gtk::TreeModelColumn<uint32_t>       mute_state;
137                 Gtk::TreeModelColumn<uint32_t>       solo_state;
138                 /** true if the solo buttons are visible for this route, otherwise false */
139                 Gtk::TreeModelColumn<bool>           solo_visible;
140                 Gtk::TreeModelColumn<uint32_t>       solo_isolate_state;
141                 Gtk::TreeModelColumn<uint32_t>       solo_safe_state;
142                 Gtk::TreeModelColumn<bool>           is_track;
143                 Gtk::TreeModelColumn<TimeAxisView*>  tv;
144                 Gtk::TreeModelColumn<boost::shared_ptr<ARDOUR::Route> >  route;
145                 Gtk::TreeModelColumn<bool>           name_editable;
146                 Gtk::TreeModelColumn<bool>           is_input_active;
147                 Gtk::TreeModelColumn<bool>           is_midi;
148                 Gtk::TreeModelColumn<bool>           active;
149         };
150
151         Gtk::ScrolledWindow _scroller;
152         Gtkmm2ext::DnDTreeView<boost::shared_ptr<ARDOUR::Route> > _display;
153         Glib::RefPtr<Gtk::ListStore> _model;
154         ModelColumns _columns;
155         int _name_column;
156         int _visible_column;
157         int _active_column;
158
159         bool _ignore_reorder;
160         bool _no_redisplay;
161         bool _adding_routes;
162         bool _route_deletion_in_progress;
163         volatile gint _redisplay_active;
164         volatile gint _queue_tv_update;
165
166         Gtk::Menu* _menu;
167         Gtk::Widget* old_focus;
168         uint32_t selection_countdown;
169         Gtk::CellEditable* name_editable;
170
171         bool key_press (GdkEventKey* ev);
172         bool focus_in (GdkEventFocus*);
173         bool focus_out (GdkEventFocus*);
174         bool enter_notify (GdkEventCrossing*);
175         bool leave_notify (GdkEventCrossing*);
176         void name_edit_started (Gtk::CellEditable*, const Glib::ustring&);
177
178         bool get_relevant_routes (boost::shared_ptr<ARDOUR::RouteList> rl);
179 };
180
181 #endif /* __ardour_gtk_editor_route_h__ */