Add some comments to the RegionSelection class.
[ardour.git] / gtk2_ardour / mixer_ui.h
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 #ifndef __ardour_mixer_ui_h__
21 #define __ardour_mixer_ui_h__
22
23 #include <list>
24
25 #include <gtkmm/box.h>
26 #include <gtkmm/scrolledwindow.h>
27 #include <gtkmm/eventbox.h>
28 #include <gtkmm/label.h>
29 #include <gtkmm/button.h>
30 #include <gtkmm/frame.h>
31 #include <gtkmm/paned.h>
32 #include <gtkmm/menu.h>
33 #include <gtkmm/treeview.h>
34
35 #include <pbd/stateful.h>
36
37 #include <ardour/ardour.h>
38 #include <ardour/io.h>
39
40 #include "route_processor_selection.h"
41 #include "enums.h"
42
43 namespace ARDOUR {
44         class Route;
45         class RouteGroup;
46         class Session;
47         class AudioDiskstream;
48 };
49
50 class MixerStrip;
51 class PluginSelector;
52
53 class Mixer_UI : public Gtk::Window
54 {
55   public:
56         Mixer_UI ();
57         ~Mixer_UI();
58
59         void connect_to_session (ARDOUR::Session *);
60         
61         PluginSelector&  plugin_selector() { return *_plugin_selector; }
62
63         void  set_strip_width (Width);
64         Width get_strip_width () const { return _strip_width; }
65
66         void unselect_strip_in_display (MixerStrip*);
67         void select_strip_in_display (MixerStrip*);
68
69         XMLNode& get_state (void);
70         int set_state (const XMLNode& );
71
72         void show_window ();
73         bool hide_window (GdkEventAny *ev);
74         void show_strip (MixerStrip *);
75         void hide_strip (MixerStrip *);
76
77         void ensure_float (Gtk::Window&);
78
79         RouteRedirectSelection& selection() { return _selection; }
80         
81   private:
82         ARDOUR::Session         *session;
83
84         bool                                    _visible;
85         
86         Gtk::HBox                               global_hpacker;
87         Gtk::VBox                               global_vpacker;
88         Gtk::ScrolledWindow             scroller;
89         Gtk::EventBox                   scroller_base;
90         Gtk::HBox                               scroller_hpacker;
91         Gtk::VBox                               mixer_scroller_vpacker;
92         Gtk::VBox                               list_vpacker;
93         Gtk::Label                              group_display_button_label;
94         Gtk::Button                             group_display_button;
95         Gtk::ScrolledWindow             track_display_scroller;
96         Gtk::ScrolledWindow             group_display_scroller;
97         Gtk::VBox                               group_display_vbox;
98         Gtk::Frame                              track_display_frame;
99         Gtk::Frame                              group_display_frame;
100         Gtk::VPaned                             rhs_pane1;
101         Gtk::HBox                               strip_packer;
102         Gtk::HBox                               out_packer;
103         Gtk::HPaned                             list_hpane;
104
105         // for restoring window geometry.
106         int m_root_x, m_root_y, m_width, m_height;
107         
108         void set_window_pos_and_size ();
109         void get_window_pos_and_size ();
110
111         bool on_key_press_event (GdkEventKey*);
112
113         void pane_allocation_handler (Gtk::Allocation&, Gtk::Paned*);
114         
115         list<MixerStrip *> strips;
116
117         bool strip_scroller_button_release (GdkEventButton*);
118
119         void add_strip (ARDOUR::Session::RouteList&);
120         void remove_strip (MixerStrip *);
121
122         void hide_all_strips (bool with_select);
123         void unselect_all_strips();
124         void select_all_strips ();
125         void unselect_all_audiotrack_strips ();
126         void select_all_audiotrack_strips ();
127         void unselect_all_audiobus_strips ();
128         void select_all_audiobus_strips ();
129
130         void strip_select_op (bool audiotrack, bool select);
131         void select_strip_op (MixerStrip*, bool select);
132
133         void follow_strip_selection ();
134
135         gint start_updating ();
136         gint stop_updating ();
137
138         void disconnect_from_session ();
139         
140         sigc::connection fast_screen_update_connection;
141         void fast_update_strips ();
142
143         void track_name_changed (MixerStrip *);
144
145         void redisplay_track_list ();
146         bool no_track_list_redisplay;
147         bool track_display_button_press (GdkEventButton*);
148         
149         void track_list_change (const Gtk::TreeModel::Path&,const Gtk::TreeModel::iterator&);
150         void track_list_delete (const Gtk::TreeModel::Path&);
151
152         void initial_track_display ();
153         void show_track_list_menu ();
154
155         void set_all_strips_visibility (bool yn);
156         void set_all_audio_visibility (int tracks, bool yn);
157         
158         void hide_all_routes ();
159         void show_all_routes ();
160         void show_all_audiobus ();
161         void hide_all_audiobus ();
162         void show_all_audiotracks();
163         void hide_all_audiotracks ();
164
165         Gtk::Menu* mix_group_context_menu;
166         bool in_group_row_change;
167
168         void group_selected (gint row, gint col, GdkEvent *ev);
169         void group_unselected (gint row, gint col, GdkEvent *ev);
170         void group_display_active_clicked();
171         void new_mix_group ();
172         void remove_selected_mix_group ();
173         void build_mix_group_context_menu ();
174         void activate_all_mix_groups ();
175         void disable_all_mix_groups ();
176         void add_mix_group (ARDOUR::RouteGroup *);
177         void mix_groups_changed ();
178         void mix_group_name_edit (const Glib::ustring&, const Glib::ustring&);
179         void mix_group_row_change (const Gtk::TreeModel::Path& path,const Gtk::TreeModel::iterator& iter);
180
181         Gtk::Menu *track_menu;
182         void track_column_click (gint);
183         void build_track_menu ();
184
185         PluginSelector    *_plugin_selector;
186
187         void strip_name_changed (MixerStrip *);
188
189         void group_flags_changed (void *src, ARDOUR::RouteGroup *);
190
191         /* various treeviews */
192         
193         struct TrackDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
194             TrackDisplayModelColumns () {
195                     add (text);
196                     add (visible);
197                     add (route);
198                     add (strip);
199             }
200             Gtk::TreeModelColumn<bool>           visible;
201             Gtk::TreeModelColumn<Glib::ustring>  text;
202             Gtk::TreeModelColumn<boost::shared_ptr<ARDOUR::Route> > route;
203             Gtk::TreeModelColumn<MixerStrip*>    strip;
204         };
205
206         struct GroupDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
207             GroupDisplayModelColumns() { 
208                     add (active);
209                     add (visible);
210                     add (text);
211                     add (group);
212             }
213             Gtk::TreeModelColumn<bool>                                  active;
214             Gtk::TreeModelColumn<bool>                                  visible;
215             Gtk::TreeModelColumn<Glib::ustring>                 text;
216             Gtk::TreeModelColumn<ARDOUR::RouteGroup*>   group;
217         };
218
219         TrackDisplayModelColumns    track_columns;
220         GroupDisplayModelColumns    group_columns;
221
222         Gtk::TreeView track_display;
223         Gtk::TreeView group_display;
224
225         Glib::RefPtr<Gtk::ListStore> track_model;
226         Glib::RefPtr<Gtk::ListStore> group_model;
227
228         bool group_display_button_press (GdkEventButton*);
229         void group_display_selection_changed ();
230
231         bool strip_button_release_event (GdkEventButton*, MixerStrip*);
232
233         RouteRedirectSelection _selection;
234
235         Width _strip_width;
236
237         static const int32_t default_width = 478;
238         static const int32_t default_height = 765;
239 };
240
241 #endif /* __ardour_mixer_ui_h__ */
242
243