gtk2_ardour/visibility_group.cc

   1 /*
   2     Copyright (C) 2011 Paul Davis
   3     Author: Carl Hetherington <cth@carlh.net>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #include <gtkmm/menu.h>
  22 #include <gtkmm/menushell.h>
  23 #include <gtkmm/treeview.h>
  24 #include "pbd/xml++.h"
  25 #include "visibility_group.h"
  26
  27 #include "i18n.h"
  28
  29 using namespace std;
  30
  31 VisibilityGroup::VisibilityGroup (std::string const & name)
  32         : _xml_property_name (name)
  33         , _ignore_list_view_change (false)
  34 {
  35
  36 }
  37
  38 /** Add a widget to the group.
  39  *  @param widget The widget.
  40  *  @param id Some single-word ID to be used for the state of this member in XML.
  41  *  @param name User-visible name for the widget.
  42  *  @param visible true to default to visible, otherwise false.
  43  */
  44
  45 void
  46 VisibilityGroup::add (Gtk::Widget* widget, string const & id, string const & name, bool visible)
  47 {
  48         Member m;
  49         m.widget = widget;
  50         m.id = id;
  51         m.name = name;
  52         m.visible = visible;
  53
  54         _members.push_back (m);
  55 }
  56
  57 /** Pop up a menu (on right-click) to configure visibility of members */
  58 bool
  59 VisibilityGroup::button_press_event (GdkEventButton* ev)
  60 {
  61         if (ev->button != 3) {
  62                 return false;
  63         }
  64
  65         menu()->popup (1, ev->time);
  66         return true;
  67 }
  68
  69 Gtk::Menu*
  70 VisibilityGroup::menu ()
  71 {
  72         using namespace Gtk::Menu_Helpers;
  73
  74         Gtk::Menu* m = Gtk::manage (new Gtk::Menu);
  75         MenuList& items = m->items ();
  76
  77         for (vector<Member>::iterator i = _members.begin(); i != _members.end(); ++i) {
  78                 items.push_back (CheckMenuElem (i->name));
  79                 Gtk::CheckMenuItem* j = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
  80                 j->set_active (i->visible);
  81                 j->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &VisibilityGroup::toggle), i));
  82         }
  83
  84         return m;
  85 }
  86
  87 /** Update visible consequences of any changes to our _members vector */
  88 void
  89 VisibilityGroup::update ()
  90 {
  91         for (vector<Member>::iterator i = _members.begin(); i != _members.end(); ++i) {
  92                 if (i->widget) {
  93                         if (i->visible) {
  94                                 i->widget->show ();
  95                         } else {
  96                                 i->widget->hide ();
  97                         }
  98                 }
  99         }
 100
 101         update_list_view ();
 102
 103         VisibilityChanged (); /* EMIT SIGNAL */
 104 }
 105
 106 void
 107 VisibilityGroup::toggle (vector<Member>::iterator m)
 108 {
 109         m->visible = !m->visible;
 110         update ();
 111 }
 112
 113 void
 114 VisibilityGroup::set_state (XMLNode const & node)
 115 {
 116         XMLProperty const * p = node.property (_xml_property_name);
 117         if (!p) {
 118                 return;
 119         }
 120
 121         set_state (p->value ());
 122 }
 123
 124 void
 125 VisibilityGroup::set_state (string v)
 126 {
 127         for (vector<Member>::iterator i = _members.begin(); i != _members.end(); ++i) {
 128                 i->visible = false;
 129         }
 130
 131         do {
 132                 string::size_type const comma = v.find_first_of (',');
 133                 string segment = v.substr (0, comma);
 134
 135                 for (vector<Member>::iterator i = _members.begin(); i != _members.end(); ++i) {
 136                         if (segment == i->id) {
 137                                 i->visible = true;
 138                         }
 139                 }
 140
 141                 if (comma == string::npos) {
 142                         break;
 143                 }
 144
 145                 v = v.substr (comma + 1);
 146
 147         } while (1);
 148
 149         update ();
 150 }
 151
 152 string
 153 VisibilityGroup::get_state_name () const
 154 {
 155         return _xml_property_name;
 156 }
 157
 158 string
 159 VisibilityGroup::get_state_value () const
 160 {
 161         string result;
 162         for (vector<Member>::const_iterator i = _members.begin(); i != _members.end(); ++i) {
 163                 if (i->visible) {
 164                         if (!result.empty ()) {
 165                                 result += ',';
 166                         }
 167                         result += i->id;
 168                 }
 169         }
 170
 171         return result;
 172 }
 173
 174 void
 175 VisibilityGroup::update_list_view ()
 176 {
 177         if (!_model) {
 178                 return;
 179         }
 180
 181         _ignore_list_view_change = true;
 182
 183         _model->clear ();
 184
 185         for (vector<Member>::iterator i = _members.begin(); i != _members.end(); ++i) {
 186                 Gtk::TreeModel::iterator j = _model->append ();
 187                 Gtk::TreeModel::Row row = *j;
 188                 row[_model_columns._visible] = i->visible;
 189                 row[_model_columns._name] = i->name;
 190                 row[_model_columns._iterator] = i;
 191         }
 192
 193         _ignore_list_view_change = false;
 194 }
 195
 196 Gtk::Widget *
 197 VisibilityGroup::list_view ()
 198 {
 199         _model = Gtk::ListStore::create (_model_columns);
 200
 201         update_list_view ();
 202
 203         Gtk::TreeView* v = Gtk::manage (new Gtk::TreeView (_model));
 204         v->set_headers_visible (false);
 205         v->append_column (_(""), _model_columns._visible);
 206         v->append_column (_(""), _model_columns._name);
 207
 208         Gtk::CellRendererToggle* visible_cell = dynamic_cast<Gtk::CellRendererToggle*> (v->get_column_cell_renderer (0));
 209         visible_cell->property_activatable() = true;
 210         visible_cell->signal_toggled().connect (sigc::mem_fun (*this, &VisibilityGroup::list_view_visible_changed));
 211         return v;
 212 }
 213
 214 void
 215 VisibilityGroup::list_view_visible_changed (string const & path)
 216 {
 217         if (_ignore_list_view_change) {
 218                 return;
 219         }
 220
 221         Gtk::TreeModel::iterator i = _model->get_iter (path);
 222         if (!i) {
 223                 return;
 224         }
 225
 226         vector<Member>::iterator j = (*i)[_model_columns._iterator];
 227         j->visible = !j->visible;
 228         (*i)[_model_columns._visible] = j->visible;
 229
 230         update ();
 231 }