2 Copyright (C) 2002-2009 Paul Davis
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.
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.
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.
20 #ifndef __gtk_ardour_port_matrix_h__
21 #define __gtk_ardour_port_matrix_h__
24 #include <gtkmm/box.h>
25 #include <gtkmm/scrollbar.h>
26 #include <gtkmm/table.h>
27 #include <gtkmm/label.h>
28 #include <gtkmm/checkbutton.h>
29 #include <gtkmm/notebook.h>
30 #include <boost/shared_ptr.hpp>
32 #include "ardour/bundle.h"
33 #include "ardour/types.h"
34 #include "ardour/session_handle.h"
36 #include "port_group.h"
37 #include "port_matrix_types.h"
40 /** The `port matrix' UI. This is a widget which lets the user alter
41 * associations between one set of ports and another. e.g. to connect
44 * It is made up of a body, PortMatrixBody, which is rendered using cairo,
45 * and some scrollbars and other stuff. All of this is arranged inside the
46 * Table that we inherit from.
54 namespace Menu_Helpers {
61 class PortMatrix : public Gtk::Table, public ARDOUR::SessionHandlePtr
64 PortMatrix (Gtk::Window*, ARDOUR::Session *, ARDOUR::DataType);
67 void set_type (ARDOUR::DataType);
69 ARDOUR::DataType type () const {
73 void disassociate_all ();
74 void setup_scrollbars ();
75 void popup_menu (ARDOUR::BundleChannel, ARDOUR::BundleChannel, uint32_t);
77 int min_height_divisor () const {
78 return _min_height_divisor;
80 void set_min_height_divisor (int f) {
81 _min_height_divisor = f;
85 TOP_TO_RIGHT, ///< column labels on top, row labels to the right
86 LEFT_TO_BOTTOM ///< row labels to the left, column labels on the bottom
90 /** @return Arrangement in use */
91 Arrangement arrangement () const {
95 bool show_only_bundles () const {
96 return _show_only_bundles;
99 PortGroupList const * columns () const;
100 boost::shared_ptr<const PortGroup> visible_columns () const;
102 /** @return index into the _ports array for the list which is displayed as columns */
103 int column_index () const {
104 return _column_index;
107 PortGroupList const * rows () const;
108 boost::shared_ptr<const PortGroup> visible_rows () const;
110 /** @return index into the _ports array for the list which is displayed as rows */
111 int row_index () const {
115 PortGroupList const * ports (int d) const {
119 boost::shared_ptr<const PortGroup> visible_ports (int d) const;
123 virtual void setup_ports (int) = 0;
124 void setup_all_ports ();
126 std::pair<uint32_t, uint32_t> max_size () const;
128 /** @param c Channels; where c[0] is from _ports[0] and c[1] is from _ports[1].
129 * @param s New state.
131 virtual void set_state (ARDOUR::BundleChannel c[2], bool s) = 0;
133 /** @param c Channels; where c[0] is from _ports[0] and c[1] is from _ports[1].
136 virtual PortMatrixNode::State get_state (ARDOUR::BundleChannel c[2]) const = 0;
137 virtual bool list_is_global (int) const = 0;
139 virtual bool can_add_channel (boost::shared_ptr<ARDOUR::Bundle>) const;
140 virtual void add_channel (boost::shared_ptr<ARDOUR::Bundle>);
141 virtual bool can_remove_channels (boost::shared_ptr<ARDOUR::Bundle>) const;
142 virtual void remove_channel (ARDOUR::BundleChannel);
143 virtual bool can_rename_channels (boost::shared_ptr<ARDOUR::Bundle>) const {
146 virtual void rename_channel (ARDOUR::BundleChannel) {}
147 virtual std::string disassociation_verb () const = 0;
148 virtual std::string channel_noun () const { return _("channel"); }
155 sigc::signal<void, Result> Finished;
159 /** We have two port group lists. One will be presented on the rows of the matrix,
160 the other on the columns. The PortMatrix chooses the arrangement based on which has
161 more ports in it. Subclasses must fill these two lists with the port groups that they
162 wish to present. The PortMatrix will arrange its layout such that signal flow is vaguely
163 from left to right as you go from list 0 to list 1. Hence subclasses which deal with
164 inputs and outputs should put outputs in list 0 and inputs in list 1. */
165 PortGroupList _ports[2];
169 void hscroll_changed ();
170 void vscroll_changed ();
171 void routes_changed ();
172 void reconnect_to_routes ();
173 void select_arrangement ();
174 void add_channel_proxy (boost::weak_ptr<ARDOUR::Bundle>);
175 void remove_channel_proxy (boost::weak_ptr<ARDOUR::Bundle>, uint32_t);
176 void rename_channel_proxy (boost::weak_ptr<ARDOUR::Bundle>, uint32_t);
177 void disassociate_all_on_channel (boost::weak_ptr<ARDOUR::Bundle>, uint32_t, int);
178 void setup_global_ports ();
179 void toggle_show_only_bundles ();
180 bool on_scroll_event (GdkEventScroll *);
181 boost::shared_ptr<ARDOUR::IO> io_from_bundle (boost::shared_ptr<ARDOUR::Bundle>) const;
182 void setup_notebooks ();
183 void remove_notebook_pages (Gtk::Notebook &);
184 void notebook_page_selected (GtkNotebookPage *, guint);
185 void route_processors_changed (ARDOUR::RouteProcessorChange);
186 void body_dimensions_changed ();
187 void session_going_away ();
188 void add_remove_option (Gtk::Menu_Helpers::MenuList &, boost::weak_ptr<ARDOUR::Bundle>, int);
189 void add_disassociate_option (Gtk::Menu_Helpers::MenuList &, boost::weak_ptr<ARDOUR::Bundle>, int, int);
191 Gtk::Window* _parent;
193 /// port type that we are working with
194 ARDOUR::DataType _type;
195 PBD::ScopedConnectionList _route_connections;
197 PortMatrixBody* _body;
198 Gtk::HScrollbar _hscroll;
199 Gtk::VScrollbar _vscroll;
200 Gtk::Notebook _vnotebook;
201 Gtk::Notebook _hnotebook;
209 Arrangement _arrangement;
212 int _min_height_divisor;
213 bool _show_only_bundles;
214 bool _inhibit_toggle_show_only_bundles;
215 bool _ignore_notebook_page_selected;