src/wx/content_widget.h

   1 /*
   2     Copyright (C) 2013-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 /** @file  src/wx/content_widget.h
  22  *  @brief ContentWidget class.
  23  */
  24
  25 #ifndef DCPOMATIC_CONTENT_WIDGET_H
  26 #define DCPOMATIC_CONTENT_WIDGET_H
  27
  28 #include "wx_util.h"
  29 #include "lib/content.h"
  30 #include <wx/wx.h>
  31 #include <wx/gbsizer.h>
  32 #include <wx/spinctrl.h>
  33 #include <boost/function.hpp>
  34 #include <vector>
  35
  36 /** @class ContentWidget
  37  *  @brief A widget which represents some Content state and which can be used
  38  *  when multiple pieces of content are selected.
  39  *
  40  *  @param S Type of ContentPart being manipulated (e.g. VideoContent)
  41  *  @param T Type of the widget (e.g. wxSpinCtrl)
  42  *  @param U Data type of state as used by the model.
  43  *  @param V Data type of state as used by the view.
  44  */
  45 template <class S, class T, typename U, typename V>
  46 class ContentWidget : public boost::noncopyable
  47 {
  48 public:
  49         /** @param parent Parent window.
  50          *  @param wrapped Control widget that we are wrapping.
  51          *  @param property ContentProperty that the widget is handling.
  52          *  @param part Part of Content that the property is in (e.g. &Content::video)
  53          *  @param model_getter Function on the Content to get the value.
  54          *  @param model_setter Function on the Content to set the value.
  55          *  @param view_to_model Function to convert a view value to a model value.
  56          *  @param model_to_view Function to convert a model value to a view value.
  57          */
  58         ContentWidget (
  59                 wxWindow* parent,
  60                 T* wrapped,
  61                 int property,
  62                 boost::function<boost::shared_ptr<S> (Content*)> part,
  63                 boost::function<U (S*)> model_getter,
  64                 boost::function<void (S*, U)> model_setter,
  65                 boost::function<U (V)> view_to_model,
  66                 boost::function<V (U)> model_to_view
  67                 )
  68                 : _wrapped (wrapped)
  69                 , _sizer (0)
  70                 , _button (new wxButton (parent, wxID_ANY, _("Multiple values")))
  71                 , _property (property)
  72                 , _part (part)
  73                 , _model_getter (model_getter)
  74                 , _model_setter (model_setter)
  75                 , _view_to_model (view_to_model)
  76                 , _model_to_view (model_to_view)
  77                 , _ignore_model_changes (false)
  78         {
  79                 _button->SetToolTip (_("Click the button to set all selected content to the same value."));
  80                 _button->Hide ();
  81                 _button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentWidget::button_clicked, this));
  82         }
  83
  84         /** @return the widget that we are wrapping */
  85         T* wrapped () const
  86         {
  87                 return _wrapped;
  88         }
  89
  90         typedef std::vector<boost::shared_ptr<Content> > List;
  91
  92         /** Set the content that this control is working on (i.e. the selected content) */
  93         void set_content (List content)
  94         {
  95                 for (typename std::list<boost::signals2::connection>::iterator i = _connections.begin(); i != _connections.end(); ++i) {
  96                         i->disconnect ();
  97                 }
  98
  99                 _connections.clear ();
 100
 101                 _content = content;
 102
 103                 _wrapped->Enable (!_content.empty ());
 104
 105                 update_from_model ();
 106
 107                 for (typename List::iterator i = _content.begin(); i != _content.end(); ++i) {
 108                         _connections.push_back ((*i)->Change.connect (boost::bind (&ContentWidget::model_changed, this, _1, _3)));
 109                 }
 110         }
 111
 112         /** Add this widget to a wxGridBagSizer */
 113         void add (wxGridBagSizer* sizer, wxGBPosition position, wxGBSpan span = wxDefaultSpan)
 114         {
 115                 _sizer = sizer;
 116                 _position = position;
 117                 _span = span;
 118                 _sizer->Add (_wrapped, _position, _span);
 119         }
 120
 121         /** Update the view from the model */
 122         void update_from_model ()
 123         {
 124                 if (_content.empty ()) {
 125                         set_single ();
 126                         return;
 127                 }
 128
 129                 typename List::iterator i = _content.begin ();
 130                 U const v = boost::bind (_model_getter, _part(_content.front().get()).get())();
 131                 while (i != _content.end() && boost::bind (_model_getter, _part(i->get()).get())() == v) {
 132                         ++i;
 133                 }
 134
 135                 if (i == _content.end ()) {
 136                         set_single ();
 137                         checked_set (_wrapped, _model_to_view (v));
 138                 } else {
 139                         set_multiple ();
 140                 }
 141         }
 142
 143         void view_changed ()
 144         {
 145                 _ignore_model_changes = true;
 146                 for (size_t i = 0; i < _content.size(); ++i) {
 147                         boost::bind (_model_setter, _part (_content[i].get()).get(), _view_to_model (wx_get (_wrapped))) ();
 148                 }
 149                 _ignore_model_changes = false;
 150         }
 151
 152 private:
 153
 154         void set_single ()
 155         {
 156                 if (_wrapped->IsShown ()) {
 157                         return;
 158                 }
 159
 160                 _sizer->Detach (_button);
 161                 _button->Hide ();
 162                 _sizer->Add (_wrapped, _position, _span);
 163                 _wrapped->Show ();
 164                 _sizer->Layout ();
 165         }
 166
 167         void set_multiple ()
 168         {
 169                 if (_button->IsShown ()) {
 170                         return;
 171                 }
 172
 173                 _wrapped->Hide ();
 174                 _sizer->Detach (_wrapped);
 175                 _button->Show ();
 176                 _sizer->Add (_button, _position, _span);
 177                 _sizer->Layout ();
 178         }
 179
 180         void button_clicked ()
 181         {
 182                 U const v = boost::bind (_model_getter, _part(_content.front().get()).get())();
 183                 for (typename List::iterator i = _content.begin (); i != _content.end(); ++i) {
 184                         boost::bind (_model_setter, _part(i->get()).get(), v) ();
 185                 }
 186         }
 187
 188         void model_changed (ChangeType type, int property)
 189         {
 190                 if (type == CHANGE_TYPE_DONE && property == _property && !_ignore_model_changes) {
 191                         update_from_model ();
 192                 }
 193         }
 194
 195         T* _wrapped;
 196         wxGridBagSizer* _sizer;
 197         wxGBPosition _position;
 198         wxGBSpan _span;
 199         wxButton* _button;
 200         List _content;
 201         int _property;
 202         boost::function<boost::shared_ptr<S> (Content *)> _part;
 203         boost::function<U (S*)> _model_getter;
 204         boost::function<void (S*, U)> _model_setter;
 205         boost::function<U (V)> _view_to_model;
 206         boost::function<V (U)> _model_to_view;
 207         std::list<boost::signals2::connection> _connections;
 208         bool _ignore_model_changes;
 209 };
 210
 211 template <typename U, typename V>
 212 V caster (U x)
 213 {
 214         return static_cast<V> (x);
 215 }
 216
 217 template <class S>
 218 class ContentSpinCtrl : public ContentWidget<S, wxSpinCtrl, int, int>
 219 {
 220 public:
 221         ContentSpinCtrl (
 222                 wxWindow* parent,
 223                 wxSpinCtrl* wrapped,
 224                 int property,
 225                 boost::function<boost::shared_ptr<S> (Content *)> part,
 226                 boost::function<int (S*)> getter,
 227                 boost::function<void (S*, int)> setter
 228                 )
 229                 : ContentWidget<S, wxSpinCtrl, int, int> (
 230                         parent,
 231                         wrapped,
 232                         property,
 233                         part,
 234                         getter, setter,
 235                         &caster<int, int>,
 236                         &caster<int, int>
 237                         )
 238         {
 239                 wrapped->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&ContentWidget<S, wxSpinCtrl, int, int>::view_changed, this));
 240         }
 241 };
 242
 243 template <class S>
 244 class ContentSpinCtrlDouble : public ContentWidget<S, wxSpinCtrlDouble, double, double>
 245 {
 246 public:
 247         ContentSpinCtrlDouble (
 248                 wxWindow* parent,
 249                 wxSpinCtrlDouble* wrapped,
 250                 int property,
 251                 boost::function<boost::shared_ptr<S> (Content *)> part,
 252                 boost::function<double (S*)> getter,
 253                 boost::function<void (S*, double)> setter
 254                 )
 255                 : ContentWidget<S, wxSpinCtrlDouble, double, double> (
 256                         parent,
 257                         wrapped,
 258                         property,
 259                         part,
 260                         getter, setter,
 261                         &caster<double, double>,
 262                         &caster<double, double>
 263                         )
 264         {
 265                 wrapped->Bind (wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, boost::bind (&ContentWidget<S, wxSpinCtrlDouble, double, double>::view_changed, this));
 266         }
 267 };
 268
 269 template <class S, class U>
 270 class ContentChoice : public ContentWidget<S, wxChoice, U, int>
 271 {
 272 public:
 273         ContentChoice (
 274                 wxWindow* parent,
 275                 wxChoice* wrapped,
 276                 int property,
 277                 boost::function<boost::shared_ptr<S> (Content *)> part,
 278                 boost::function<U (S*)> getter,
 279                 boost::function<void (S*, U)> setter,
 280                 boost::function<U (int)> view_to_model,
 281                 boost::function<int (U)> model_to_view
 282                 )
 283                 : ContentWidget<S, wxChoice, U, int> (
 284                         parent,
 285                         wrapped,
 286                         property,
 287                         part,
 288                         getter,
 289                         setter,
 290                         view_to_model,
 291                         model_to_view
 292                         )
 293         {
 294                 wrapped->Bind (wxEVT_COMMAND_CHOICE_SELECTED, boost::bind (&ContentWidget<S, wxChoice, U, int>::view_changed, this));
 295         }
 296
 297 };
 298
 299 #endif