2 Copyright (C) 2011 Paul Davis
3 Author: Carl Hetherington <cth@carlh.net>
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.
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.
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.
21 #include <gtkmm/menu.h>
22 #include <gtkmm/menushell.h>
23 #include <gtkmm/treeview.h>
25 #include "pbd/strsplit.h"
26 #include "pbd/xml++.h"
28 #include "visibility_group.h"
34 VisibilityGroup::VisibilityGroup (std::string const & name)
35 : _xml_property_name (name)
36 , _ignore_list_view_change (false)
41 /** Add a widget to the group.
42 * @param widget The widget.
43 * @param id Some single-word ID to be used for the state of this member in XML.
44 * @param name User-visible name for the widget.
45 * @param visible true to default to visible, otherwise false.
46 * @param override A functor to decide whether the visibility specified by the member should be
47 * overridden by some external factor; if the returned optional value is given, it will be used
48 * to override whatever visibility setting the member has.
52 VisibilityGroup::add (Gtk::Widget* widget, string const & id, string const & name, bool visible, boost::function<boost::optional<bool> ()> override)
59 m.override = override;
61 _members.push_back (m);
64 /** Pop up a menu (on right-click) to configure visibility of members */
66 VisibilityGroup::button_press_event (GdkEventButton* ev)
68 if (ev->button != 3) {
72 menu()->popup (1, ev->time);
77 VisibilityGroup::menu ()
79 using namespace Gtk::Menu_Helpers;
81 Gtk::Menu* m = Gtk::manage (new Gtk::Menu);
82 MenuList& items = m->items ();
84 for (vector<Member>::iterator i = _members.begin(); i != _members.end(); ++i) {
85 items.push_back (CheckMenuElem (i->name));
86 Gtk::CheckMenuItem* j = dynamic_cast<Gtk::CheckMenuItem*> (&items.back ());
87 j->set_active (i->visible);
88 j->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &VisibilityGroup::toggle), i));
94 /** @return true if the member should be visible, even taking into account any override functor */
96 VisibilityGroup::should_actually_be_visible (Member const & m) const
99 boost::optional<bool> o = m.override ();
108 /** Update visible consequences of any changes to our _members vector */
110 VisibilityGroup::update ()
112 for (vector<Member>::iterator i = _members.begin(); i != _members.end(); ++i) {
114 if (should_actually_be_visible (*i)) {
124 VisibilityChanged (); /* EMIT SIGNAL */
128 VisibilityGroup::toggle (vector<Member>::iterator m)
130 m->visible = !m->visible;
135 VisibilityGroup::set_state (XMLNode const & node)
137 XMLProperty const * p = node.property (_xml_property_name);
142 set_state (p->value ());
146 VisibilityGroup::set_state (string v)
148 for (vector<Member>::iterator i = _members.begin(); i != _members.end(); ++i) {
153 string::size_type const comma = v.find_first_of (',');
154 string segment = v.substr (0, comma);
156 for (vector<Member>::iterator i = _members.begin(); i != _members.end(); ++i) {
157 if (segment == i->id) {
162 if (comma == string::npos) {
166 v = v.substr (comma + 1);
174 VisibilityGroup::remove_element (std::string const& from, std::string const& element)
176 std::vector<string> s;
179 split (from, s, ',');
180 for (std::vector<string>::const_iterator i = s.begin(); i != s.end(); ++i) {
181 if ((*i) == element) {
194 VisibilityGroup::add_element (std::string const& from, std::string const& element)
196 std::vector<string> s;
199 split (from, s, ',');
201 for (std::vector<string>::const_iterator i = s.begin(); i != s.end(); ++i) {
202 if ((*i) == element) {
203 /* already present, just return the original */
220 VisibilityGroup::get_state_name () const
222 return _xml_property_name;
226 VisibilityGroup::get_state_value () const
229 for (vector<Member>::const_iterator i = _members.begin(); i != _members.end(); ++i) {
231 if (!result.empty ()) {
242 VisibilityGroup::update_list_view ()
248 _ignore_list_view_change = true;
252 for (vector<Member>::iterator i = _members.begin(); i != _members.end(); ++i) {
253 Gtk::TreeModel::iterator j = _model->append ();
254 Gtk::TreeModel::Row row = *j;
255 row[_model_columns._visible] = i->visible;
256 row[_model_columns._name] = i->name;
257 row[_model_columns._iterator] = i;
260 _ignore_list_view_change = false;
264 VisibilityGroup::list_view ()
266 _model = Gtk::ListStore::create (_model_columns);
270 Gtk::TreeView* v = Gtk::manage (new Gtk::TreeView (_model));
271 v->set_headers_visible (false);
272 v->append_column ("", _model_columns._visible);
273 v->append_column ("", _model_columns._name);
275 Gtk::CellRendererToggle* visible_cell = dynamic_cast<Gtk::CellRendererToggle*> (v->get_column_cell_renderer (0));
276 visible_cell->property_activatable() = true;
277 visible_cell->signal_toggled().connect (sigc::mem_fun (*this, &VisibilityGroup::list_view_visible_changed));
282 VisibilityGroup::list_view_visible_changed (string const & path)
284 if (_ignore_list_view_change) {
288 Gtk::TreeModel::iterator i = _model->get_iter (path);
293 vector<Member>::iterator j = (*i)[_model_columns._iterator];
294 j->visible = !j->visible;
295 (*i)[_model_columns._visible] = j->visible;