/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of DCP-o-matic.
+
+ DCP-o-matic is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
- This program is distributed in the hope that it will be useful,
+ DCP-o-matic is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
*/
+
+#ifndef DCPOMATIC_EDITABLE_LIST_H
+#define DCPOMATIC_EDITABLE_LIST_H
+
+
+#include "dcpomatic_button.h"
+#include "wx_util.h"
+#include <dcp/warnings.h>
+LIBDCP_DISABLE_WARNINGS
+#include <wx/listctrl.h>
#include <wx/wx.h>
+LIBDCP_ENABLE_WARNINGS
+#include <vector>
+
+
+class EditableListColumn
+{
+public:
+ EditableListColumn (wxString name_)
+ : name (name_)
+ , growable (false)
+ {}
+
+ EditableListColumn (wxString name_, boost::optional<int> width_, bool growable_)
+ : name (name_)
+ , width (width_)
+ , growable (growable_)
+ {}
+
+ wxString name;
+ boost::optional<int> width;
+ bool growable;
+};
+
+
+namespace EditableListButton
+{
+ static int constexpr NEW = 0x1;
+ static int constexpr EDIT = 0x2;
+ static int constexpr REMOVE = 0x4;
+};
+
+enum class EditableListTitle
+{
+ VISIBLE,
+ INVISIBLE
+};
+
+
+/** @param T type of things being edited.
+ * @param S dialog to edit a thing.
+ * @param get Function to get a std::vector of the things being edited.
+ * @param set Function set the things from a a std::vector.
+ * @param column Function to get the display string for a given column in a given item.
+ */
template<class T, class S>
class EditableList : public wxPanel
{
public:
EditableList (
wxWindow* parent,
- std::vector<std::string> columns,
- boost::function<std::vector<T> ()> get,
- boost::function<void (std::vector<T>)> set,
- boost::function<std::string (T, int)> column
+ std::vector<EditableListColumn> columns,
+ std::function<std::vector<T> ()> get,
+ std::function<void (std::vector<T>)> set,
+ std::function<std::string (T, int)> column,
+ EditableListTitle title,
+ int buttons
)
: wxPanel (parent)
, _get (get)
, _set (set)
- , _columns (columns.size ())
+ , _columns (columns)
, _column (column)
+ , _default_width (200)
{
- wxBoxSizer* s = new wxBoxSizer (wxVERTICAL);
- SetSizer (s);
+ _sizer = new wxBoxSizer (wxHORIZONTAL);
+ SetSizer (_sizer);
+
+ long style = wxLC_REPORT | wxLC_SINGLE_SEL;
+ if (title == EditableListTitle::INVISIBLE) {
+ style |= wxLC_NO_HEADER;
+ }
- wxFlexGridSizer* table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
- table->AddGrowableCol (0, 1);
- s->Add (table, 1, wxALL | wxEXPAND, 8);
+ int total_width = 0;
+ for (auto i: _columns) {
+ total_width += i.width.get_value_or (_default_width);
+ }
- _list = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxSize (columns.size() * 200, 100), wxLC_REPORT | wxLC_SINGLE_SEL);
+#ifdef __WXGTK3__
+ /* With the GTK3 backend wxListCtrls are hard to pick out from the background of the
+ * window, so put a border in to help.
+ */
+ auto border = new wxPanel (this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL | wxBORDER_THEME);
+ _list = new wxListCtrl (border, wxID_ANY, wxDefaultPosition, wxSize(total_width, 100), style);
+ auto border_sizer = new wxBoxSizer (wxHORIZONTAL);
+ border_sizer->Add (_list, 1, wxALL | wxEXPAND, 2);
+ border->SetSizer (border_sizer);
+#else
+ _list = new wxListCtrl (this, wxID_ANY, wxDefaultPosition, wxSize(total_width, 100), style);
+#endif
- for (size_t i = 0; i < columns.size(); ++i) {
+ int j = 0;
+ for (auto i: _columns) {
wxListItem ip;
- ip.SetId (i);
- ip.SetText (std_to_wx (columns[i]));
- ip.SetWidth (200);
- _list->InsertColumn (i, ip);
+ ip.SetId (j);
+ ip.SetText (i.name);
+ _list->InsertColumn (j, ip);
+ ++j;
}
- table->Add (_list, 1, wxEXPAND | wxALL);
+#ifdef __WXGTK3__
+ _sizer->Add (border, 1, wxEXPAND);
+#else
+ _sizer->Add (_list, 1, wxEXPAND);
+#endif
{
- wxSizer* s = new wxBoxSizer (wxVERTICAL);
- _add = new wxButton (this, wxID_ANY, _("Add..."));
- s->Add (_add, 0, wxTOP | wxBOTTOM, 2);
- _edit = new wxButton (this, wxID_ANY, _("Edit..."));
- s->Add (_edit, 0, wxTOP | wxBOTTOM, 2);
- _remove = new wxButton (this, wxID_ANY, _("Remove"));
- s->Add (_remove, 0, wxTOP | wxBOTTOM, 2);
- table->Add (s, 0);
+ auto s = new wxBoxSizer (wxVERTICAL);
+ if (buttons & EditableListButton::NEW) {
+ _add = new Button (this, _("Add..."));
+ s->Add (_add, 1, wxEXPAND | wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
+ }
+ if (buttons & EditableListButton::EDIT) {
+ _edit = new Button (this, _("Edit..."));
+ s->Add (_edit, 1, wxEXPAND | wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
+ }
+ if (buttons & EditableListButton::REMOVE) {
+ _remove = new Button (this, _("Remove"));
+ s->Add (_remove, 1, wxEXPAND | wxTOP | wxBOTTOM, DCPOMATIC_BUTTON_STACK_GAP);
+ }
+ _sizer->Add (s, 0, wxLEFT, DCPOMATIC_SIZER_X_GAP);
}
- std::vector<T> current = _get ();
- for (typename std::vector<T>::iterator i = current.begin (); i != current.end(); ++i) {
- add_to_control (*i);
+ if (_add) {
+ _add->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::add_clicked, this));
+ }
+ if (_edit) {
+ _edit->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::edit_clicked, this));
+ }
+ if (_remove) {
+ _remove->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::remove_clicked, this));
}
-
- _add->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::add_clicked, this));
- _edit->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::edit_clicked, this));
- _remove->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&EditableList::remove_clicked, this));
_list->Bind (wxEVT_COMMAND_LIST_ITEM_SELECTED, boost::bind (&EditableList::selection_changed, this));
_list->Bind (wxEVT_COMMAND_LIST_ITEM_DESELECTED, boost::bind (&EditableList::selection_changed, this));
+#if BOOST_VERSION >= 106100
+ _list->Bind (wxEVT_SIZE, boost::bind (&EditableList::resized, this, boost::placeholders::_1));
+#else
_list->Bind (wxEVT_SIZE, boost::bind (&EditableList::resized, this, _1));
+#endif
+
+ refresh ();
selection_changed ();
+ }
+
+ void refresh ()
+ {
+ _list->DeleteAllItems ();
+ auto current = _get ();
+ for (auto const& i: current) {
+ add_to_control (i);
+ }
}
-private:
+ boost::optional<T> selection () const
+ {
+ int item = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
+ if (item == -1) {
+ return {};
+ }
+
+ auto all = _get ();
+ DCPOMATIC_ASSERT (item >= 0 && item < int (all.size ()));
+ return all[item];
+ }
+
+ void layout ()
+ {
+ _sizer->Layout ();
+ }
+
+ boost::signals2::signal<void ()> SelectionChanged;
+
+private:
void add_to_control (T item)
{
list_item.SetId (n);
_list->InsertItem (list_item);
- for (int i = 0; i < _columns; ++i) {
+ for (size_t i = 0; i < _columns.size(); ++i) {
_list->SetItem (n, i, std_to_wx (_column (item, i)));
}
}
void selection_changed ()
{
int const i = _list->GetNextItem (-1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED);
- _edit->Enable (i >= 0);
- _remove->Enable (i >= 0);
+ if (_edit) {
+ _edit->Enable (i >= 0);
+ }
+ if (_remove) {
+ _remove->Enable (i >= 0);
+ }
+
+ SelectionChanged ();
}
void add_clicked ()
{
- T new_item;
S* dialog = new S (this);
- dialog->set (new_item);
- dialog->ShowModal ();
- add_to_control (dialog->get ());
-
- std::vector<T> all = _get ();
- all.push_back (dialog->get ());
- _set (all);
-
+ if (dialog->ShowModal() == wxID_OK) {
+ auto const v = dialog->get ();
+ static_assert(std::is_same<typename std::remove_const<decltype(v)>::type, boost::optional<T>>::value, "get() must return boost::optional<T>");
+ if (v) {
+ add_to_control (v.get ());
+ auto all = _get ();
+ all.push_back (v.get ());
+ _set (all);
+ }
+ }
+
dialog->Destroy ();
}
}
std::vector<T> all = _get ();
- assert (item >= 0 && item < int (all.size ()));
+ DCPOMATIC_ASSERT (item >= 0 && item < int (all.size ()));
S* dialog = new S (this);
dialog->set (all[item]);
- dialog->ShowModal ();
- all[item] = dialog->get ();
+ if (dialog->ShowModal() == wxID_OK) {
+ auto const v = dialog->get ();
+ static_assert(std::is_same<typename std::remove_const<decltype(v)>::type, boost::optional<T>>::value, "get() must return boost::optional<T>");
+ if (!v) {
+ return;
+ }
+
+ all[item] = v.get ();
+ }
dialog->Destroy ();
-
- for (int i = 0; i < _columns; ++i) {
+
+ for (size_t i = 0; i < _columns.size(); ++i) {
_list->SetItem (item, i, std_to_wx (_column (all[item], i)));
}
if (i == -1) {
return;
}
-
+
_list->DeleteItem (i);
- std::vector<T> all = _get ();
+ auto all = _get ();
all.erase (all.begin() + i);
_set (all);
void resized (wxSizeEvent& ev)
{
- int const w = GetSize().GetWidth() / _columns;
- for (int i = 0; i < _columns; ++i) {
- _list->SetColumnWidth (i, w);
+ int const w = _list->GetSize().GetWidth() - 2;
+
+ int fixed_width = 0;
+ int growable = 0;
+ int j = 0;
+ for (auto i: _columns) {
+ fixed_width += i.width.get_value_or (_default_width);
+ if (!i.growable) {
+ _list->SetColumnWidth (j, i.width.get_value_or(_default_width));
+ } else {
+ ++growable;
+ }
+ ++j;
}
+
+ j = 0;
+ for (auto i: _columns) {
+ if (i.growable) {
+ _list->SetColumnWidth (j, i.width.get_value_or(_default_width) + (w - fixed_width) / growable);
+ }
+ ++j;
+ }
+
ev.Skip ();
}
- boost::function <std::vector<T> ()> _get;
- boost::function <void (std::vector<T>)> _set;
- int _columns;
- boost::function<std::string (T, int)> _column;
+ std::function <std::vector<T> ()> _get;
+ std::function <void (std::vector<T>)> _set;
+ std::vector<EditableListColumn> _columns;
+ std::function<std::string (T, int)> _column;
- wxButton* _add;
- wxButton* _edit;
- wxButton* _remove;
+ wxButton* _add = nullptr;
+ wxButton* _edit = nullptr;
+ wxButton* _remove = nullptr;
wxListCtrl* _list;
+ wxBoxSizer* _sizer;
+ int _default_width;
};
+
+#endif