gtk2_ardour/visibility_group.h

   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 #ifndef __ardour_visibility_group__
  22 #define __ardour_visibility_group__
  23
  24 #include <gtkmm/liststore.h>
  25 #include "pbd/signals.h"
  26
  27 class XMLNode;
  28 class XMLProperty;
  29
  30 /** A class to manage a group of widgets where the visibility of each
  31  *  can be configured by the user.  The class can generate a menu to
  32  *  set up visibility, and save and restore visibility state to XML.
  33  */
  34
  35 class VisibilityGroup
  36 {
  37 public:
  38         VisibilityGroup (std::string const &);
  39
  40         void add (
  41                 Gtk::Widget *,
  42                 std::string const &,
  43                 std::string const &,
  44                 bool visible = false,
  45                 boost::function<boost::optional<bool> ()> = 0
  46                 );
  47
  48         Gtk::Menu* menu ();
  49         Gtk::Widget* list_view ();
  50         bool button_press_event (GdkEventButton *);
  51         void update ();
  52         void set_state (XMLNode const &);
  53         void set_state (std::string);
  54         std::string get_state_name () const;
  55         std::string get_state_value () const;
  56
  57         PBD::Signal0<void> VisibilityChanged;
  58
  59         static std::string remove_element (std::string const& from, std::string const& element);
  60         static std::string add_element (std::string const& from, std::string const& element);
  61
  62 private:
  63
  64         struct Member {
  65                 Gtk::Widget* widget;
  66                 std::string  id;
  67                 std::string  name;
  68                 bool         visible;
  69                 boost::function<boost::optional<bool> ()> override;
  70         };
  71
  72         class ModelColumns : public Gtk::TreeModelColumnRecord {
  73         public:
  74                 ModelColumns () {
  75                         add (_visible);
  76                         add (_name);
  77                         add (_iterator);
  78                 }
  79
  80                 Gtk::TreeModelColumn<bool> _visible;
  81                 Gtk::TreeModelColumn<std::string> _name;
  82                 Gtk::TreeModelColumn<std::vector<Member>::iterator> _iterator;
  83         };
  84
  85         void toggle (std::vector<Member>::iterator);
  86         void list_view_visible_changed (std::string const &);
  87         void update_list_view ();
  88         bool should_actually_be_visible (Member const &) const;
  89
  90         std::vector<Member> _members;
  91         std::string _xml_property_name;
  92         ModelColumns _model_columns;
  93         Glib::RefPtr<Gtk::ListStore> _model;
  94         bool _ignore_list_view_change;
  95 };
  96
  97 #endif