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_changed Function called when the view has changed; useful for linking controls.
  56          *  @param view_to_model Function to convert a view value to a model value.
  57          *  @param model_to_view Function to convert a model value to a view value.
  58          */
  59         ContentWidget (
  60                 wxWindow* parent,
  61                 T* wrapped,
  62                 int property,
  63                 boost::function<boost::shared_ptr<S> (Content*)> part,
  64                 boost::function<U (S*)> model_getter,
  65                 boost::function<void (S*, U)> model_setter,
  66                 boost::function<void ()> view_changed,
  67                 boost::function<U (V)> view_to_model,
  68                 boost::function<V (U)> model_to_view
  69                 )
  70                 : _wrapped (wrapped)
  71                 , _sizer (0)
  72                 , _button (new wxButton (parent, wxID_ANY, _("Multiple values")))
  73                 , _property (property)
  74                 , _part (part)
  75                 , _model_getter (model_getter)
  76                 , _model_setter (model_setter)
  77                 , _view_changed (view_changed)
  78                 , _view_to_model (view_to_model)
  79                 , _model_to_view (model_to_view)
  80                 , _ignore_model_changes (false)
  81         {
  82                 _button->SetToolTip (_("Click the button to set all selected content to the same value."));
  83                 _button->Hide ();
  84                 _button->Bind (wxEVT_COMMAND_BUTTON_CLICKED, boost::bind (&ContentWidget::button_clicked, this));
  85         }
  86
  87         /** @return the widget that we are wrapping */
  88         T* wrapped () const
  89         {
  90                 return _wrapped;
  91         }
  92
  93         typedef std::vector<boost::shared_ptr<Content> > List;
  94
  95         /** Set the content that this control is working on (i.e. the selected content) */
  96         void set_content (List content)
  97         {
  98                 for (typename std::list<boost::signals2::connection>::iterator i = _connections.begin(); i != _connections.end(); ++i) {
  99                         i->disconnect ();
 100                 }
 101
 102                 _connections.clear ();
 103
 104                 _content = content;
 105
 106                 _wrapped->Enable (!_content.empty ());
 107
 108                 update_from_model ();
 109
 110                 for (typename List::iterator i = _content.begin(); i != _content.end(); ++i) {
 111                         _connections.push_back ((*i)->Change.connect (boost::bind (&ContentWidget::model_changed, this, _1, _3)));
 112                 }
 113         }
 114
 115         /** Add this widget to a wxGridBagSizer */
 116         void add (wxGridBagSizer* sizer, wxGBPosition position, wxGBSpan span = wxDefaultSpan)
 117         {
 118                 _sizer = sizer;
 119                 _position = position;
 120                 _span = span;
 121                 _sizer->Add (_wrapped, _position, _span);
 122         }
 123
 124         /** Update the view from the model */
 125         void update_from_model ()
 126         {
 127                 if (_content.empty ()) {
 128                         set_single ();
 129                         return;
 130                 }
 131
 132                 typename List::iterator i = _content.begin ();
 133                 U const v = boost::bind (_model_getter, _part(_content.front().get()).get())();
 134                 while (i != _content.end() && boost::bind (_model_getter, _part(i->get()).get())() == v) {
 135                         ++i;
 136                 }
 137
 138                 if (i == _content.end ()) {
 139                         set_single ();
 140                         checked_set (_wrapped, _model_to_view (v));
 141                 } else {
 142                         set_multiple ();
 143                 }
 144         }
 145
 146         void view_changed ()
 147         {
 148                 _ignore_model_changes = true;
 149                 for (size_t i = 0; i < _content.size(); ++i) {
 150                         boost::bind (_model_setter, _part (_content[i].get()).get(), _view_to_model (wx_get (_wrapped))) ();
 151                 }
 152                 if (_view_changed) {
 153                         _view_changed ();
 154                 }
 155                 _ignore_model_changes = false;
 156         }
 157
 158         void show (bool s)
 159         {
 160                 _wrapped->Show (s);
 161         }
 162
 163 private:
 164
 165         void set_single ()
 166         {
 167                 if (_wrapped->IsShown() || !_sizer) {
 168                         return;
 169                 }
 170
 171                 _sizer->Detach (_button);
 172                 _button->Hide ();
 173                 _sizer->Add (_wrapped, _position, _span);
 174                 _wrapped->Show ();
 175                 _sizer->Layout ();
 176         }
 177
 178         void set_multiple ()
 179         {
 180                 if (_button->IsShown() || !_sizer) {
 181                         return;
 182                 }
 183
 184                 _wrapped->Hide ();
 185                 _sizer->Detach (_wrapped);
 186                 _button->Show ();
 187                 _sizer->Add (_button, _position, _span);
 188                 _sizer->Layout ();
 189         }
 190
 191         void button_clicked ()
 192         {
 193                 U const v = boost::bind (_model_getter, _part(_content.front().get()).get())();
 194                 for (typename List::iterator i = _content.begin (); i != _content.end(); ++i) {
 195                         boost::bind (_model_setter, _part(i->get()).get(), v) ();
 196                 }
 197         }
 198
 199         void model_changed (ChangeType type, int property)
 200         {
 201                 if (type == CHANGE_TYPE_DONE && property == _property && !_ignore_model_changes) {
 202                         update_from_model ();
 203                 }
 204         }
 205
 206         T* _wrapped;
 207         wxGridBagSizer* _sizer;
 208         wxGBPosition _position;
 209         wxGBSpan _span;
 210         wxButton* _button;
 211         List _content;
 212         int _property;
 213         boost::function<boost::shared_ptr<S> (Content *)> _part;
 214         boost::function<U (S*)> _model_getter;
 215         boost::function<void (S*, U)> _model_setter;
 216         boost::function<void ()> _view_changed;
 217         boost::function<U (V)> _view_to_model;
 218         boost::function<V (U)> _model_to_view;
 219         std::list<boost::signals2::connection> _connections;
 220         bool _ignore_model_changes;
 221 };
 222
 223 template <typename U, typename V>
 224 V caster (U x)
 225 {
 226         return static_cast<V> (x);
 227 }
 228
 229 template <class S>
 230 class ContentSpinCtrl : public ContentWidget<S, wxSpinCtrl, int, int>
 231 {
 232 public:
 233         ContentSpinCtrl (
 234                 wxWindow* parent,
 235                 wxSpinCtrl* wrapped,
 236                 int property,
 237                 boost::function<boost::shared_ptr<S> (Content *)> part,
 238                 boost::function<int (S*)> getter,
 239                 boost::function<void (S*, int)> setter,
 240                 boost::function<void ()> view_changed = boost::function<void ()>()
 241                 )
 242                 : ContentWidget<S, wxSpinCtrl, int, int> (
 243                         parent,
 244                         wrapped,
 245                         property,
 246                         part,
 247                         getter, setter,
 248                         view_changed,
 249                         &caster<int, int>,
 250                         &caster<int, int>
 251                         )
 252         {
 253                 wrapped->Bind (wxEVT_COMMAND_SPINCTRL_UPDATED, boost::bind (&ContentWidget<S, wxSpinCtrl, int, int>::view_changed, this));
 254         }
 255 };
 256
 257 template <class S>
 258 class ContentSpinCtrlDouble : public ContentWidget<S, wxSpinCtrlDouble, double, double>
 259 {
 260 public:
 261         ContentSpinCtrlDouble (
 262                 wxWindow* parent,
 263                 wxSpinCtrlDouble* wrapped,
 264                 int property,
 265                 boost::function<boost::shared_ptr<S> (Content *)> part,
 266                 boost::function<double (S*)> getter,
 267                 boost::function<void (S*, double)> setter,
 268                 boost::function<void ()> view_changed = boost::function<void ()>()
 269                 )
 270                 : ContentWidget<S, wxSpinCtrlDouble, double, double> (
 271                         parent,
 272                         wrapped,
 273                         property,
 274                         part,
 275                         getter, setter,
 276                         view_changed,
 277                         &caster<double, double>,
 278                         &caster<double, double>
 279                         )
 280         {
 281                 wrapped->Bind (wxEVT_COMMAND_SPINCTRLDOUBLE_UPDATED, boost::bind (&ContentWidget<S, wxSpinCtrlDouble, double, double>::view_changed, this));
 282         }
 283 };
 284
 285 template <class S, class U>
 286 class ContentChoice : public ContentWidget<S, wxChoice, U, int>
 287 {
 288 public:
 289         ContentChoice (
 290                 wxWindow* parent,
 291                 wxChoice* wrapped,
 292                 int property,
 293                 boost::function<boost::shared_ptr<S> (Content *)> part,
 294                 boost::function<U (S*)> getter,
 295                 boost::function<void (S*, U)> setter,
 296                 boost::function<U (int)> view_to_model,
 297                 boost::function<int (U)> model_to_view,
 298                 boost::function<void ()> view_changed = boost::function<void()>()
 299                 )
 300                 : ContentWidget<S, wxChoice, U, int> (
 301                         parent,
 302                         wrapped,
 303                         property,
 304                         part,
 305                         getter,
 306                         setter,
 307                         view_changed,
 308                         view_to_model,
 309                         model_to_view
 310                         )
 311         {
 312                 wrapped->Bind (wxEVT_COMMAND_CHOICE_SELECTED, boost::bind (&ContentWidget<S, wxChoice, U, int>::view_changed, this));
 313         }
 314
 315 };
 316
 317 #endif