view-hook.hpp

Go to the documentation of this file.

/*
  VIEW-HOOK.hpp  -  abstracted attachment to a canvas or display facility

  Copyright (C)         Lumiera.org
    2019,               Hermann Vosseler <Ichthyostega@web.de>

  This program 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,
  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.

*/


#ifndef STAGE_MODEL_VIEW_HOOK_H
#define STAGE_MODEL_VIEW_HOOK_H

#include "lib/nocopy.hpp"
#include "lib/util.hpp"

#include <utility>


namespace stage  {
namespace model {
  
  
  template<class WID>
  class ViewHook
    {
    public:
      virtual ~ViewHook() { }    
      
      virtual void hook   (WID& widget)           =0;
      virtual void remove (WID& widget)           =0;
      virtual void rehook (WID& widget) noexcept  =0;
      
      template<class IT>
      void reOrder (IT newOrder);
    };
  
  
  
  template<class WID, class BASE =WID>
  class ViewHooked
    : public WID
    , util::NonCopyable
    {
      using View = ViewHook<BASE>;
      View* view_;
      
    public:
      template<typename...ARGS>
      ViewHooked (View& view, ARGS&& ...args)
        : WID{std::forward<ARGS>(args)...}
        , view_{&view}
        {
          view_->hook (*this);
        }
      
     ~ViewHooked()  noexcept
        {
          try {
              if (view_)
                view_->remove (*this);
            }
          ERROR_LOG_AND_IGNORE (progress, "Detaching of ViewHooked widgets from the presentation")
        }
    };
  
  
  
  template<class WID>
  template<class IT>
  void
  ViewHook<WID>::reOrder (IT newOrder)
  {
    for (WID& existingHook : newOrder)
      this->rehook (existingHook);
  }
  
  
  
}}// namespace stage::model
#endif /*STAGE_MODEL_VIEW_HOOK_H*/