CommonTrackPanelCell Class Reference

#include <CommonTrackPanelCell.h>

Inheritance diagram for CommonTrackPanelCell:

Collaboration diagram for CommonTrackPanelCell:

Classes
struct	MenuItem
struct	MouseWheelHook

Public Member Functions
	CommonTrackPanelCell ()
virtual	~CommonTrackPanelCell ()=0
HitTestPreview	DefaultPreview (const TrackPanelMouseState &, const AudacityProject *) override
std::shared_ptr< Track >	FindTrack ()
std::shared_ptr< const Track >	FindTrack () const
virtual std::vector< MenuItem >	GetMenuItems (const wxRect &rect, const wxPoint *pPosition, AudacityProject *pProject)
	Return a list of items for DoContextMenu() (empties for separators) More...
Public Member Functions inherited from TrackPanelCell
	TrackPanelCell ()=default
	TrackPanelCell (const TrackPanelCell &)=delete
TrackPanelCell &	operator= (const TrackPanelCell &)=delete
virtual	~TrackPanelCell ()=0
virtual HitTestPreview	DefaultPreview (const TrackPanelMouseState &state, const AudacityProject *pProject)
virtual std::vector< UIHandlePtr >	HitTest (const TrackPanelMouseState &state, const AudacityProject *pProject)=0
virtual unsigned	HandleWheelRotation (const TrackPanelMouseEvent &event, AudacityProject *pProject)
virtual std::shared_ptr< TrackPanelCell >	ContextMenuDelegate ()
virtual unsigned	DoContextMenu (const wxRect &rect, wxWindow *pParent, const wxPoint *pPosition, AudacityProject *pProject)
virtual unsigned	CaptureKey (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	KeyDown (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	KeyUp (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	Char (wxKeyEvent &event, ViewInfo &viewInfo, wxWindow *pParent, AudacityProject *project)
virtual unsigned	LoseFocus (AudacityProject *project)
Public Member Functions inherited from TrackPanelNode
	TrackPanelNode ()
virtual	~TrackPanelNode ()=0
Public Member Functions inherited from TrackPanelDrawable
virtual	~TrackPanelDrawable ()=0
virtual void	Draw (TrackPanelDrawingContext &context, const wxRect &rect, unsigned iPass)
virtual wxRect	DrawingArea (TrackPanelDrawingContext &context, const wxRect &rect, const wxRect &panelRect, unsigned iPass)

Protected Member Functions
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

Additional Inherited Members
Static Public Member Functions inherited from TrackPanelDrawable
static wxRect	MaximizeWidth (const wxRect &rect, const wxRect &panelRect)
static wxRect	MaximizeHeight (const wxRect &rect, const wxRect &panelRect)

Detailed Description

Definition at line 32 of file CommonTrackPanelCell.h.

Constructor & Destructor Documentation

CommonTrackPanelCell()

CommonTrackPanelCell::CommonTrackPanelCell ( )

inline

Definition at line 41 of file CommonTrackPanelCell.h.

   {}

~CommonTrackPanelCell()

CommonTrackPanelCell::~CommonTrackPanelCell ( )

pure virtual

Definition at line 28 of file CommonTrackPanelCell.cpp.

{
}

Member Function Documentation

DefaultPreview()

HitTestPreview CommonTrackPanelCell::DefaultPreview ( const TrackPanelMouseState &  , const AudacityProject *    )

overridevirtual

Reimplemented from TrackPanelCell.

Definition at line 32 of file CommonTrackPanelCell.cpp.

{
   static wxCursor defaultCursor{ wxCURSOR_ARROW };
   return { {}, &defaultCursor, {} };
}

DoContextMenu()

unsigned CommonTrackPanelCell::DoContextMenu ( const wxRect &  rect, wxWindow *  pParent, const wxPoint *  pPosition, AudacityProject *  pProject  )

overrideprotectedvirtual

Reimplemented from TrackPanelCell.

Definition at line 46 of file CommonTrackPanelCell.cpp.

{
   const auto items = GetMenuItems( rect, pPoint, pProject );
   if (items.empty())
      return RefreshCode::RefreshNone;
 
   auto &commandManager = CommandManager::Get(*pProject);
   commandManager.UpdateMenus();
 
   // Set up command context with extras
   CommandContext context{ *pProject };
   SelectedRegion region;
   if (pPoint) {
      auto time = ViewInfo::Get(*pProject).PositionToTime(pPoint->x, rect.x);
      region = { time, time };
      context.temporarySelection.pSelectedRegion = &region;
   }
   context.temporarySelection.pTrack = FindTrack().get();
 
   auto flags = commandManager.GetUpdateFlags();
 
   // Common dispatcher for the menu items
   auto dispatcher = [&]( wxCommandEvent &evt ){
      auto idx = evt.GetId() - 1;
      if (idx >= 0 && idx < items.size()) {
         if (auto &action = items[idx].action)
            action( context );
         else
            commandManager.HandleTextualCommand(
               items[idx].symbol.Internal(), context, flags, false);
      }
   };
 
   wxMenu menu;
   int ii = 1;
   for (const auto &item: items) {
      if ( const auto &commandID = item.symbol.Internal();
           commandID.empty() )
         menu.AppendSeparator();
      else {
         // Generate a menu item with the same shortcut key as in the toolbar
         // menu, and as determined by keyboard preferences
         auto label =
            commandManager.FormatLabelForMenu( commandID, &item.symbol.Msgid() );
         menu.Append( ii, label );
         menu.Bind( wxEVT_COMMAND_MENU_SELECTED, dispatcher );
         bool enabled = item.enabled &&
            (item.action || commandManager.GetEnabled( commandID ));
         menu.Enable( ii, enabled );
      }
      ++ii;
   }
   
   BasicUI::Point point;
   if (pPoint)
      point = { pPoint->x, pPoint->y };
   BasicMenu::Handle{ &menu }.Popup(
      wxWidgetsWindowPlacement{ pParent },
      point
   );
 
   return RefreshCode::RefreshNone;
}

References FindTrack(), CommandManager::Get(), ViewInfo::Get(), GetMenuItems(), label, BasicMenu::Handle::Popup(), ZoomInfo::PositionToTime(), RefreshCode::RefreshNone, and BasicUI::Point::x.

Here is the call graph for this function:

DoFindTrack()

virtual std::shared_ptr< Track > CommonTrackPanelCell::DoFindTrack ( )

protectedpure virtual

Implemented in anonymous_namespace{TrackPanel.cpp}::EmptyCell, BackgroundCell, ChannelVRulerControls, CommonTrackCell, and CommonChannelCell.

FindTrack() [1/2]

std::shared_ptr< Track > CommonTrackPanelCell::FindTrack ( )

inline

Definition at line 50 of file CommonTrackPanelCell.h.

{ return DoFindTrack(); }

Referenced by ChannelView::AdjustPositions(), CommonChannelView::ContextMenuDelegate(), CommonTrackControls::DoContextMenu(), DoContextMenu(), SelectHandle::Drag(), LabelTrackView::Draw(), NoteTrackAffordanceControls::Draw(), WaveTrackAffordanceControls::Draw(), CommonTrackControls::Draw(), WaveTrackAffordanceControls::ExitTextEditing(), CommonChannelView::HitTest(), CommonTrackControls::HitTest(), NoteTrackAffordanceControls::HitTest(), NoteTrackControls::HitTest(), WaveTrackAffordanceControls::HitTest(), WaveTrackControls::HitTest(), WaveTrackAffordanceControls::OnRenderClipStretching(), WaveTrackAffordanceControls::StartEditSelectedClipName(), and WaveTrackAffordanceControls::StartEditSelectedClipSpeed().

Here is the caller graph for this function:

FindTrack() [2/2]

std::shared_ptr< const Track > CommonTrackPanelCell::FindTrack ( ) const

inline

Definition at line 51 of file CommonTrackPanelCell.h.

      { return const_cast<CommonTrackPanelCell*>(this)->DoFindTrack(); }

GetMenuItems()

auto CommonTrackPanelCell::GetMenuItems ( const wxRect &  rect, const wxPoint *  pPosition, AudacityProject *  pProject  )

virtual

Return a list of items for DoContextMenu() (empties for separators)

If the vector is empty (as in the default), there is no context menu.

Commands are invoked with temporary selection fields of CommandContext set to a point selected region at the mouse pick, and the cell's track.

A function may be given, but if it is null, then the command can be found by name in the CommandManager.

An item in the list with no command name marks a menu separator.

The menu item is enabled only if it contains a true flag, but if looked up in the command manager, it must also satisfy the command manager's conditions.

Reimplemented in WaveChannelSubView, WaveTrackAffordanceControls, and BackgroundCell.

Definition at line 39 of file CommonTrackPanelCell.cpp.

{
   return {};
}

Referenced by DoContextMenu().

Here is the caller graph for this function:

HandleWheelRotation()

unsigned CommonTrackPanelCell::HandleWheelRotation ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject  )

overrideprotectedvirtual

Reimplemented from TrackPanelCell.

Definition at line 111 of file CommonTrackPanelCell.cpp.

{
   auto &hook = MouseWheelHook::Get();
   return hook ? hook( evt, pProject ) : RefreshCode::Cancelled;
}

References RefreshCode::Cancelled, and GlobalVariable< MouseWheelHook, const std::function< unsigned(const TrackPanelMouseEvent &evt, AudacityProject *pProject) >, nullptr, Options... >::Get().

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• CommonTrackPanelCell.h
• CommonTrackPanelCell.cpp