CommonTrackPanelCell.h

Go to the documentation of this file.

/**********************************************************************
 
Audacity: A Digital Audio Editor
 
CommonTrackPanelCell.h
 
Paul Licameli split from TrackPanel.cpp
 
**********************************************************************/
 
#ifndef __AUDACITY_COMMON_TRACK_PANEL_CELL__
#define __AUDACITY_COMMON_TRACK_PANEL_CELL__
 
#include "TrackPanelCell.h"
#include "ChannelAttachments.h" // to inherit
 
#include <stdlib.h>
#include <memory>
#include <functional>
#include <type_traits>
#include "ComponentInterfaceSymbol.h"
#include "GlobalVariable.h"
 
#include "XMLTagHandler.h"
 
class Channel;
class ChannelGroup;
class CommandContext;
class Track;
class XMLWriter;
 
class AUDACITY_DLL_API CommonTrackPanelCell /* not final */
   : public TrackPanelCell
{
public:
   // Function to dispatch mouse wheel events
   struct AUDACITY_DLL_API MouseWheelHook : GlobalHook<MouseWheelHook,
      unsigned(const TrackPanelMouseEvent &evt, AudacityProject *pProject)
   >{};
 
   CommonTrackPanelCell()
   {}
 
   virtual ~CommonTrackPanelCell() = 0;
 
   // Default to the arrow cursor
   HitTestPreview DefaultPreview
      (const TrackPanelMouseState &, const AudacityProject *) override;
 
   std::shared_ptr<Track> FindTrack() { return DoFindTrack(); }
   std::shared_ptr<const Track> FindTrack() const
      { return const_cast<CommonTrackPanelCell*>(this)->DoFindTrack(); }
 
   struct MenuItem {
      using Action = std::function< void(const CommandContext &) >;
 
      MenuItem() = default;
      MenuItem( const Identifier &internal, const TranslatableString &msgid,
         Action action = {}, bool enabled = true )
         : symbol{ internal, msgid }, action{ move(action) }, enabled{ enabled }
      {}
 
      ComponentInterfaceSymbol symbol;
      Action action;
      bool enabled;
   };
 
 
   virtual std::vector<MenuItem> GetMenuItems(
      const wxRect &rect, const wxPoint *pPosition, AudacityProject *pProject );
 
protected:
   virtual std::shared_ptr<Track> DoFindTrack() = 0;
 
   unsigned DoContextMenu(
      const wxRect &rect,
      wxWindow *pParent, const wxPoint *pPosition, AudacityProject *pProject)
   override;
 
   unsigned HandleWheelRotation
      (const TrackPanelMouseEvent &event,
      AudacityProject *pProject) override;
 
};
 
class AUDACITY_DLL_API CommonTrackCell /* not final */
   : public CommonTrackPanelCell, public TrackAttachment
{
public:
   CommonTrackCell(const std::shared_ptr<Track> &pTrack);
 
  ~CommonTrackCell();
 
   std::shared_ptr<Track> DoFindTrack() override;
 
   void Reparent(const std::shared_ptr<Track> &parent) override;
 
private:
   std::weak_ptr<Track> mwTrack;
};
 
class AUDACITY_DLL_API CommonChannelCell /* not final */
   : public CommonTrackPanelCell, public ChannelAttachment
{
public:
   CommonChannelCell(const std::shared_ptr<Channel> &pChannel);
 
  ~CommonChannelCell();
 
   std::shared_ptr<Track> DoFindTrack() override;
 
   void Reparent(const std::shared_ptr<Track> &parent, size_t iChannel)
      override;
 
   template<typename Subtype = Channel>
   auto FindChannel()
      -> std::shared_ptr<Subtype>
         { return std::dynamic_pointer_cast<Subtype>(DoFindChannel()); }
 
   template<typename Subtype = const Channel>
   auto FindChannel() const
      -> std::enable_if_t<std::is_const_v<Subtype>,
         std::shared_ptr<Subtype>
      >
         { return std::dynamic_pointer_cast<Subtype>(DoFindChannel()); }
 
private:
   std::shared_ptr<Channel> DoFindChannel();
   std::shared_ptr<const Channel> DoFindChannel() const;
 
   std::weak_ptr<Channel> mwChannel;
};
 
#endif