src/wx/editable_list.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   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 DCPOMATIC_EDITABLE_LIST_H
  21 #define DCPOMATIC_EDITABLE_LIST_H
  22
  23 #include "wx_util.h"
  24 #include <wx/wx.h>
  25 #include <wx/listctrl.h>
  26 #include <boost/function.hpp>
  27 #include <vector>
  28
  29 /** @param T type of things being edited.
  30  *  @param S dialog to edit a thing.
  31  */
  32 template<class T, class S>
  33 class EditableList : public wxPanel
  34 {
  35 public:
  36         EditableList (
  37                 wxWindow* parent,
  38                 std::vector<std::string> columns,
  39                 boost::function<std::vector<T> ()> get,
  40                 boost::function<void (std::vector<T>)> set,
  41                 boost::function<std::string (T, int)> column,
  42                 bool can_edit = true,
  43                 bool title = true
  44                 )
  45                 : wxPanel (parent)
  46                 , _get (get)
  47                 , _set (set)
  48                 , _columns (columns.size ())
  49                 , _column (column)
  50                 , _edit (0)
  51         {
  52                 wxBoxSizer* s = new wxBoxSizer (wxVERTICAL);
  53                 SetSizer (s);
  54
  55                 _table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
  56                 _table->AddGrowableCol (0, 1);
  57                 s->Add (_table, 1, wxEXPAND);
  58
  59                 long style = wxLC_REPORT | wxLC_SINGLE_SEL;
  60                 if (title) {
  61                         style |= wxLC_NO_HEADER;
  62                 }
  63                 _list = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxSize (columns.size() * 200, 100), style);
  64
  65                 for (size_t i = 0; i < columns.size(); ++i) {
  66                         wxListItem ip;
  67                         ip.SetId (i);
  68                         ip.SetText (std_to_wx (columns[i]));
  69                         ip.SetWidth (200);
  70                         _list->InsertColumn (i, ip);
  71                 }
  72
  73                 _table->Add (_list, 1, wxEXPAND | wxALL);
  74
  75                 {
  76                         wxSizer* s = new wxBoxSizer (wxVERTICAL);
  77                         _add = new wxButton (this, wxID_ANY, _("Add..."));
  78                         s->Add (_add, 0, wxTOP | wxBOTTOM, 2);
  79                         if (can_edit) {
  80                                 _edit = new wxButton (this, wxID_ANY, _("Edit..."));
  81                                 s->Add (_edit, 0, wxTOP | wxBOTTOM, 2);
  82                         }
  83                         _remove = new wxButton (this, wxID_ANY, _("Remove"));
  84                         s->Add (_remove, 0, wxTOP | wxBOTTOM, 2);
  85                         _table->Add (s, 0);
  86                 }
  87
  88                 _add->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::add_clicked, this));
  89                 if (_edit) {
  90                         _edit->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::edit_clicked, this));
  91                 }
  92                 _remove->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::remove_clicked, this));
  93
  94                 _list->Bind (wxEVT_COMMAND_LIST_ITEM_SELECTED, boost::bind (&EditableList::selection_changed, this));
  95                 _list->Bind (wxEVT_COMMAND_LIST_ITEM_DESELECTED, boost::bind (&EditableList::selection_changed, this));
  96                 _list->Bind (wxEVT_SIZE, boost::bind (&EditableList::resized, this, _1));
  97
  98                 refresh ();
  99                 selection_changed ();
 100         }
 101
 102         void refresh ()
 103         {
 104                 _list->DeleteAllItems ();
 105
 106                 std::vector<T> current = _get ();
 107                 for (typename std::vector<T>::iterator i = current.begin (); i != current.end(); ++i) {
 108                         add_to_control (*i);
 109                 }
 110         }
 111
 112         boost::optional<T> selection () const
 113         {
 114                 int item = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 115                 if (item == -1) {
 116                         return boost::optional<T> ();
 117                 }
 118
 119                 std::vector<T> all = _get ();
 120                 DCPOMATIC_ASSERT (item >= 0 && item < int (all.size ()));
 121                 return all[item];
 122         }
 123
 124         void layout ()
 125         {
 126                 _table->Layout ();
 127         }
 128
 129         boost::signals2::signal<void ()> SelectionChanged;
 130
 131 private:
 132
 133         void add_to_control (T item)
 134         {
 135                 wxListItem list_item;
 136                 int const n = _list->GetItemCount ();
 137                 list_item.SetId (n);
 138                 _list->InsertItem (list_item);
 139
 140                 for (int i = 0; i < _columns; ++i) {
 141                         _list->SetItem (n, i, std_to_wx (_column (item, i)));
 142                 }
 143         }
 144
 145         void selection_changed ()
 146         {
 147                 int const i = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 148                 if (_edit) {
 149                         _edit->Enable (i >= 0);
 150                 }
 151                 _remove->Enable (i >= 0);
 152
 153                 SelectionChanged ();
 154         }
 155
 156         void add_clicked ()
 157         {
 158                 S* dialog = new S (this);
 159
 160                 if (dialog->ShowModal() == wxID_OK) {
 161                         add_to_control (dialog->get ());
 162                         std::vector<T> all = _get ();
 163                         all.push_back (dialog->get ());
 164                         _set (all);
 165                 }
 166
 167                 dialog->Destroy ();
 168         }
 169
 170         void edit_clicked ()
 171         {
 172                 int item = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 173                 if (item == -1) {
 174                         return;
 175                 }
 176
 177                 std::vector<T> all = _get ();
 178                 DCPOMATIC_ASSERT (item >= 0 && item < int (all.size ()));
 179
 180                 S* dialog = new S (this);
 181                 dialog->set (all[item]);
 182                 if (dialog->ShowModal() == wxID_OK) {
 183                         all[item] = dialog->get ();
 184                 }
 185                 dialog->Destroy ();
 186
 187                 for (int i = 0; i < _columns; ++i) {
 188                         _list->SetItem (item, i, std_to_wx (_column (all[item], i)));
 189                 }
 190
 191                 _set (all);
 192         }
 193
 194         void remove_clicked ()
 195         {
 196                 int i = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 197                 if (i == -1) {
 198                         return;
 199                 }
 200
 201                 _list->DeleteItem (i);
 202                 std::vector<T> all = _get ();
 203                 all.erase (all.begin() + i);
 204                 _set (all);
 205
 206                 selection_changed ();
 207         }
 208
 209         void resized (wxSizeEvent& ev)
 210         {
 211                 int const w = GetSize().GetWidth() / _columns;
 212                 for (int i = 0; i < _columns; ++i) {
 213                         _list->SetColumnWidth (i, w);
 214                 }
 215                 ev.Skip ();
 216         }
 217
 218         boost::function <std::vector<T> ()> _get;
 219         boost::function <void (std::vector<T>)> _set;
 220         int _columns;
 221         boost::function<std::string (T, int)> _column;
 222
 223         wxButton* _add;
 224         wxButton* _edit;
 225         wxButton* _remove;
 226         wxListCtrl* _list;
 227         wxFlexGridSizer* _table;
 228 };
 229
 230 #endif