Implements filtering in bindings editor
[ardour.git] / gtk2_ardour / keyeditor.h
1 /*
2     Copyright (C) 2012 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_key_editor_h__
21 #define __ardour_gtk_key_editor_h__
22
23 #include <string>
24
25 #include <gtkmm/buttonbox.h>
26 #include <gtkmm/notebook.h>
27 #include <gtkmm/scrolledwindow.h>
28 #include <gtkmm/treeview.h>
29 #include <gtkmm/treestore.h>
30 #include "gtkmm2ext/searchbar.h"
31
32 #include "ardour_window.h"
33
34 namespace Gtkmm2ext {
35         class Bindings;
36 }
37
38 class KeyEditor : public ArdourWindow
39 {
40   public:
41         KeyEditor ();
42
43         void add_tab (std::string const &name, Gtkmm2ext::Bindings&);
44
45         private:
46         class Tab : public Gtk::VBox
47         {
48                 public:
49                 Tab (KeyEditor&, std::string const &name, Gtkmm2ext::Bindings*);
50
51                 void populate ();
52                 void unbind ();
53                 void bind (GdkEventKey* release_event, guint pressed_key);
54                 void action_selected ();
55                 void sort_column_changed ();
56                 void tab_mapped ();
57                 bool visible_func(const Gtk::TreeModel::const_iterator& iter) const;
58
59                 struct KeyEditorColumns : public Gtk::TreeModel::ColumnRecord {
60                         KeyEditorColumns () {
61                                 add (name);
62                                 add (binding);
63                                 add (path);
64                                 add (bindable);
65                                 add (action);
66                         }
67                         Gtk::TreeModelColumn<std::string> name;
68                         Gtk::TreeModelColumn<std::string> binding;
69                         Gtk::TreeModelColumn<std::string> path;
70                         Gtk::TreeModelColumn<bool> bindable;
71                         Gtk::TreeModelColumn<Glib::RefPtr<Gtk::Action> > action;
72                 };
73
74                 Gtk::VBox vpacker;
75                 /* give KeyEditor full access to these. This is just a helper
76                    class with no special semantics
77                 */
78
79                 KeyEditor& owner;
80                 std::string name;
81                 Gtkmm2ext::Bindings* bindings;
82                 Gtk::ScrolledWindow scroller;
83                 Gtk::TreeView view;
84                 Glib::RefPtr<Gtk::TreeStore> data_model;
85                 Glib::RefPtr<Gtk::TreeModelFilter> filter;
86                 Glib::RefPtr<Gtk::TreeModelSort> sorted_filter;
87                 KeyEditorColumns columns;
88                 guint last_keyval;
89
90                 protected:
91                 bool on_key_press_event (GdkEventKey*);
92                 bool on_key_release_event (GdkEventKey*);
93                 Gtk::TreeModel::iterator find_action_path (Gtk::TreeModel::const_iterator begin, Gtk::TreeModel::const_iterator end, const std::string& path) const;
94         };
95
96         friend class Tab;
97
98         Gtk::VBox vpacker;
99         Gtk::Notebook notebook;
100         Gtk::Button unbind_button;
101         Gtk::HButtonBox unbind_box;
102         Gtk::HBox reset_box;
103         Gtk::Button reset_button;
104         Gtk::Label reset_label;
105         Gtkmm2ext::SearchBar filter_entry;
106         std::string filter_string;
107
108         typedef std::vector<Tab*> Tabs;
109
110         Tabs tabs;
111         Tab* current_tab();
112
113         void unbind ();
114         void reset ();
115         void page_change (GtkNotebookPage*, guint);
116
117         unsigned int sort_column;
118         Gtk::SortType sort_type;
119         void toggle_sort_type ();
120         void search_string_updated (const std::string&);
121 };
122
123 #endif /* __ardour_gtk_key_editor_h__ */