Formerly part of TrackPanel, this abstract base class has no special knowledge of Track objects and is intended for reuse with other windows. More...

#include <CellularPanel.h>

Inheritance diagram for CellularPanel:

[legend]

Collaboration diagram for CellularPanel:

[legend]

Classes
struct	Filter

struct	FoundCell

struct	State

struct	Visitor

Public Types
using	SimpleCellVisitor = std::function< void(const wxRect &rect, TrackPanelCell &cell) >

using	SimpleNodeVisitor = std::function< void(const wxRect &rect, TrackPanelNode &node) >

Public Member Functions
	CellularPanel (wxWindow parent, wxWindowID id, const wxPoint &pos, const wxSize &size, ViewInfo viewInfo, long style=wxTAB_TRAVERSAL\|wxNO_BORDER)

	~CellularPanel () override

virtual AudacityProject *	GetProject () const =0

virtual std::shared_ptr< TrackPanelNode >	Root ()=0

virtual std::shared_ptr< TrackPanelCell >	GetFocusedCell ()=0

virtual void	SetFocusedCell ()=0

virtual void	ProcessUIHandleResult (TrackPanelCell pClickedCell, TrackPanelCell pLatestCell, unsigned refreshResult)=0

virtual void	UpdateStatusMessage (const TranslatableString &)=0

void	Visit (Visitor &visitor)

void	VisitCells (const SimpleCellVisitor &visitor)

void	VisitPreorder (const SimpleNodeVisitor &visitor)

void	VisitPostorder (const SimpleNodeVisitor &visitor)

FoundCell	FindCell (int mouseX, int mouseY)

wxRect	FindRect (const TrackPanelCell &cell)

wxRect	FindRect (const std::function< bool(TrackPanelNode &) > &pred)

UIHandlePtr	Target ()

std::shared_ptr< TrackPanelCell >	LastCell () const

bool	IsMouseCaptured ()
	Determines if a modal tool is active. More...

wxCoord	MostRecentXCoord () const

void	HandleCursorForPresentMouseState (bool doHit=true)

void	Draw (TrackPanelDrawingContext &context, unsigned nPasses)

Public Member Functions inherited from OverlayPanel
	OverlayPanel (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, long style=wxTAB_TRAVERSAL\|wxNO_BORDER)

void	AddOverlay (const std::weak_ptr< Overlay > &pOverlay)

void	ClearOverlays ()

void	DrawOverlays (bool repaint_all, wxDC *pDC=nullptr)

Public Member Functions inherited from BackedPanel
	BackedPanel (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, long style)

	~BackedPanel ()

wxDC &	GetBackingDC ()

wxDC &	GetBackingDCForRepaint ()

void	ResizeBacking ()

void	RepairBitmap (wxDC &dc, wxCoord x, wxCoord y, wxCoord width, wxCoord height)

void	DisplayBitmap (wxDC &dc)

void	OnSize (wxSizeEvent &event)

Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()

	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

void	SetLabel (const TranslatableString &label)

void	SetName (const TranslatableString &name)

void	SetToolTip (const TranslatableString &toolTip)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Protected Member Functions
bool	HasEscape ()

bool	CancelDragging (bool escaping)

void	DoContextMenu (std::shared_ptr< TrackPanelCell > pCell)

void	ClearTargets ()

Protected Attributes
ViewInfo *	mViewInfo

wxMouseState	mLastMouseState

Private Member Functions
void	Visit (const wxRect &rect, const std::shared_ptr< TrackPanelNode > &node, Visitor &visitor)

bool	HasRotation ()

bool	ChangeTarget (bool forward, bool cycle)

void	OnMouseEvent (wxMouseEvent &event)

void	OnCaptureLost (wxMouseCaptureLostEvent &event)
	Should handle the case when the mouse capture is lost. (MSW only) More...

void	OnCaptureKey (wxCommandEvent &event)

void	OnKeyDown (wxKeyEvent &event)

void	OnChar (wxKeyEvent &event)

void	OnKeyUp (wxKeyEvent &event)

void	OnSetFocus (wxFocusEvent &event)

void	OnKillFocus (wxFocusEvent &event)

void	DoKillFocus ()

void	OnContextMenu (wxContextMenuEvent &event)

void	HandleInterruptedDrag ()

void	Uncapture (bool escaping, wxMouseState *pState=nullptr)

bool	HandleEscapeKey (bool down)

void	UpdateMouseState (const wxMouseState &state)

void	HandleModifierKey ()

void	HandleClick (const TrackPanelMouseEvent &tpmEvent)

void	HandleWheelRotation (TrackPanelMouseEvent &tpmEvent)
	Handle mouse wheel rotation (for zoom in/out, vertical and horizontal scrolling) More...

void	HandleMotion (wxMouseState &state, bool doHit=true)

void	HandleMotion (const TrackPanelMouseState &tpmState, bool doHit=true)

void	Leave ()

Private Attributes
std::unique_ptr< State >	mState

Detailed Description

Formerly part of TrackPanel, this abstract base class has no special knowledge of Track objects and is intended for reuse with other windows.

Manages a division of a panel's area into disjoint rectangles, each with an associated Cell object. Details of that partition and association, and the choice of the cell with keyboard focus, are subclass responsibilities.

Handling of keyboard events is delegated to the focused cell. The cell under the mouse position is queried for hit-test candidate objects, which handle click-drag-release (and ESC key abort) sequences.

Definition at line 34 of file CellularPanel.h.

Member Typedef Documentation

◆ SimpleCellVisitor

using CellularPanel::SimpleCellVisitor = std::function< void( const wxRect &rect, TrackPanelCell &cell ) >

Definition at line 74 of file CellularPanel.h.

◆ SimpleNodeVisitor

using CellularPanel::SimpleNodeVisitor = std::function< void( const wxRect &rect, TrackPanelNode &node ) >

Definition at line 79 of file CellularPanel.h.

Constructor & Destructor Documentation

◆ CellularPanel()

CellularPanel::CellularPanel	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos,
		const wxSize &	size,
		ViewInfo *	viewInfo,
		long	style = `wxTAB_TRAVERSAL \| wxNO_BORDER`
	)

Definition at line 130 of file CellularPanel.cpp.

: OverlayPanel(parent, id, pos, size, style)
, mViewInfo( viewInfo )
, mState{ std::make_unique<State>() }
{
   // Create the global event filter instance for CellularPanels only when the
   // first CellularPanel is created, not sooner, so that the filter will be
   // invoked before that for the application.
   Filter::Create();
}

◆ ~CellularPanel()

CellularPanel::~CellularPanel ( )

overridedefault

Member Function Documentation

◆ CancelDragging()

bool CellularPanel::CancelDragging ( bool escaping )

protected

Definition at line 180 of file CellularPanel.cpp.

{
   auto &state = *mState;
   if (state.mUIHandle) {
      // copy shared_ptr for safety, as in HandleClick
      auto handle = state.mUIHandle;
      // UIHANDLE CANCEL
      UIHandle::Result refreshResult = handle->Cancel(GetProject());
      auto pClickedCell = state.mpClickedCell.lock();
      if (pClickedCell)
         ProcessUIHandleResult(
            pClickedCell.get(), {},
            refreshResult | state.mMouseOverUpdateFlags );
      state.mpClickedCell.reset();
      state.mUIHandle.reset(), handle.reset(), ClearTargets();
      Uncapture( escaping );
      return true;
   }
   return false;
}

References ClearTargets(), GetProject(), mState, ProcessUIHandleResult(), and Uncapture().

Referenced by HandleEscapeKey(), AdornedRulerPanel::OnAudioStartStop(), and OnMouseEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ChangeTarget()

bool CellularPanel::ChangeTarget	(	bool	forward,
		bool	cycle
	)

private

Definition at line 459 of file CellularPanel.cpp.

{
   auto &state = *mState;
   auto size = state.mTargets.size();
 
   auto target = Target();
   if (target && target->HasRotation()) {
      if(target->Rotate(forward))
         return true;
      else if (cycle && (size == 1 || IsMouseCaptured())) {
         // Rotate through the states of this target only.
         target->Enter(forward, GetProject());
         return true;
      }
   }
 
   if (!cycle &&
       ((forward && state.mTarget + 1 == size) ||
        (!forward && state.mTarget == 0)))
      return false;
 
   if (size > 1) {
      if (forward)
         ++state.mTarget;
      else
         state.mTarget += size - 1;
      state.mTarget %= size;
      if (Target())
         Target()->Enter(forward, GetProject());
      return true;
   }
 
   return false;
}

References forward, GetProject(), IsMouseCaptured(), mState, size, and Target().

Referenced by HandleEscapeKey(), and OnKeyDown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearTargets()

void CellularPanel::ClearTargets ( )

protected

Definition at line 1219 of file CellularPanel.cpp.

{
   auto &state = *mState;
   // Forget the rotation of hit test candidates when the mouse moves from
   // cell to cell or outside of the panel entirely.
   state.mLastCell.reset();
   state.mTargets.clear();
   state.mTarget = 0;
   state.mMouseOverUpdateFlags = 0;
}

References mState.

Referenced by CancelDragging(), HandleClick(), HandleMotion(), AdornedRulerPanel::OnAudioStartStop(), and OnMouseEvent().

Here is the caller graph for this function:

◆ DoContextMenu()

void CellularPanel::DoContextMenu ( std::shared_ptr< TrackPanelCell > pCell )

protected

Definition at line 969 of file CellularPanel.cpp.

{
   if( !pCell ) {
      pCell = GetFocusedCell();
      if( !pCell )
         return;
   }
 
   std::weak_ptr<TrackPanelCell> wCell = pCell;
 
   const auto delegate = pCell->ContextMenuDelegate();
   if (!delegate)
      return;
 
   auto rect = FindRect( *delegate );
   const UIHandle::Result refreshResult =
      delegate->DoContextMenu(rect, this, nullptr, GetProject());
   pCell.reset();
 
   ProcessUIHandleResult(wCell.lock().get(), wCell.lock().get(), refreshResult);
}

References FindRect(), GetFocusedCell(), GetProject(), and ProcessUIHandleResult().

Referenced by OnContextMenu(), and TrackPanel::OnTrackMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoKillFocus()

void CellularPanel::DoKillFocus ( )

private

Definition at line 997 of file CellularPanel.cpp.

{
   if (auto pCell = GetFocusedCell()) {
      auto refreshResult = pCell->LoseFocus(GetProject());
      auto &state = *mState;
      auto pClickedCell = state.mpClickedCell.lock();
      if (pClickedCell)
         ProcessUIHandleResult( pClickedCell.get(), {}, refreshResult );
   }
   Refresh( false);
}

References GetFocusedCell(), GetProject(), mState, and ProcessUIHandleResult().

Referenced by OnKillFocus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Draw()

void CellularPanel::Draw	(	TrackPanelDrawingContext &	context,
		unsigned	nPasses
	)

Definition at line 1236 of file CellularPanel.cpp.

{
   const auto panelRect = GetClientRect();
   auto lastCell = LastCell();
   for ( unsigned iPass = 0; iPass < nPasses; ++iPass ) {
 
      VisitPostorder( [&]( const wxRect &rect, TrackPanelNode &node ) {
 
         // Draw the node
         const auto newRect = node.DrawingArea(
            context, rect, panelRect, iPass );
         if ( newRect.Intersects( panelRect ) )
            node.Draw( context, newRect, iPass );
 
         // Draw the current handle if it is associated with the node
         if ( &node == lastCell.get() ) {
            auto target = Target();
            if ( target ) {
               const auto targetRect =
                  target->DrawingArea( context, rect, panelRect, iPass );
               if ( targetRect.Intersects( panelRect ) )
                  target->Draw( context, targetRect, iPass );
            }
         }
 
      } ); // nodes
 
   } // passes
}

References TrackPanelDrawable::Draw(), TrackPanelDrawable::DrawingArea(), LastCell(), and VisitPostorder().

Referenced by TrackPanel::DrawTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindCell()

auto CellularPanel::FindCell	(	int	mouseX,
		int	mouseY
	)

Definition at line 1136 of file CellularPanel.cpp.

{
   auto rect = this->GetClientRect();
   auto node = Root();
   while (node) {
      if ( auto pCell = std::dynamic_pointer_cast< TrackPanelCell >( node ) )
         // Found the bottom of the hierarchy
         return { pCell, rect };
      else if ( auto pGroup = dynamic_cast< TrackPanelGroup* >( node.get() ) ) {
         // Ask node for its subdivision
         const auto results = pGroup->Children( rect );
         const bool divideX = results.first == TrackPanelGroup::Axis::X;
         const auto &children = results.second;
 
         // Find the correct child
         const auto begin = children.begin(), end = children.end();
         auto iter = std::upper_bound( begin, end,
            (divideX ? mouseX : mouseY),
            [&]( wxCoord coord, const TrackPanelGroup::Child &child ) {
               return coord < child.first;
            }
         );
         if (iter == begin)
            break;
         --iter;
 
         // Descend the hierarchy of nodes
         rect = Subdivide(rect, divideX, children, iter);
         node = iter->second;
      }
      else
         // Nulls in the array of children are allowed, to define a void with
         // no cell
         break;
   }
 
   return { {}, {} };
}

References details::begin(), details::end(), Root(), anonymous_namespace{CellularPanel.cpp}::Subdivide(), and TrackPanelGroup::X.

Referenced by HandleMotion(), OnMouseEvent(), and TrackPanel::OnMouseEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FindRect() [1/2]

wxRect CellularPanel::FindRect ( const std::function< bool(TrackPanelNode &) > & pred )

Definition at line 1189 of file CellularPanel.cpp.

{
   wxRect result;
 
   struct Stop{};
   try { VisitPreorder( [&]( const wxRect &rect, TrackPanelNode &visited ) {
      if ( pred( visited ) )
         result = rect, throw Stop{};
   } ); }
   catch ( const Stop& ) {}
 
   return result;
}

References VisitPreorder().

Here is the call graph for this function:

◆ FindRect() [2/2]

wxRect CellularPanel::FindRect ( const TrackPanelCell & cell )

Definition at line 1175 of file CellularPanel.cpp.

{
   wxRect result;
 
   struct Stop{};
   try { VisitCells( [&]( const wxRect &rect, TrackPanelCell &visited ) {
      if ( &visited == &cell )
         result = rect, throw Stop{};
   } ); }
   catch ( const Stop& ) {}
 
   return result;
}

References VisitCells().

Referenced by DoContextMenu(), TrackPanel::FindTrackRect(), WaveTrackControls::PanSlider(), and WaveTrackControls::VolumeSlider().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFocusedCell()

virtual std::shared_ptr< TrackPanelCell > CellularPanel::GetFocusedCell ( )

pure virtual

Implemented in AdornedRulerPanel, and TrackPanel.

Referenced by DoContextMenu(), DoKillFocus(), OnCaptureKey(), OnChar(), OnKeyDown(), and OnKeyUp().

Here is the caller graph for this function:

◆ GetProject()

virtual AudacityProject * CellularPanel::GetProject ( ) const

pure virtual

Implemented in AdornedRulerPanel, and TrackPanel.

Referenced by CancelDragging(), ChangeTarget(), DoContextMenu(), DoKillFocus(), HandleClick(), HandleEscapeKey(), HandleMotion(), HandleWheelRotation(), HasEscape(), OnCaptureKey(), OnChar(), OnKeyDown(), OnKeyUp(), and OnMouseEvent().

Here is the caller graph for this function:

◆ HandleClick()

void CellularPanel::HandleClick ( const TrackPanelMouseEvent & tpmEvent )

private

Definition at line 910 of file CellularPanel.cpp.

{
   auto pCell = tpmEvent.pCell;
   // Do hit test once more, in case the button really pressed was not the
   // one "anticipated."
   {
      TrackPanelMouseState tpmState{
         tpmEvent.event,
         tpmEvent.rect,
         tpmEvent.pCell
      };
      HandleMotion( tpmState );
   }
 
   auto &state = *mState;
   state.mUIHandle = Target();
   if (tpmEvent.event.RightDown() &&
       !(state.mUIHandle && state.mUIHandle->HandlesRightClick())) {
      if (auto pCell = state.mLastCell.lock())
         state.mUIHandle = std::make_shared<DefaultRightButtonHandler>(pCell);
   }
 
   if (state.mUIHandle) {
      // UIHANDLE CLICK
      // Make another shared pointer to the handle, in case recursive
      // event dispatching otherwise tries to delete the handle.
      auto handle = state.mUIHandle;
      UIHandle::Result refreshResult =
         handle->Click( tpmEvent, GetProject() );
      if (refreshResult & RefreshCode::Cancelled)
         state.mUIHandle.reset(), handle.reset(), ClearTargets();
      else {
         Filter::spClickedPanel = this;
 
#if wxUSE_TOOLTIPS
         // Remove any outstanding tooltip
         UnsetToolTip();
#endif
 
         if( !HasFocus() && AcceptsFocus() )
            SetFocusIgnoringChildren();
 
         state.mpClickedCell = pCell;
 
         // Perhaps the clicked handle wants to update cursor and state message
         // after a click.
         TrackPanelMouseState tpmState{
            tpmEvent.event,
            tpmEvent.rect,
            tpmEvent.pCell
         };
         HandleMotion( tpmState );
      }
      ProcessUIHandleResult(
         pCell.get(), pCell.get(), refreshResult);
      state.mMouseOverUpdateFlags |= refreshResult;
   }
}

References RefreshCode::Cancelled, ClearTargets(), TrackPanelMouseEvent::event, GetProject(), HandleMotion(), mState, TrackPanelMouseEvent::pCell, ProcessUIHandleResult(), TrackPanelMouseEvent::rect, CellularPanel::Filter::spClickedPanel, and Target().

Referenced by OnMouseEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleCursorForPresentMouseState()

void CellularPanel::HandleCursorForPresentMouseState ( bool doHit = true )

Definition at line 254 of file CellularPanel.cpp.

{
   // Come here on modifier key or mouse button transitions,
   // or on starting or stopping of play or record,
   // or change of toolbar button,
   // and change the cursor appropriately.
 
   // Get the button and key states
   auto state = ::wxGetMouseState();
   // Remap the position
   state.SetPosition(this->ScreenToClient(state.GetPosition()));
 
   HandleMotion( state, doHit );
}

References HandleMotion().

Referenced by HandleEscapeKey(), HandleModifierKey(), TrackPanel::OnAudioIO(), OnKeyDown(), AdornedRulerPanel::Refresh(), and TrackPanel::Refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleEscapeKey()

bool CellularPanel::HandleEscapeKey ( bool down )

private

Definition at line 201 of file CellularPanel.cpp.

{
   if (!down)
      return false;
 
   {
      auto target = Target();
      const auto pProject = GetProject();
      if (target && target->HasEscape(pProject) && target->Escape(pProject)) {
         HandleCursorForPresentMouseState(false);
         return true;
      }
   }
 
   auto &state = *mState;
   if (state.mUIHandle) {
      CancelDragging( true );
      return true;
   }
 
   if (ChangeTarget(true, false)) {
      HandleCursorForPresentMouseState(false);
      return true;
   }
 
   return false;
}

References CancelDragging(), ChangeTarget(), GetProject(), HandleCursorForPresentMouseState(), mState, and Target().

Referenced by OnKeyDown(), and OnKeyUp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleInterruptedDrag()

void CellularPanel::HandleInterruptedDrag ( )

private

Definition at line 147 of file CellularPanel.cpp.

{
   auto &state = *mState;
   if (state.mUIHandle &&
       state.mUIHandle->StopsOnKeystroke() ) {
      // The bogus id isn't used anywhere, but may help with debugging.
      // as this is sending a bogus mouse up.  The mouse button is still actually down
      // and may go up again.
      const int idBogusUp = 2;
      wxMouseEvent evt { wxEVT_LEFT_UP };
      evt.SetId( idBogusUp );
      evt.SetPosition(this->ScreenToClient(::wxGetMousePosition()));
      this->ProcessEvent(evt);
   }
}

References mState.

Referenced by OnCaptureKey().

Here is the caller graph for this function:

◆ HandleModifierKey()

void CellularPanel::HandleModifierKey ( )

private

Definition at line 249 of file CellularPanel.cpp.

{
   HandleCursorForPresentMouseState();
}

References HandleCursorForPresentMouseState().

Referenced by OnKeyDown(), and OnKeyUp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleMotion() [1/2]

void CellularPanel::HandleMotion	(	const TrackPanelMouseState &	tpmState,
		bool	doHit = `true`
	)

private

Definition at line 287 of file CellularPanel.cpp.

{
   auto &state = *mState;
   auto handle = state.mUIHandle;
 
   auto newCell = tpmState.pCell;
   auto oldCell = state.mLastCell.lock();
   auto oldHandle = Target();
 
   TranslatableString status, tooltip;
   wxCursor *pCursor{};
   unsigned refreshCode = 0;
   if ( ! doHit ) {
      // Dragging or not
      handle = Target();
 
      // Assume cell does not change but target does
      refreshCode = state.mMouseOverUpdateFlags;
      state.mMouseOverUpdateFlags = 0;
   }
   else if ( !state.mUIHandle ) {
      // Not yet dragging.
 
      unsigned updateFlags = state.mMouseOverUpdateFlags;
 
      // First check whether crossing cell to cell
      if ( newCell == oldCell )
         oldCell.reset();
      else {
         // Forget old targets
         ClearTargets();
         // Re-draw any highlighting
         if (oldCell) {
            ProcessUIHandleResult(
               oldCell.get(), oldCell.get(), updateFlags);
         }
      }
 
      auto oldPosition = state.mTarget;
 
      // Now do the
      // UIHANDLE HIT TEST !
      state.mTargets.clear();
      if (newCell)
         state.mTargets = newCell->HitTest(tpmState, GetProject());
      state.mTarget = 0;
 
      // Find the old target's NEW place if we can
      if (oldHandle) {
         auto begin = state.mTargets.begin(), end = state.mTargets.end(),
            iter = std::find(begin, end, oldHandle);
         if (iter != end) {
            size_t newPosition = iter - begin;
            if (newPosition <= oldPosition)
               state.mTarget = newPosition;
            // else, some NEW hit at this position takes priority
         }
      }
 
      handle = Target();
 
      state.mLastCell = newCell;
 
      // These lines caused P2 Bug 2617, repeated refreshing using all CPU.
      // Disabling them might be causing something to not refresh,
      // but so far I have not found a downside to disabling them.  JKC
 
      // VS: https://github.com/audacity/audacity/issues/1363
      // Extensive refresh request fixed by using std::move on 
      // new envelope handle instance
      if (!oldCell && oldHandle != handle)
          // Did not move cell to cell, but did change the target
          refreshCode = updateFlags;
 
 
      if (handle && handle != oldHandle)
         handle->Enter(true, GetProject());
 
      if (oldHandle == handle)
         oldHandle.reset();
   }
 
   // UIHANDLE PREVIEW
   // Update status message and cursor, whether dragging or not
   if (handle) {
      auto preview = handle->Preview( tpmState, GetProject() );
      status = preview.message;
      tooltip = preview.tooltip;
      pCursor = preview.cursor;
      auto code = handle->GetChangeHighlight();
      handle->SetChangeHighlight(RefreshCode::RefreshNone);
      refreshCode |= code;
      state.mMouseOverUpdateFlags |= code;
   }
   if (newCell &&
       (!pCursor || status.empty() || tooltip.empty())) {
      // Defaulting of cursor, tooltip, and status if there is no handle,
      // or if the handle does not specify them
      const auto preview = newCell->DefaultPreview( tpmState, GetProject() );
      if (!pCursor)
         pCursor = preview.cursor;
      if (status.empty())
         status = preview.message;
      if (tooltip.empty())
         tooltip = preview.tooltip;
   }
   if (!pCursor) {
      // Ultimate default cursor
      static wxCursor defaultCursor{ wxCURSOR_DEFAULT };
      pCursor = &defaultCursor;
   }
 
   // Update status, tooltip, and cursor only if we're dragging, or the mouse
   // was in one of our cells and nobody else is dragging
   if (handle || (newCell && !wxWindow::GetCapture())) {
      UpdateStatusMessage(status);
 
#if wxUSE_TOOLTIPS
      if (tooltip.Translation() != GetToolTipText()) {
         // Unset first, by analogy with AButton
         UnsetToolTip();
         if (handle != oldHandle)
            SetToolTip(tooltip);
      }
#endif
 
      if (pCursor)
         SetCursor( *pCursor );
   }
   else if ( oldCell || oldHandle )
      // Leaving a cell or hit test target with no replacement
      UpdateStatusMessage( {} );
 
   if (newCell)
      ProcessUIHandleResult(newCell.get(), newCell.get(), refreshCode);
}

References details::begin(), ClearTargets(), TranslatableString::empty(), details::end(), GetProject(), mState, TrackPanelMouseState::pCell, ProcessUIHandleResult(), RefreshCode::RefreshNone, wxPanelWrapper::SetToolTip(), Target(), TranslatableString::Translation(), and UpdateStatusMessage().

Here is the call graph for this function:

◆ HandleMotion() [2/2]

void CellularPanel::HandleMotion	(	wxMouseState &	inState,
		bool	doHit = `true`
	)

private

CellularPanel::HandleMotion( ) sets the cursor drawn at the mouse location, and updates the status bar message. We treat certain other changes of mouse button and key state as "motions" too, and also starting and stopping of playback or recording, all of which may cause the appropriate cursor and message to change. As this procedure checks which region the mouse is over, it is appropriate to establish the message in the status bar.

Definition at line 276 of file CellularPanel.cpp.

{
   UpdateMouseState( inState );
 
   const auto foundCell = FindCell( inState.m_x, inState.m_y );
   auto &rect = foundCell.rect;
   auto &pCell = foundCell.pCell;
   const TrackPanelMouseState tpmState{ mLastMouseState, rect, pCell };
   HandleMotion( tpmState, doHit );
}

References FindCell(), HandleMotion(), mLastMouseState, and UpdateMouseState().

Referenced by HandleClick(), HandleCursorForPresentMouseState(), HandleMotion(), Leave(), OnMouseEvent(), and Uncapture().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HandleWheelRotation()

void CellularPanel::HandleWheelRotation ( TrackPanelMouseEvent & tpmEvent )

private

Handle mouse wheel rotation (for zoom in/out, vertical and horizontal scrolling)

Definition at line 507 of file CellularPanel.cpp.

{
   auto pCell = tpmEvent.pCell;
   if (!pCell)
      return;
 
   auto &event = tpmEvent.event;
   double steps {};
#if defined(__WXMAC__) && defined(EVT_MAGNIFY)
   // PRL:
   // Pinch and spread implemented in wxWidgets 3.1.0, or cherry-picked from
   // the future in custom build of 3.0.2
   if (event.Magnify()) {
      event.SetControlDown(true);
      steps = 2 * event.GetMagnification();
   }
   else
#endif
   {
      steps = event.m_wheelRotation /
         (event.m_wheelDelta > 0 ? (double)event.m_wheelDelta : 120.0);
   }
 
   if(event.GetWheelAxis() == wxMOUSE_WHEEL_HORIZONTAL) {
      // Two-fingered horizontal swipe on mac is treated like shift-mousewheel
      event.SetShiftDown(true);
      // This makes the wave move in the same direction as the fingers, and the scrollbar
      // thumb moves oppositely
      steps *= -1;
   }
 
   tpmEvent.steps = steps;
 
   if(!event.HasAnyModifiers()) {
      // We will later un-skip if we do anything, but if we don't,
      // propagate the event up for the sake of the scrubber
      event.Skip();
      event.ResumePropagation(wxEVENT_PROPAGATE_MAX);
   }
 
   unsigned result =
      pCell->HandleWheelRotation( tpmEvent, GetProject() );
   ProcessUIHandleResult(
      pCell.get(), pCell.get(), result);
}

References TrackPanelMouseEvent::event, GetProject(), TrackPanelMouseEvent::pCell, ProcessUIHandleResult(), and TrackPanelMouseEvent::steps.

Referenced by OnMouseEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasEscape()

bool CellularPanel::HasEscape ( )

protected

Definition at line 445 of file CellularPanel.cpp.

{
   if (IsMouseCaptured())
      return true;
 
   auto &state = *mState;
  if (state.mTarget + 1 == state.mTargets.size() &&
       Target() &&
       !Target()->HasEscape(GetProject()))
       return false;
 
   return state.mTargets.size() > 0;
}

References GetProject(), HasEscape(), IsMouseCaptured(), mState, and Target().

Referenced by HasEscape(), and TrackPanel::UpdateStatusMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasRotation()

bool CellularPanel::HasRotation ( )

private

Definition at line 435 of file CellularPanel.cpp.

{
   auto &state = *mState;
   // Is there a nontrivial TAB key rotation?
   if ( state.mTargets.size() > 1 )
      return true;
   auto target = Target();
   return target && target->HasRotation();
}

References mState, and Target().

Referenced by OnCaptureKey(), and OnKeyDown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsMouseCaptured()

bool CellularPanel::IsMouseCaptured ( )

Determines if a modal tool is active.

Definition at line 495 of file CellularPanel.cpp.

{
   auto &state = *mState;
   return state.mUIHandle != NULL;
}

References mState.

Referenced by ChangeTarget(), HasEscape(), and OnMouseEvent().

Here is the caller graph for this function:

◆ LastCell()

std::shared_ptr< TrackPanelCell > CellularPanel::LastCell ( ) const

Definition at line 1230 of file CellularPanel.cpp.

{
   auto &state = *mState;
   return state.mLastCell.lock();
}

References mState.

Referenced by Draw().

Here is the caller graph for this function:

◆ Leave()

void CellularPanel::Leave ( )

private

Definition at line 425 of file CellularPanel.cpp.

{
   // Make transition into an empty CellularPanel state
   auto state = ::wxGetMouseState();
   const wxRect rect;
   std::shared_ptr<TrackPanelCell> pCell;
   TrackPanelMouseState tpmState{ state, rect, pCell };
   HandleMotion( tpmState );
}

References HandleMotion().

Referenced by OnCaptureLost(), and OnMouseEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MostRecentXCoord()

wxCoord CellularPanel::MostRecentXCoord ( ) const

Definition at line 1213 of file CellularPanel.cpp.

{
   auto &state = *mState;
   return state.mMouseMostRecentX;
}

References mState.

Referenced by TrackPanel::GetMostRecentXPos().

Here is the caller graph for this function:

◆ OnCaptureKey()

void CellularPanel::OnCaptureKey ( wxCommandEvent & event )

private

Definition at line 553 of file CellularPanel.cpp.

{
   auto &state = *mState;
   state.mEnableTab = false;
   wxKeyEvent *kevent = static_cast<wxKeyEvent *>(event.GetEventObject());
   const auto code = kevent->GetKeyCode();
   if ( WXK_ESCAPE != code )
      HandleInterruptedDrag();
 
   // Give focused cell precedence
   const auto t = GetFocusedCell();
   if (t) {
      const unsigned refreshResult =
         t->CaptureKey(*kevent, *mViewInfo, this, GetProject());
      ProcessUIHandleResult(t.get(), t.get(), refreshResult);
      event.Skip(kevent->GetSkipped());
   }
 
#if 0
   // Special TAB key handling, but only if the cell didn't capture it
   if ( !(t && !kevent->GetSkipped()) &&
        WXK_TAB == code && HasRotation() ) {
      // Override TAB navigation in wxWidgets, by not skipping
      event.Skip(false);
      mEnableTab = true;
      return;
   }
   else
#endif
   if (!t)
      event.Skip();
}

References GetFocusedCell(), GetProject(), HandleInterruptedDrag(), HasRotation(), mState, mViewInfo, and ProcessUIHandleResult().

Here is the call graph for this function:

◆ OnCaptureLost()

void CellularPanel::OnCaptureLost ( wxMouseCaptureLostEvent & event )

private

Should handle the case when the mouse capture is lost. (MSW only)

Definition at line 687 of file CellularPanel.cpp.

{
   auto &state = *mState;
   state.mUIHandle.reset();
   Leave();
 
   // This is bad.  We are lying abou the event by saying it is a mouse up.
   wxMouseEvent e(wxEVT_LEFT_UP);
   e.SetId( kCaptureLostEventId );
 
   e.m_x = state.mMouseMostRecentX;
   e.m_y = state.mMouseMostRecentY;
 
   OnMouseEvent(e);
}

References kCaptureLostEventId, Leave(), mState, and OnMouseEvent().

Here is the call graph for this function:

◆ OnChar()

void CellularPanel::OnChar ( wxKeyEvent & event )

private

Definition at line 630 of file CellularPanel.cpp.

{
   switch (event.GetKeyCode())
   {
   case WXK_ESCAPE:
   case WXK_ALT:
   case WXK_SHIFT:
   case WXK_CONTROL:
   case WXK_PAGEUP:
   case WXK_PAGEDOWN:
      return;
   }
 
   const auto t = GetFocusedCell();
   if (t) {
      const unsigned refreshResult =
         t->Char(event, *mViewInfo, this, GetProject());
      ProcessUIHandleResult(t.get(), t.get(), refreshResult);
   }
   else
      event.Skip();
}

References GetFocusedCell(), GetProject(), mViewInfo, and ProcessUIHandleResult().

Here is the call graph for this function:

◆ OnContextMenu()

void CellularPanel::OnContextMenu ( wxContextMenuEvent & event )

private

Definition at line 501 of file CellularPanel.cpp.

{
   DoContextMenu({});
}

References DoContextMenu().

Here is the call graph for this function:

◆ OnKeyDown()

void CellularPanel::OnKeyDown ( wxKeyEvent & event )

private

Definition at line 586 of file CellularPanel.cpp.

{
   switch (event.GetKeyCode())
   {
   case WXK_ESCAPE:
      // This switch case is now redundant with the global filter
      if(HandleEscapeKey(true))
         // Don't skip the event, eat it so that
         // AudacityApp does not also stop any playback.
         return;
      else
         break;
 
   case WXK_ALT:
   case WXK_SHIFT:
   case WXK_CONTROL:
#ifdef __WXOSX__
   case WXK_RAW_CONTROL:
#endif
      HandleModifierKey();
      break;
 
#if 0
   case WXK_TAB:
      if ( mEnableTab && HasRotation() ) {
         ChangeTarget( !event.ShiftDown(), true );
         HandleCursorForPresentMouseState(false);
         return;
      }
      else
         break;
#endif
   }
 
   const auto t = GetFocusedCell();
   if (t) {
      const unsigned refreshResult =
         t->KeyDown(event, *mViewInfo, this, GetProject());
      ProcessUIHandleResult(t.get(), t.get(), refreshResult);
   }
   else
      event.Skip();
}

References ChangeTarget(), GetFocusedCell(), GetProject(), HandleCursorForPresentMouseState(), HandleEscapeKey(), HandleModifierKey(), HasRotation(), mViewInfo, and ProcessUIHandleResult().

Here is the call graph for this function:

◆ OnKeyUp()

void CellularPanel::OnKeyUp ( wxKeyEvent & event )

private

Definition at line 653 of file CellularPanel.cpp.

{
   bool didSomething = false;
   switch (event.GetKeyCode())
   {
   case WXK_ESCAPE:
      didSomething = HandleEscapeKey(false);
      break;
 
   case WXK_ALT:
   case WXK_SHIFT:
   case WXK_CONTROL:
#ifdef __WXOSX__
   case WXK_RAW_CONTROL:
#endif
      HandleModifierKey();
      break;
   }
 
   if (didSomething)
      return;
 
   const auto t = GetFocusedCell();
   if (t) {
      const unsigned refreshResult =
         t->KeyUp(event, *mViewInfo, this, GetProject());
      ProcessUIHandleResult(t.get(), t.get(), refreshResult);
      return;
   }
 
   event.Skip();
}

References GetFocusedCell(), GetProject(), HandleEscapeKey(), HandleModifierKey(), mViewInfo, and ProcessUIHandleResult().

Here is the call graph for this function:

◆ OnKillFocus()

void CellularPanel::OnKillFocus ( wxFocusEvent & event )

private

Definition at line 1009 of file CellularPanel.cpp.

{
   DoKillFocus();
   if (KeyboardCapture::IsHandler(this))
   {
      KeyboardCapture::Release(this);
   }
}

References DoKillFocus(), KeyboardCapture::IsHandler(), and KeyboardCapture::Release().

Here is the call graph for this function:

◆ OnMouseEvent()

void CellularPanel::OnMouseEvent ( wxMouseEvent & event )

private

This handles just generic mouse events. Then, based on our current state, we forward the mouse events to various interested parties.

Definition at line 706 of file CellularPanel.cpp.

{
   const auto foundCell = FindCell( event.m_x, event.m_y );
   auto &rect = foundCell.rect;
   auto &pCell = foundCell.pCell;
 
   const auto size = GetSize();
   TrackPanelMouseEvent tpmEvent{ event, rect, size, pCell };
 
#if defined(__WXMAC__) && defined(EVT_MAGNIFY)
   // PRL:
   // Pinch and spread implemented in wxWidgets 3.1.0, or cherry-picked from
   // the future in custom build of 3.0.2
   if (event.Magnify()) {
      HandleWheelRotation( tpmEvent );
   }
#endif
 
   // If a mouse event originates from a keyboard context menu event then
   // event.GetPosition() == wxDefaultPosition. wxContextMenu events are handled in
   // CellularPanel::OnContextMenu(), and therefore associated mouse events are ignored here.
   // Not ignoring them was causing bug 613: the mouse events were interpreted as clicking
   // outside the tracks.
   if (event.GetPosition() == wxDefaultPosition && (event.RightDown() || event.RightUp())) {
      event.Skip();
      return;
   }
 
   if (event.m_wheelRotation != 0)
      HandleWheelRotation( tpmEvent );
 
   if (event.LeftDown() || event.LeftIsDown() || event.Moving()) {
      // Skip, even if we do something, so that the left click or drag
      // may have an additional effect in the scrubber.
      event.Skip();
      event.ResumePropagation(wxEVENT_PROPAGATE_MAX);
   }
 
   auto &state = *mState;
   state.mMouseMostRecentX = event.m_x;
   state.mMouseMostRecentY = event.m_y;
 
   if (event.LeftDown()) {
      // The activate event is used to make the
      // parent window 'come alive' if it didn't have focus.
      wxActivateEvent e;
      GetParent()->GetEventHandler()->ProcessEvent(e);
   }
 
   if (event.Entering())
   {
      Filter::spEnteredPanel = this;
   }
   else if (event.Leaving())
   {
      if (Filter::spEnteredPanel == this)
         Filter::spEnteredPanel = nullptr;
      Leave();
 
      auto buttons =
         // Bug 1325: button state in Leaving events is unreliable on Mac.
         // Poll the global state instead.
         // event.ButtonIsDown(wxMOUSE_BTN_ANY);
         ::wxGetMouseState().ButtonIsDown(wxMOUSE_BTN_ANY);
 
      if (!buttons) {
         CancelDragging( false );
 
#if defined(__WXMAC__)
 
         // We must install the cursor ourselves since the window under
         // the mouse is no longer this one and wx2.8.12 makes that check.
         // Should re-evaluate with wx3.
         wxSTANDARD_CURSOR->MacInstall();
#endif
      }
   }
 
   if (state.mUIHandle) {
      auto pClickedCell = state.mpClickedCell.lock();
      if (event.Dragging()) {
         // UIHANDLE DRAG
         // copy shared_ptr for safety, as in HandleClick
         auto handle = state.mUIHandle;
         const UIHandle::Result refreshResult =
            handle->Drag( tpmEvent, GetProject() );
         ProcessUIHandleResult
            (pClickedCell.get(), pCell.get(), refreshResult);
         state.mMouseOverUpdateFlags |= refreshResult;
         if (refreshResult & RefreshCode::Cancelled) {
            // Drag decided to abort itself
            state.mUIHandle.reset(), handle.reset(), ClearTargets();
            state.mpClickedCell.reset();
            Uncapture( false, &event );
         }
         else {
            UpdateMouseState(event);
            TrackPanelMouseState tpmState{ mLastMouseState, rect, pCell };
            HandleMotion( tpmState );
         }
      }
      else if (event.ButtonUp()) {
         // UIHANDLE RELEASE
         // copy shared_ptr for safety, as in HandleClick
         auto handle = state.mUIHandle;
         unsigned moreFlags = state.mMouseOverUpdateFlags;
         UIHandle::Result refreshResult =
            handle->Release( tpmEvent, GetProject(), this );
         ProcessUIHandleResult
            (pClickedCell.get(), pCell.get(),
             refreshResult | moreFlags);
         state.mUIHandle.reset(), handle.reset(), ClearTargets();
         state.mpClickedCell.reset();
         // will also Uncapture() below
      }
   }
   else if ( event.GetEventType() == wxEVT_MOTION )
      // Update status message and cursor, not during drag
      // consider it not a drag, even if button is down during motion, if
      // mUIHandle is null, as it becomes during interrupted drag
      // (e.g. by hitting space to play while dragging an envelope point)
      HandleMotion( event );
   else if ( event.ButtonDown() || event.ButtonDClick() )
      HandleClick( tpmEvent );
 
   if (event.ButtonDown() && IsMouseCaptured()) {
      if (!HasCapture())
         CaptureMouse();
   }
 
   if (event.ButtonUp())
      Uncapture( false );
}
catch( ... )
{
   // Abort any dragging, as if by hitting Esc
   if ( CancelDragging( true ) )
      ;
   else {
      Uncapture( true );
      Refresh(false);
   }
   throw;
}

References CancelDragging(), RefreshCode::Cancelled, ClearTargets(), FindCell(), GetProject(), HandleClick(), HandleMotion(), HandleWheelRotation(), IsMouseCaptured(), Leave(), mLastMouseState, mState, ProcessUIHandleResult(), size, CellularPanel::Filter::spEnteredPanel, Uncapture(), and UpdateMouseState().

Referenced by OnCaptureLost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnSetFocus()

void CellularPanel::OnSetFocus ( wxFocusEvent & event )

private

Definition at line 991 of file CellularPanel.cpp.

{
   SetFocusedCell();
   Refresh( false);
}

References SetFocusedCell().

Here is the call graph for this function:

◆ ProcessUIHandleResult()

virtual void CellularPanel::ProcessUIHandleResult	(	TrackPanelCell *	pClickedCell,
		TrackPanelCell *	pLatestCell,
		unsigned	refreshResult
	)

pure virtual

Implemented in AdornedRulerPanel, and TrackPanel.

Referenced by CancelDragging(), DoContextMenu(), DoKillFocus(), HandleClick(), HandleMotion(), HandleWheelRotation(), OnCaptureKey(), OnChar(), OnKeyDown(), OnKeyUp(), and OnMouseEvent().

Here is the caller graph for this function:

◆ Root()

virtual std::shared_ptr< TrackPanelNode > CellularPanel::Root ( )

pure virtual

Implemented in AdornedRulerPanel, and TrackPanel.

Referenced by FindCell(), and Visit().

Here is the caller graph for this function:

◆ SetFocusedCell()

virtual void CellularPanel::SetFocusedCell ( )

pure virtual

Implemented in AdornedRulerPanel, and TrackPanel.

Referenced by OnSetFocus().

Here is the caller graph for this function:

◆ Target()

UIHandlePtr CellularPanel::Target ( )

Definition at line 1204 of file CellularPanel.cpp.

{
   auto &state = *mState;
   if (state.mTargets.size())
      return state.mTargets[state.mTarget];
   else
      return {};
}

References mState.

Referenced by ChangeTarget(), TrackPanel::DrawTracks(), anonymous_namespace{LabelTrackView.cpp}::findHit(), HandleClick(), HandleEscapeKey(), HandleMotion(), HasEscape(), HasRotation(), and TrackPanel::OnTrackListDeletion().

Here is the caller graph for this function:

◆ Uncapture()

void CellularPanel::Uncapture	(	bool	escaping,
		wxMouseState *	pState = `nullptr`
	)

private

Definition at line 163 of file CellularPanel.cpp.

{
   auto state = ::wxGetMouseState();
   if (!pState) {
      // Remap the position
      state.SetPosition(this->ScreenToClient(state.GetPosition()));
      pState = &state;
   }
 
   if (HasCapture())
      ReleaseMouse();
   HandleMotion( *pState );
 
   if ( escaping || !AcceptsFocus() )
      Filter::spClickedPanel = nullptr;
}

References HandleMotion(), and CellularPanel::Filter::spClickedPanel.

Referenced by CancelDragging(), and OnMouseEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateMouseState()

void CellularPanel::UpdateMouseState ( const wxMouseState & state )

private

Definition at line 229 of file CellularPanel.cpp.

{
   mLastMouseState = state;
 
   // Simulate a down button if none, so hit test routines can anticipate
   // which button will be clicked
   if (!state.ButtonIsDown(wxMOUSE_BTN_ANY)) {
#ifdef __WXOSX__
      if (state.RawControlDown())
         // On Mac we can distinctly anticipate "right" click (as Control+click)
         mLastMouseState.SetRightDown( true ),
         mLastMouseState.SetLeftDown( false );
      else
#endif
         // Anticipate a left click by default
         mLastMouseState.SetRightDown( false ),
         mLastMouseState.SetLeftDown( true );
   }
}

References mLastMouseState.

Referenced by HandleMotion(), and OnMouseEvent().

Here is the caller graph for this function:

◆ UpdateStatusMessage()

virtual void CellularPanel::UpdateStatusMessage ( const TranslatableString & )

pure virtual

Implemented in AdornedRulerPanel, and TrackPanel.

Referenced by HandleMotion().

Here is the caller graph for this function:

◆ Visit() [1/2]

void CellularPanel::Visit	(	const wxRect &	rect,
		const std::shared_ptr< TrackPanelNode > &	node,
		Visitor &	visitor
	)

private

Definition at line 1112 of file CellularPanel.cpp.

{
   if (auto pCell = dynamic_cast<TrackPanelCell*>(node.get()))
      visitor.VisitCell( rect, *pCell );
   else if (auto pGroup = dynamic_cast<TrackPanelGroup*>(node.get())) {
      visitor.BeginGroup( rect, *pGroup );
 
      // Recur on children
      const auto results = pGroup->Children( rect );
      const bool divideX = results.first == TrackPanelGroup::Axis::X;
      const auto &children = results.second;
      const auto begin = children.begin(), end = children.end();
      for (auto iter = begin; iter != end; ++iter)
         Visit(
            Subdivide(rect, divideX, children, iter), iter->second, visitor );
 
      visitor.EndGroup( rect, *pGroup );
   }
   else
      return;
}

References details::begin(), CellularPanel::Visitor::BeginGroup(), details::end(), CellularPanel::Visitor::EndGroup(), anonymous_namespace{CellularPanel.cpp}::Subdivide(), Visit(), CellularPanel::Visitor::VisitCell(), and TrackPanelGroup::X.

Here is the call graph for this function:

◆ Visit() [2/2]

void CellularPanel::Visit ( Visitor & visitor )

Definition at line 1028 of file CellularPanel.cpp.

{
   Visit( GetClientRect(), Root(), visitor );
}

References Root(), and Visit().

Referenced by Visit(), VisitCells(), VisitPostorder(), and VisitPreorder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VisitCells()

void CellularPanel::VisitCells ( const SimpleCellVisitor & visitor )

Definition at line 1065 of file CellularPanel.cpp.

{
   Adaptor adaptor{ visitor };
   Visit( adaptor );
}

References Visit().

Referenced by FindRect(), and TrackPanel::FindRulerRects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VisitPostorder()

void CellularPanel::VisitPostorder ( const SimpleNodeVisitor & visitor )

Definition at line 1077 of file CellularPanel.cpp.

{
   Adaptor adaptor{ visitor, false };
   Visit( adaptor );
}

References Visit().

Referenced by Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VisitPreorder()

void CellularPanel::VisitPreorder ( const SimpleNodeVisitor & visitor )

Definition at line 1071 of file CellularPanel.cpp.

{
   Adaptor adaptor{ visitor, true };
   Visit( adaptor );
}

References Visit().

Referenced by FindRect().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mLastMouseState

wxMouseState CellularPanel::mLastMouseState

protected

Definition at line 165 of file CellularPanel.h.

Referenced by TrackPanel::DrawTracks(), HandleMotion(), OnMouseEvent(), and UpdateMouseState().

◆ mState

std::unique_ptr<State> CellularPanel::mState

private

Definition at line 169 of file CellularPanel.h.

Referenced by CancelDragging(), ChangeTarget(), ClearTargets(), DoKillFocus(), HandleClick(), HandleEscapeKey(), HandleInterruptedDrag(), HandleMotion(), HasEscape(), HasRotation(), IsMouseCaptured(), LastCell(), MostRecentXCoord(), OnCaptureKey(), OnCaptureLost(), OnMouseEvent(), and Target().

◆ mViewInfo

ViewInfo* CellularPanel::mViewInfo

protected

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ SimpleCellVisitor

◆ SimpleNodeVisitor

Constructor & Destructor Documentation

◆ CellularPanel()

◆ ~CellularPanel()

Member Function Documentation

◆ CancelDragging()

◆ ChangeTarget()

◆ ClearTargets()

◆ DoContextMenu()

◆ DoKillFocus()

◆ Draw()

◆ FindCell()

◆ FindRect() [1/2]

◆ FindRect() [2/2]

◆ GetFocusedCell()

◆ GetProject()

◆ HandleClick()

◆ HandleCursorForPresentMouseState()

◆ HandleEscapeKey()

◆ HandleInterruptedDrag()

◆ HandleModifierKey()

◆ HandleMotion() [1/2]

◆ HandleMotion() [2/2]

◆ HandleWheelRotation()

◆ HasEscape()

◆ HasRotation()

◆ IsMouseCaptured()

◆ LastCell()

◆ Leave()

◆ MostRecentXCoord()

◆ OnCaptureKey()

◆ OnCaptureLost()

◆ OnChar()

◆ OnContextMenu()

◆ OnKeyDown()

◆ OnKeyUp()

◆ OnKillFocus()

◆ OnMouseEvent()

◆ OnSetFocus()

◆ ProcessUIHandleResult()

◆ Root()

◆ SetFocusedCell()

◆ Target()

◆ Uncapture()

◆ UpdateMouseState()

◆ UpdateStatusMessage()

◆ Visit() [1/2]

◆ Visit() [2/2]

◆ VisitCells()

◆ VisitPostorder()

◆ VisitPreorder()

Member Data Documentation

◆ mLastMouseState

◆ mState

◆ mViewInfo