Add a load of explicit keywords.

[dcpomatic.git] / src / wx / audio_mapping_view.h

diff --git a/src/wx/audio_mapping_view.h b/src/wx/audio_mapping_view.h
index 7ed6994633c111a7813951ae92c78dcca3023410..18ab2540772a2c4ede6ad79fb88ab7ab52ef8cfb 100644 (file)
--- a/src/wx/audio_mapping_view.h
+++ b/src/wx/audio_mapping_view.h
@@ -1,27 +1,26 @@
 /*
-    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 /** @file  src/wx/audio_mapping_view.h
- *  @brief AudioMappingView class
+ *  @brief AudioMappingView class.
  *
- *  This class displays the mapping of one set of audio channels to another,
- *  with gain values on each node of the map.
  */
 
 #include <boost/signals2.hpp>
@@ -29,23 +28,62 @@
 #include <wx/grid.h>
 #include "lib/audio_mapping.h"
 
+/** @class AudioMappingView
+ *  @brief This class displays the mapping of one set of audio channels to another,
+ *  with gain values on each node of the map.
+ *
+ *  The AudioMapping passed to set() describes the actual channel mapping,
+ *  and the names passed to set_input_channels() and set_output_channels() are
+ *  used to label the rows and columns.
+ *
+ *  The display's row count is equal to the AudioMapping's input channel count,
+ *  and the column count is equal to the number of name passed to
+ *  set_output_channels().  Any other output channels in the AudioMapping are
+ *  hidden from view.  Thus input channels are never hidden but output channels
+ *  might be.
+ */
+
 class AudioMappingView : public wxPanel
 {
 public:
-       AudioMappingView (wxWindow *);
+       explicit AudioMappingView (wxWindow *);
 
        void set (AudioMapping);
-       void set_channels (int);
+       void set_input_channels (std::vector<std::string> const & names);
+       void set_output_channels (std::vector<std::string> const & names);
+
+       struct Group
+       {
+               Group (int f, int t, std::string n)
+                       : from (f)
+                       , to (t)
+                       , name (n)
+               {}
+
+               /** First channel index (from 0) */
+               int from;
+               /** Last channel index (from 0) */
+               int to;
+               /** Name of this group */
+               std::string name;
+       };
+
+       void set_input_groups (std::vector<Group> const & groups);
 
        boost::signals2::signal<void (AudioMapping)> Changed;
 
 private:
        void left_click (wxGridEvent &);
        void right_click (wxGridEvent &);
-       void mouse_moved (wxMouseEvent &);
-       void set_column_labels ();
+       void mouse_moved_grid (wxMouseEvent &);
        void update_cells ();
-       void map_changed ();
+       void map_values_changed ();
+       void sized (wxSizeEvent &);
+       void paint_left_labels ();
+       void paint_top_labels ();
+       void mouse_moved_left_labels (wxMouseEvent &);
+       void setup_sizes ();
+       void grid_scrolled ();
 
        void off ();
        void full ();
@@ -53,13 +91,17 @@ private:
        void edit ();
 
        wxGrid* _grid;
-       wxSizer* _sizer;
+       wxPanel* _left_labels;
+       wxPanel* _top_labels;
        AudioMapping _map;
 
        wxMenu* _menu;
        int _menu_row;
        int _menu_column;
 
+       std::vector<Group> _input_groups;
+       std::vector<std::pair<int, int> > _input_group_positions;
+
        int _last_tooltip_row;
        int _last_tooltip_column;
 };