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 class EditableListColumn
  32 {
  33 public:
  34         EditableListColumn (std::string name_)
  35                 : name (name_)
  36                 , growable (false)
  37         {}
  38
  39         EditableListColumn (std::string name_, boost::optional<int> width_, bool growable_)
  40                 : name (name_)
  41                 , width (width_)
  42                 , growable (growable_)
  43         {}
  44
  45         std::string name;
  46         boost::optional<int> width;
  47         bool growable;
  48 };
  49
  50 /** @param T type of things being edited.
  51  *  @param S dialog to edit a thing.
  52  *  @param get Function to get a std::vector of the things being edited.
  53  *  @param set Function set the things from a a std::vector.
  54  *  @param column Function to get the display string for a given column in a given item.
  55  */
  56 template<class T, class S>
  57 class EditableList : public wxPanel
  58 {
  59 public:
  60         EditableList (
  61                 wxWindow* parent,
  62                 std::vector<EditableListColumn> columns,
  63                 boost::function<std::vector<T> ()> get,
  64                 boost::function<void (std::vector<T>)> set,
  65                 boost::function<std::string (T, int)> column,
  66                 bool can_edit = true,
  67                 bool title = true
  68                 )
  69                 : wxPanel (parent)
  70                 , _get (get)
  71                 , _set (set)
  72                 , _columns (columns)
  73                 , _column (column)
  74                 , _edit (0)
  75                 , _default_width (200)
  76         {
  77                 _sizer = new wxBoxSizer (wxHORIZONTAL);
  78                 SetSizer (_sizer);
  79
  80                 long style = wxLC_REPORT | wxLC_SINGLE_SEL;
  81                 if (title) {
  82                         style |= wxLC_NO_HEADER;
  83                 }
  84
  85                 int total_width = 0;
  86                 BOOST_FOREACH (EditableListColumn i, _columns) {
  87                         total_width += i.width.get_value_or (_default_width);
  88                 }
  89
  90                 _list = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxSize(total_width, 100), style);
  91
  92                 int j = 0;
  93                 BOOST_FOREACH (EditableListColumn i, _columns) {
  94                         wxListItem ip;
  95                         ip.SetId (j);
  96                         ip.SetText (std_to_wx(i.name));
  97                         _list->InsertColumn (j, ip);
  98                         ++j;
  99                 }
 100
 101                 _sizer->Add (_list, 1, wxEXPAND);
 102
 103                 {
 104                         wxSizer* s = new wxBoxSizer (wxVERTICAL);
 105                         _add = new Button (this, _("Add..."));
 106                         s->Add (_add, 0, wxTOP | wxBOTTOM, 2);
 107                         if (can_edit) {
 108                                 _edit = new Button (this, _("Edit..."));
 109                                 s->Add (_edit, 0, wxTOP | wxBOTTOM, 2);
 110                         }
 111                         _remove = new Button (this, _("Remove"));
 112                         s->Add (_remove, 0, wxTOP | wxBOTTOM, 2);
 113                         _sizer->Add (s, 0, wxLEFT, DCPOMATIC_SIZER_X_GAP);
 114                 }
 115
 116                 _add->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::add_clicked, this));
 117                 if (_edit) {
 118                         _edit->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::edit_clicked, this));
 119                 }
 120                 _remove->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::remove_clicked, this));
 121
 122                 _list->Bind (wxEVT_COMMAND_LIST_ITEM_SELECTED, boost::bind (&EditableList::selection_changed, this));
 123                 _list->Bind (wxEVT_COMMAND_LIST_ITEM_DESELECTED, boost::bind (&EditableList::selection_changed, this));
 124                 _list->Bind (wxEVT_SIZE, boost::bind (&EditableList::resized, this, _1));
 125
 126                 refresh ();
 127                 selection_changed ();
 128         }
 129
 130         void refresh ()
 131         {
 132                 _list->DeleteAllItems ();
 133
 134                 std::vector<T> current = _get ();
 135                 for (typename std::vector<T>::iterator i = current.begin (); i != current.end(); ++i) {
 136                         add_to_control (*i);
 137                 }
 138         }
 139
 140         boost::optional<T> selection () const
 141         {
 142                 int item = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 143                 if (item == -1) {
 144                         return boost::optional<T> ();
 145                 }
 146
 147                 std::vector<T> all = _get ();
 148                 DCPOMATIC_ASSERT (item >= 0 && item < int (all.size ()));
 149                 return all[item];
 150         }
 151
 152         void layout ()
 153         {
 154                 _sizer->Layout ();
 155         }
 156
 157         boost::signals2::signal<void ()> SelectionChanged;
 158
 159 private:
 160
 161         void add_to_control (T item)
 162         {
 163                 wxListItem list_item;
 164                 int const n = _list->GetItemCount ();
 165                 list_item.SetId (n);
 166                 _list->InsertItem (list_item);
 167
 168                 for (size_t i = 0; i < _columns.size(); ++i) {
 169                         _list->SetItem (n, i, std_to_wx (_column (item, i)));
 170                 }
 171         }
 172
 173         void selection_changed ()
 174         {
 175                 int const i = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 176                 if (_edit) {
 177                         _edit->Enable (i >= 0);
 178                 }
 179                 _remove->Enable (i >= 0);
 180
 181                 SelectionChanged ();
 182         }
 183
 184         void add_clicked ()
 185         {
 186                 S* dialog = new S (this);
 187
 188                 if (dialog->ShowModal() == wxID_OK) {
 189                         boost::optional<T> const v = dialog->get ();
 190                         if (v) {
 191                                 add_to_control (v.get ());
 192                                 std::vector<T> all = _get ();
 193                                 all.push_back (v.get ());
 194                                 _set (all);
 195                         }
 196                 }
 197
 198                 dialog->Destroy ();
 199         }
 200
 201         void edit_clicked ()
 202         {
 203                 int item = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 204                 if (item == -1) {
 205                         return;
 206                 }
 207
 208                 std::vector<T> all = _get ();
 209                 DCPOMATIC_ASSERT (item >= 0 && item < int (all.size ()));
 210
 211                 S* dialog = new S (this);
 212                 dialog->set (all[item]);
 213                 if (dialog->ShowModal() == wxID_OK) {
 214                         boost::optional<T> const v = dialog->get ();
 215                         if (!v) {
 216                                 return;
 217                         }
 218
 219                         all[item] = v.get ();
 220                 }
 221                 dialog->Destroy ();
 222
 223                 for (size_t i = 0; i < _columns.size(); ++i) {
 224                         _list->SetItem (item, i, std_to_wx (_column (all[item], i)));
 225                 }
 226
 227                 _set (all);
 228         }
 229
 230         void remove_clicked ()
 231         {
 232                 int i = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
 233                 if (i == -1) {
 234                         return;
 235                 }
 236
 237                 _list->DeleteItem (i);
 238                 std::vector<T> all = _get ();
 239                 all.erase (all.begin() + i);
 240                 _set (all);
 241
 242                 selection_changed ();
 243         }
 244
 245         void resized (wxSizeEvent& ev)
 246         {
 247                 int const w = _list->GetSize().GetWidth() - 2;
 248
 249                 int fixed_width = 0;
 250                 int growable = 0;
 251                 int j = 0;
 252                 BOOST_FOREACH (EditableListColumn i, _columns) {
 253                         fixed_width += i.width.get_value_or (_default_width);
 254                         if (!i.growable) {
 255                                 _list->SetColumnWidth (j, i.width.get_value_or(_default_width));
 256                         } else {
 257                                 ++growable;
 258                         }
 259                         ++j;
 260                 }
 261
 262                 j = 0;
 263                 BOOST_FOREACH (EditableListColumn i, _columns) {
 264                         if (i.growable) {
 265                                 _list->SetColumnWidth (j, i.width.get_value_or(_default_width) + (w - fixed_width) / growable);
 266                         }
 267                         ++j;
 268                 }
 269
 270                 ev.Skip ();
 271         }
 272
 273         boost::function <std::vector<T> ()> _get;
 274         boost::function <void (std::vector<T>)> _set;
 275         std::vector<EditableListColumn> _columns;
 276         boost::function<std::string (T, int)> _column;
 277
 278         wxButton* _add;
 279         wxButton* _edit;
 280         wxButton* _remove;
 281         wxListCtrl* _list;
 282         wxBoxSizer* _sizer;
 283         int _default_width;
 284 };
 285
 286 #endif