src/wx/editable_list.h

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_EDITABLE_LIST_H
  22 #define DCPOMATIC_EDITABLE_LIST_H
  23
  24 #include "wx_util.h"
  25 #include "dcpomatic_button.h"
  26 #include <wx/wx.h>
  27 #include <wx/listctrl.h>
  28 #include <boost/function.hpp>
  29 #include <vector>
  30
  31 /** @param T type of things being edited.
  32  *  @param S dialog to edit a thing.
  33  */
  34 template<class T, class S>
  35 class EditableList : public wxPanel
  36 {
  37 public:
  38         EditableList (
  39                 wxWindow* parent,
  40                 std::vector<std::string> columns,
  41                 boost::function<std::vector<T> ()> get,
  42                 boost::function<void (std::vector<T>)> set,
  43                 boost::function<std::string (T, int)> column,
  44                 bool can_edit = true,
  45                 bool title = true,
  46                 int column_width = 200
  47                 )
  48                 : wxPanel (parent)
  49                 , _get (get)
  50                 , _set (set)
  51                 , _columns (columns.size ())
  52                 , _column (column)
  53                 , _edit (0)
  54         {
  55                 _sizer = new wxBoxSizer (wxHORIZONTAL);
  56                 SetSizer (_sizer);
  57
  58                 long style = wxLC_REPORT | wxLC_SINGLE_SEL;
  59                 if (title) {
  60                         style |= wxLC_NO_HEADER;
  61                 }
  62                 _list = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxSize (columns.size() * column_width, 100), style);
  63
  64                 for (size_t i = 0; i < columns.size(); ++i) {
  65                         wxListItem ip;
  66                         ip.SetId (i);
  67                         ip.SetText (std_to_wx (columns[i]));
  68                         ip.SetWidth (column_width);
  69                         _list->InsertColumn (i, ip);
  70                 }
  71
  72                 _sizer->Add (_list, 1, wxEXPAND);
  73
  74                 {
  75                         wxSizer* s = new wxBoxSizer (wxVERTICAL);
  76                         _add = new Button (this, _("Add..."));
  77                         s->Add (_add, 0, wxTOP | wxBOTTOM, 2);
  78                         if (can_edit) {
  79                                 _edit = new Button (this, _("Edit..."));
  80                                 s->Add (_edit, 0, wxTOP | wxBOTTOM, 2);
  81                         }
  82                         _remove = new Button (this, _("Remove"));
  83                         s->Add (_remove, 0, wxTOP | wxBOTTOM, 2);
  84                         _sizer->Add (s, 0, wxLEFT, DCPOMATIC_SIZER_X_GAP);
  85                 }
  86
  87                 _add->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::add_clicked, this));
  88                 if (_edit) {
  89                         _edit->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::edit_clicked, this));
  90                 }
  91                 _remove->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::remove_clicked, this));
  92
  93                 _list->Bind (wxEVT_COMMAND_LIST_ITEM_SELECTED, boost::bind (&EditableList::selection_changed, this));
  94                 _list->Bind (wxEVT_COMMAND_LIST_ITEM_DESELECTED, boost::bind (&EditableList::selection_changed, this));
  95 #if BOOST_VERSION >= 106100
  96                 _list->Bind (wxEVT_SIZE, boost::bind (&EditableList::resized, this, boost::placeholders::_1));
  97 #else
  98                 _list->Bind (wxEVT_SIZE, boost::bind (&EditableList::resized, this, _1));
  99 #endif
 100
 101                 refresh ();
 102                 selection_changed ();
 103         }
 104
 105         void refresh ()
 106         {
 107                 _list->DeleteAllItems ();
 108
 109                 std::vector<T> current = _get ();
 110                 for (typename std::vector<T>::iterator i = current.begin (); i != current.end(); ++i) {
 111                         add_to_control (*i);
 112                 }
 113         }
 114
 115         boost::optional<T> selection () const
 116         {
 117                 int item = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 118                 if (item == -1) {
 119                         return boost::optional<T> ();
 120                 }
 121
 122                 std::vector<T> all = _get ();
 123                 DCPOMATIC_ASSERT (item >= 0 && item < int (all.size ()));
 124                 return all[item];
 125         }
 126
 127         void layout ()
 128         {
 129                 _sizer->Layout ();
 130         }
 131
 132         boost::signals2::signal<void ()> SelectionChanged;
 133
 134 private:
 135
 136         void add_to_control (T item)
 137         {
 138                 wxListItem list_item;
 139                 int const n = _list->GetItemCount ();
 140                 list_item.SetId (n);
 141                 _list->InsertItem (list_item);
 142
 143                 for (int i = 0; i < _columns; ++i) {
 144                         _list->SetItem (n, i, std_to_wx (_column (item, i)));
 145                 }
 146         }
 147
 148         void selection_changed ()
 149         {
 150                 int const i = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 151                 if (_edit) {
 152                         _edit->Enable (i >= 0);
 153                 }
 154                 _remove->Enable (i >= 0);
 155
 156                 SelectionChanged ();
 157         }
 158
 159         void add_clicked ()
 160         {
 161                 S* dialog = new S (this);
 162
 163                 if (dialog->ShowModal() == wxID_OK) {
 164                         boost::optional<T> const v = dialog->get ();
 165                         if (v) {
 166                                 add_to_control (v.get ());
 167                                 std::vector<T> all = _get ();
 168                                 all.push_back (v.get ());
 169                                 _set (all);
 170                         }
 171                 }
 172
 173                 dialog->Destroy ();
 174         }
 175
 176         void edit_clicked ()
 177         {
 178                 int item = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 179                 if (item == -1) {
 180                         return;
 181                 }
 182
 183                 std::vector<T> all = _get ();
 184                 DCPOMATIC_ASSERT (item >= 0 && item < int (all.size ()));
 185
 186                 S* dialog = new S (this);
 187                 dialog->set (all[item]);
 188                 if (dialog->ShowModal() == wxID_OK) {
 189                         boost::optional<T> const v = dialog->get ();
 190                         if (!v) {
 191                                 return;
 192                         }
 193
 194                         all[item] = v.get ();
 195                 }
 196                 dialog->Destroy ();
 197
 198                 for (int i = 0; i < _columns; ++i) {
 199                         _list->SetItem (item, i, std_to_wx (_column (all[item], i)));
 200                 }
 201
 202                 _set (all);
 203         }
 204
 205         void remove_clicked ()
 206         {
 207                 int i = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 208                 if (i == -1) {
 209                         return;
 210                 }
 211
 212                 _list->DeleteItem (i);
 213                 std::vector<T> all = _get ();
 214                 all.erase (all.begin() + i);
 215                 _set (all);
 216
 217                 selection_changed ();
 218         }
 219
 220         void resized (wxSizeEvent& ev)
 221         {
 222                 int const w = GetSize().GetWidth() / _columns;
 223                 for (int i = 0; i < _columns; ++i) {
 224                         _list->SetColumnWidth (i, w);
 225                 }
 226                 ev.Skip ();
 227         }
 228
 229         boost::function <std::vector<T> ()> _get;
 230         boost::function <void (std::vector<T>)> _set;
 231         int _columns;
 232         boost::function<std::string (T, int)> _column;
 233
 234         wxButton* _add;
 235         wxButton* _edit;
 236         wxButton* _remove;
 237         wxListCtrl* _list;
 238         wxBoxSizer* _sizer;
 239 };
 240
 241 #endif