2 Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 /** @file src/wx/content_widget.h
22 * @brief ContentWidget class.
26 #ifndef DCPOMATIC_CONTENT_WIDGET_H
27 #define DCPOMATIC_CONTENT_WIDGET_H
31 #include "lib/content.h"
32 #include <wx/gbsizer.h>
33 #include <wx/spinctrl.h>
38 /** @class ContentWidget
39 * @brief A widget which represents some Content state and which can be used
40 * when multiple pieces of content are selected.
42 * @param S Type of ContentPart being manipulated (e.g. VideoContent)
43 * @param T Type of the widget (e.g. wxSpinCtrl)
44 * @param U Data type of state as used by the model.
45 * @param V Data type of state as used by the view.
47 template <class S, class T, typename U, typename V>
51 /** @param parent Parent window.
52 * @param wrapped Control widget that we are wrapping.
53 * @param property ContentProperty that the widget is handling.
54 * @param part Part of Content that the property is in (e.g. &Content::video)
55 * @param model_getter Function on the Content to get the value.
56 * @param model_setter Function on the Content to set the value.
57 * @param view_changed Function called when the view has changed; useful for linking controls.
58 * @param view_to_model Function to convert a view value to a model value.
59 * @param model_to_view Function to convert a model value to a view value.
65 std::function<std::shared_ptr<S> (Content*)> part,
66 std::function<U (S*)> model_getter,
67 std::function<void (S*, U)> model_setter,
68 std::function<void ()> view_changed,
69 std::function<U (V)> view_to_model,
70 std::function<V (U)> model_to_view
74 , _button (new wxButton (parent, wxID_ANY, _("Multiple values")))
75 , _property (property)
77 , _model_getter (model_getter)
78 , _model_setter (model_setter)
79 , _view_changed (view_changed)
80 , _view_to_model (view_to_model)
81 , _model_to_view (model_to_view)
82 , _ignore_model_changes (false)
84 _button->SetToolTip (_("Click the button to set all selected content to the same value."));
86 _button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentWidget::button_clicked, this));
89 ContentWidget (ContentWidget const&) = delete;
90 ContentWidget& operator= (ContentWidget const&) = delete;
92 /** @return the widget that we are wrapping */
98 typedef std::vector<std::shared_ptr<Content> > List;
100 /** Set the content that this control is working on (i.e. the selected content) */
101 void set_content (List content)
103 for (typename std::list<boost::signals2::connection>::iterator i = _connections.begin(); i != _connections.end(); ++i) {
107 _connections.clear ();
111 _wrapped->Enable (!_content.empty ());
113 update_from_model ();
115 for (typename List::iterator i = _content.begin(); i != _content.end(); ++i) {
116 #if BOOST_VERSION >= 106100
117 _connections.push_back ((*i)->Change.connect (boost::bind (&ContentWidget::model_changed, this, boost::placeholders::_1, boost::placeholders::_3)));
119 _connections.push_back ((*i)->Change.connect (boost::bind (&ContentWidget::model_changed, this, _1, _3)));
124 /** Add this widget to a wxGridBagSizer */
125 void add (wxGridBagSizer* sizer, wxGBPosition position, wxGBSpan span = wxDefaultSpan, int flag = 0)
128 _position = position;
130 _sizer->Add (_wrapped, _position, _span, flag);
133 /** Update the view from the model */
134 void update_from_model ()
136 if (_content.empty ()) {
141 typename List::iterator i = _content.begin ();
142 U const v = boost::bind (_model_getter, _part(_content.front().get()).get())();
143 while (i != _content.end() && boost::bind (_model_getter, _part(i->get()).get())() == v) {
147 if (i == _content.end ()) {
149 checked_set (_wrapped, _model_to_view (v));
157 _ignore_model_changes = true;
158 for (size_t i = 0; i < _content.size(); ++i) {
159 boost::bind (_model_setter, _part (_content[i].get()).get(), _view_to_model (wx_get (_wrapped))) ();
164 _ignore_model_changes = false;
176 if (_wrapped->IsShown() || !_sizer) {
180 _sizer->Detach (_button);
182 _sizer->Add (_wrapped, _position, _span);
189 if (_button->IsShown() || !_sizer) {
194 _sizer->Detach (_wrapped);
196 _sizer->Add (_button, _position, _span);
200 void button_clicked ()
202 U const v = boost::bind (_model_getter, _part(_content.front().get()).get())();
203 for (auto const& i: _content) {
204 boost::bind (_model_setter, _part(i.get()).get(), v)();
208 void model_changed (ChangeType type, int property)
210 if (type == ChangeType::DONE && property == _property && !_ignore_model_changes) {
211 update_from_model ();
216 wxGridBagSizer* _sizer;
217 wxGBPosition _position;
222 std::function<std::shared_ptr<S> (Content *)> _part;
223 std::function<U (S*)> _model_getter;
224 std::function<void (S*, U)> _model_setter;
225 std::function<void ()> _view_changed;
226 std::function<U (V)> _view_to_model;
227 std::function<V (U)> _model_to_view;
228 std::list<boost::signals2::connection> _connections;
229 bool _ignore_model_changes;
232 template <typename U, typename V>
235 return static_cast<V> (x);
239 class ContentSpinCtrl : public ContentWidget<S, wxSpinCtrl, int, int>
246 std::function<std::shared_ptr<S> (Content *)> part,
247 std::function<int (S*)> getter,
248 std::function<void (S*, int)> setter,
249 std::function<void ()> view_changed = std::function<void ()>()
251 : ContentWidget<S, wxSpinCtrl, int, int> (
262 wrapped->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&ContentWidget<S, wxSpinCtrl, int, int>::view_changed, this));
267 class ContentSpinCtrlDouble : public ContentWidget<S, wxSpinCtrlDouble, double, double>
270 ContentSpinCtrlDouble (
272 wxSpinCtrlDouble* wrapped,
274 std::function<std::shared_ptr<S> (Content *)> part,
275 std::function<double (S*)> getter,
276 std::function<void (S*, double)> setter,
277 std::function<void ()> view_changed = std::function<void ()>()
279 : ContentWidget<S, wxSpinCtrlDouble, double, double> (
286 &caster<double, double>,
287 &caster<double, double>
290 wrapped->Bind (wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, boost::bind (&ContentWidget<S, wxSpinCtrlDouble, double, double>::view_changed, this));
294 template <class S, class U>
295 class ContentChoice : public ContentWidget<S, wxChoice, U, int>
302 std::function<std::shared_ptr<S> (Content *)> part,
303 std::function<U (S*)> getter,
304 std::function<void (S*, U)> setter,
305 std::function<U (int)> view_to_model,
306 std::function<int (U)> model_to_view,
307 std::function<void ()> view_changed = std::function<void()>()
309 : ContentWidget<S, wxChoice, U, int> (
321 wrapped->Bind (wxEVT_COMMAND_CHOICE_SELECTED, boost::bind (&ContentWidget<S, wxChoice, U, int>::view_changed, this));