gtk2_ardour/port_matrix.h

   1 /*
   2     Copyright (C) 2002-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 __gtk_ardour_port_matrix_h__
  21 #define __gtk_ardour_port_matrix_h__
  22
  23 #include <list>
  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 <boost/shared_ptr.hpp>
  30 #include "ardour/bundle.h"
  31 #include "port_group.h"
  32 #include "port_matrix_types.h"
  33
  34 /** The `port matrix' UI.  This is a widget which lets the user alter
  35  *  associations between one set of ports and another.  e.g. to connect
  36  *  things together.
  37  *
  38  *  It is made up of a body, PortMatrixBody, which is rendered using cairo,
  39  *  and some scrollbars and other stuff.  All of this is arranged inside the
  40  *  Table that we inherit from.
  41  */
  42
  43 namespace ARDOUR {
  44         class Bundle;
  45 }
  46
  47 class PortMatrixBody;
  48
  49 class PortMatrix : public Gtk::Table
  50 {
  51 public:
  52         PortMatrix (ARDOUR::Session&, ARDOUR::DataType);
  53         ~PortMatrix ();
  54
  55         void set_type (ARDOUR::DataType);
  56
  57         ARDOUR::DataType type () const {
  58                 return _type;
  59         }
  60
  61         void disassociate_all ();
  62         void setup_scrollbars ();
  63         void popup_menu (
  64                 std::pair<boost::shared_ptr<PortGroup>, ARDOUR::BundleChannel>,
  65                 std::pair<boost::shared_ptr<PortGroup>, ARDOUR::BundleChannel>,
  66                 uint32_t
  67                 );
  68
  69         int min_height_divisor () const {
  70                 return _min_height_divisor;
  71         }
  72         void set_min_height_divisor (int f) {
  73                 _min_height_divisor = f;
  74         }
  75
  76         enum Arrangement {
  77                 TOP_TO_RIGHT,  ///< column labels on top, row labels to the right
  78                 LEFT_TO_BOTTOM ///< row labels to the left, column labels on the bottom
  79         };
  80
  81         /** @return Arrangement in use */
  82         Arrangement arrangement () const {
  83                 return _arrangement;
  84         }
  85
  86         bool show_only_bundles () const {
  87                 return _show_only_bundles;
  88         }
  89
  90         PortGroupList const * columns () const;
  91
  92         /** @return index into the _ports array for the list which is displayed as columns */
  93         int column_index () const {
  94                 return _column_index;
  95         }
  96
  97         PortGroupList const * rows () const;
  98
  99         /** @return index into the _ports array for the list which is displayed as rows */
 100         int row_index () const {
 101                 return _row_index;
 102         }
 103
 104         PortGroupList const * ports (int d) const {
 105                 return &_ports[d];
 106         }
 107
 108         void setup ();
 109         virtual void setup_ports (int) = 0;
 110         void setup_all_ports ();
 111
 112         std::pair<uint32_t, uint32_t> max_size () const;
 113         void setup_max_size ();
 114         sigc::signal<void> MaxSizeChanged;
 115
 116         /** @param c Channels; where c[0] is from _ports[0] and c[1] is from _ports[1].
 117          *  @param s New state.
 118          */
 119         virtual void set_state (ARDOUR::BundleChannel c[2], bool s) = 0;
 120
 121         /** @param c Channels; where c[0] is from _ports[0] and c[1] is from _ports[1].
 122          *  @return state
 123          */
 124         virtual PortMatrixNode::State get_state (ARDOUR::BundleChannel c[2]) const = 0;
 125         virtual bool list_is_global (int) const = 0;
 126
 127         virtual void add_channel (boost::shared_ptr<ARDOUR::Bundle>) = 0;
 128         virtual bool can_remove_channels (int) const = 0;
 129         virtual void remove_channel (ARDOUR::BundleChannel) = 0;
 130         virtual bool can_rename_channels (int) const = 0;
 131         virtual void rename_channel (ARDOUR::BundleChannel) {}
 132         virtual std::string disassociation_verb () const = 0;
 133
 134         enum Result {
 135                 Cancelled,
 136                 Accepted
 137         };
 138
 139         sigc::signal<void, Result> Finished;
 140
 141 protected:
 142
 143         /** We have two port group lists.  One will be presented on the rows of the matrix,
 144             the other on the columns.  The PortMatrix chooses the arrangement based on which has
 145             more ports in it.  Subclasses must fill these two lists with the port groups that they
 146             wish to present.  The PortMatrix will arrange its layout such that signal flow is vaguely
 147             from left to right as you go from list 0 to list 1.  Hence subclasses which deal with
 148             inputs and outputs should put outputs in list 0 and inputs in list 1. */
 149         PortGroupList _ports[2];
 150         ARDOUR::Session& _session;
 151
 152 private:
 153
 154         void hscroll_changed ();
 155         void vscroll_changed ();
 156         void routes_changed ();
 157         void reconnect_to_routes ();
 158         void select_arrangement ();
 159         void remove_channel_proxy (boost::weak_ptr<ARDOUR::Bundle>, uint32_t);
 160         void rename_channel_proxy (boost::weak_ptr<ARDOUR::Bundle>, uint32_t);
 161         void disassociate_all_on_channel (boost::weak_ptr<ARDOUR::Bundle>, uint32_t, int);
 162         void setup_global_ports ();
 163         void hide_group (boost::weak_ptr<PortGroup>);
 164         void show_group (boost::weak_ptr<PortGroup>);
 165         void toggle_show_only_bundles ();
 166         bool on_scroll_event (GdkEventScroll *);
 167
 168         /// port type that we are working with
 169         ARDOUR::DataType _type;
 170         std::vector<sigc::connection> _route_connections;
 171
 172         PortMatrixBody* _body;
 173         Gtk::HScrollbar _hscroll;
 174         Gtk::VScrollbar _vscroll;
 175         Gtk::Menu* _menu;
 176         Arrangement _arrangement;
 177         int _row_index;
 178         int _column_index;
 179         int _min_height_divisor;
 180         bool _show_only_bundles;
 181         bool _inhibit_toggle_show_only_bundles;
 182         bool _realized;
 183 };
 184
 185 #endif