clip-widget.hpp

Go to the documentation of this file.

/*
  CLIP-WIDGET.hpp  -  display of a clip in timeline or media bin view

  Copyright (C)         Lumiera.org
    2016,               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_TIMELINE_CLIP_WIDGET_H
#define STAGE_TIMELINE_CLIP_WIDGET_H

#include "stage/gtk-base.hpp"
#include "stage/model/canvas-hook.hpp"
#include "lib/time/timevalue.hpp"

//#include "lib/util.hpp"

#include <optional>
#include <memory>
#include <string>
//#include <vector>



namespace stage  {
namespace timeline {
  
  using std::string;
  using std::nullopt;
  using std::optional;
  using lib::time::Time;
  using lib::time::TimeVar;
  using lib::time::Duration;
  using lib::time::TimeSpan;
  
  using WidgetHook = model::CanvasHook<Gtk::Widget>;
  
  class ClipDelegate;
  using PDelegate = std::unique_ptr<ClipDelegate>;
  
  
  class ClipDelegate
    {
      TimeSpan timing_;
      
    public:
      virtual ~ClipDelegate();   
      ClipDelegate();
      
      
      enum Appearance {PENDING, SYMBOLIC, DEGRADED, ABRIDGED, COMPACT, EXPANDED};
      
      
      static const int defaultOffsetY;
      
      static const string defaultName;
      
      virtual Appearance currentAppearance()  const  =0;
      
      virtual Appearance changeAppearance (Appearance desired)  =0;
      
      virtual cuString getClipName()    const =0;
      virtual void setClipName (cuString&)    =0;
      
      virtual TimeVar& accessStartTime()      =0;
      virtual TimeVar& accessDuration()       =0;

      virtual uint getVerticalOffset()  const =0;
      
      virtual WidgetHook& getCanvas()   const =0;
      virtual void updatePosition()           =0;
      
      virtual uint calcRequiredHeight() const =0;
      

      WidgetHook::Pos establishHookPoint (WidgetHook* newView);
      
      
      static Appearance selectAppearance (PDelegate& existing,
                                          Appearance desired  =PENDING,
                                          WidgetHook* newView =nullptr,
                                          optional<TimeSpan> const& timing =nullopt);
      
      static Gtk::Widget& expect_and_expose_Widget (PDelegate& manager);
      
      
    private:/* ===== Internals ===== */
      
    };
  
  
}}// namespace stage::timeline
#endif /*STAGE_TIMELINE_CLIP_WIDGET_H*/