LabelTextHandle Class Reference

#include <LabelTextHandle.h>

Inheritance diagram for LabelTextHandle:

Collaboration diagram for LabelTextHandle:

Public Member Functions
LabelTextHandle &	operator= (const LabelTextHandle &)=default
	LabelTextHandle (const std::shared_ptr< LabelTrack > &pLT, int labelNum)
virtual	~LabelTextHandle ()
std::shared_ptr< const Track >	FindTrack () const override
int	GetLabelNum () const
void	Enter (bool forward, AudacityProject *) override
bool	HandlesRightClick () override
	Whether the handle has any special right-button handling. More...
Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject) override
Result	Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent) override
Result	Cancel (AudacityProject *pProject) override
Public Member Functions inherited from LabelDefaultClickHandle
	LabelDefaultClickHandle ()
virtual	~LabelDefaultClickHandle ()
LabelDefaultClickHandle &	operator= (const LabelDefaultClickHandle &)=default
Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject) override
Result	Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent) override
Result	Cancel (AudacityProject *pProject) override
Public Member Functions inherited from UIHandle
virtual	~UIHandle ()=0
virtual void	Enter (bool forward, AudacityProject *pProject)
virtual bool	HasRotation () const
virtual bool	Rotate (bool forward)
virtual bool	HasEscape (AudacityProject *pProject) const
virtual bool	Escape (AudacityProject *pProject)
virtual bool	HandlesRightClick ()
	Whether the handle has any special right-button handling. More...
virtual Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0
virtual Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject)=0
virtual HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject)=0
virtual Result	Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent)=0
virtual Result	Cancel (AudacityProject *pProject)=0
virtual bool	StopsOnKeystroke ()
virtual void	OnProjectChange (AudacityProject *pProject)
virtual std::shared_ptr< const Track >	FindTrack () const =0
virtual bool	IsDragging () const
Result	GetChangeHighlight () const
void	SetChangeHighlight (Result val)
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)

Static Public Member Functions
static UIHandlePtr	HitTest (std::weak_ptr< LabelTextHandle > &holder, const wxMouseState &state, const std::shared_ptr< LabelTrack > &pLT)
Static Public Member Functions inherited from UIHandle
static UIHandle::Result	NeedChangeHighlight (const UIHandle &, const UIHandle &)
static std::shared_ptr< const Track >	TrackFromChannel (const std::shared_ptr< const Channel > &pChannel)
	A frequent convenience in the definition of UIHandles. More...
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)

Private Member Functions
void	HandleTextClick (AudacityProject &project, const wxMouseEvent &evt)
void	HandleTextDragRelease (AudacityProject &project, const wxMouseEvent &evt)

Static Private Member Functions
static HitTestPreview	HitPreview ()

Private Attributes
std::weak_ptr< LabelTrack >	mpLT {}
int	mLabelNum { -1 }
int	mLabelTrackStartXPos { -1 }
int	mLabelTrackStartYPos { -1 }
bool	mRightDragging { false }
	flag to tell if it's a valid dragging More...

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned
using	Cell = TrackPanelCell
Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 22 of file LabelTextHandle.h.

Constructor & Destructor Documentation

LabelTextHandle()

LabelTextHandle::LabelTextHandle ( const std::shared_ptr< LabelTrack > &  pLT, int  labelNum  )

explicit

Definition at line 28 of file LabelTextHandle.cpp.

   : mpLT{ pLT }
   , mLabelNum{ labelNum }
{
}

~LabelTextHandle()

LabelTextHandle::~LabelTextHandle ( )

virtual

Definition at line 69 of file LabelTextHandle.cpp.

{
}

Member Function Documentation

Cancel()

UIHandle::Result LabelTextHandle::Cancel ( AudacityProject *  pProject )

overridevirtual

Reimplemented from LabelDefaultClickHandle.

Definition at line 286 of file LabelTextHandle.cpp.

{
   auto result = LabelDefaultClickHandle::Cancel( pProject );
   return result | RefreshCode::RefreshAll;
}

References LabelDefaultClickHandle::Cancel(), and RefreshCode::RefreshAll.

Here is the call graph for this function:

Click()

UIHandle::Result LabelTextHandle::Click ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject  )

overridevirtual

Reimplemented from LabelDefaultClickHandle.

Definition at line 154 of file LabelTextHandle.cpp.

{
   auto pLT = mpLT.lock();
   if (!pLT)
      return RefreshCode::Cancelled;
 
   auto result = LabelDefaultClickHandle::Click( evt, pProject );
 
   const wxMouseEvent &event = evt.event;
   auto &viewInfo = ViewInfo::Get( *pProject );
 
   HandleTextClick(*pProject, event);
 
   return result | RefreshCode::RefreshCell;
}

References RefreshCode::Cancelled, LabelDefaultClickHandle::Click(), TrackPanelMouseEvent::event, ViewInfo::Get(), HandleTextClick(), mpLT, and RefreshCode::RefreshCell.

Here is the call graph for this function:

Drag()

UIHandle::Result LabelTextHandle::Drag ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject  )

overridevirtual

Reimplemented from LabelDefaultClickHandle.

Definition at line 224 of file LabelTextHandle.cpp.

{
   auto &project = *pProject;
   using namespace RefreshCode;
   auto result = LabelDefaultClickHandle::Drag( evt, pProject );
 
   const wxMouseEvent &event = evt.event;
   auto pLT = TrackList::Get( *pProject ).Lock(mpLT);
   if(pLT)
      HandleTextDragRelease( project, event );
 
   // locate the initial mouse position
   if (event.LeftIsDown()) {
      if (mLabelTrackStartXPos == -1) {
         mLabelTrackStartXPos = event.m_x;
         mLabelTrackStartYPos = event.m_y;
 
         auto pView = pLT ? &LabelTrackView::Get( *pLT ) : nullptr;
         if (pLT && (pView->GetTextEditIndex( project ) != -1) &&
             LabelTrackView::OverTextBox(
               pLT->GetLabel(pView->GetTextEditIndex( project )),
               mLabelTrackStartXPos,
               mLabelTrackStartYPos))
            mLabelTrackStartYPos = -1;
      }
      // if initial mouse position in the text box
      // then only drag text
      if (mLabelTrackStartYPos == -1)
         result |= RefreshCell;
   }
 
   return result;
}

References LabelDefaultClickHandle::Drag(), TrackPanelMouseEvent::event, TrackList::Get(), LabelTrackView::Get(), HandleTextDragRelease(), TrackList::Lock(), mLabelTrackStartXPos, mLabelTrackStartYPos, mpLT, LabelTrackView::OverTextBox(), project, and RefreshCode::RefreshCell.

Here is the call graph for this function:

Enter()

void LabelTextHandle::Enter ( bool  forward, AudacityProject *    )

overridevirtual

Reimplemented from UIHandle.

Definition at line 35 of file LabelTextHandle.cpp.

{
#ifdef EXPERIMENTAL_TRACK_PANEL_HIGHLIGHTING
   mChangeHighlight = RefreshCode::RefreshCell;
#endif
}

References UIHandle::mChangeHighlight, and RefreshCode::RefreshCell.

FindTrack()

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

overridevirtual

Returns

pointer to associated track, if any

Implements UIHandle.

Definition at line 73 of file LabelTextHandle.cpp.

{
   return mpLT.lock();
}

References mpLT.

Referenced by LabelTrackView::Draw().

Here is the caller graph for this function:

GetLabelNum()

int LabelTextHandle::GetLabelNum ( ) const

inline

Definition at line 38 of file LabelTextHandle.h.

{ return mLabelNum; }

References mLabelNum.

HandlesRightClick()

bool LabelTextHandle::HandlesRightClick ( )

overridevirtual

Whether the handle has any special right-button handling.

If not, then Click() will not be called for right click. Default is always false

Reimplemented from UIHandle.

Definition at line 149 of file LabelTextHandle.cpp.

{
   return true;
}

HandleTextClick()

void LabelTextHandle::HandleTextClick ( AudacityProject &  project, const wxMouseEvent &  evt  )

private

Definition at line 78 of file LabelTextHandle.cpp.

{
   auto pTrack = mpLT.lock();
   if (!pTrack)
      return;
 
   auto &view = LabelTrackView::Get( *pTrack );
   if (evt.ButtonDown())
   {
      const auto selIndex = LabelTrackView::OverATextBox( *pTrack, evt.m_x, evt.m_y );
      if ( selIndex != -1 ) {
         if (evt.LeftDown()) {
            mRightDragging = false;
            // Find the NEW drag end
            auto position = view.FindCursorPosition(selIndex, evt.m_x );
 
            // Anchor shift-drag at the farther end of the previous highlight
            // that is farther from the click, on Mac, for consistency with
            // its text editors, but on the others, re-use the previous
            // anchor.
            auto initial = view.GetInitialCursorPosition();
            if (evt.ShiftDown()) {
#ifdef __WXMAC__
               // Set the drag anchor at the end of the previous selection
               // that is farther from the NEW drag end
               const auto current = view.GetCurrentCursorPosition();
               if ( abs( position - current ) > abs( position - initial ) )
                  initial = current;
#else
               // initial position remains as before
#endif
            }
            else
               initial = position;
 
            view.SetTextSelection(selIndex, initial, position );
         }
         else
         {
            if (!view.IsTextSelected(project))
            {
               auto position = view.FindCursorPosition(selIndex, evt.m_x);
               view.SetTextSelection(selIndex, position, position);
            }
            // Actually this might be right or middle down
            mRightDragging = true;
         }
         // Middle click on GTK: paste from primary selection
#if defined(__WXGTK__) && (HAVE_GTK)
         if (evt.MiddleDown()) {
            // Check for a click outside of the selected label's text box; in this
            // case PasteSelectedText() will start a NEW label at the click
            // location
            if (!LabelTrackView::OverTextBox(&labelStruct, evt.m_x, evt.m_y))
               view.ResetTextSelection();
            double t = zoomInfo.PositionToTime(evt.m_x, r.x);
            newSel = SelectedRegion(t, t);
         }
#endif
      }
#if defined(__WXGTK__) && (HAVE_GTK)
      if (evt.MiddleDown()) {
         // Paste text, making a NEW label if none is selected.
         wxTheClipboard->UsePrimarySelection(true);
         view.PasteSelectedText(project, newSel.t0(), newSel.t1());
         wxTheClipboard->UsePrimarySelection(false);
      }
#endif
   }
}

References LabelTrackView::Get(), mpLT, mRightDragging, LabelTrackView::OverATextBox(), LabelTrackView::OverTextBox(), and project.

Referenced by Click().

Here is the call graph for this function:

Here is the caller graph for this function:

HandleTextDragRelease()

void LabelTextHandle::HandleTextDragRelease ( AudacityProject &  project, const wxMouseEvent &  evt  )

private

Definition at line 171 of file LabelTextHandle.cpp.

{
   auto pTrack = mpLT.lock();
   if (!pTrack)
      return;
   auto &view = LabelTrackView::Get( *pTrack );
 
   if(evt.LeftUp())
   {
#if 0
      // AWD: Due to wxWidgets bug #7491 (fix not ported to 2.8 branch) we
      // should never write the primary selection. We can enable this block
      // when we move to the 3.0 branch (or if a fixed 2.8 version is released
      // and we can do a runtime version check)
#if defined (__WXGTK__) && defined (HAVE_GTK)
      // On GTK, if we just dragged out a text selection, set the primary
      // selection
      if (mInitialCursorPos != mCurrentCursorPos) {
         wxTheClipboard->UsePrimarySelection(true);
         CopySelectedText();
         wxTheClipboard->UsePrimarySelection(false);
      }
#endif
#endif
 
      return;
   }
 
   if(evt.Dragging())
   {
      auto index = view.GetTextEditIndex(project);
      if (!mRightDragging && index != -1)
         // Update drag end
         view.SetCurrentCursorPosition(view.FindCursorPosition(index, evt.m_x ));
      return;
   }
 
   if (evt.RightUp())
   {
      auto index = view.GetTextEditIndex(project);
      if(index != -1 &&
         LabelTrackView::OverTextBox(pTrack->GetLabel(index), evt.m_x, evt.m_y)) 
      {
         // popup menu for editing
         // TODO: handle context menus via CellularPanel?
         view.ShowContextMenu( project );
      }
   }
 
   return;
}

References LabelTrackView::Get(), mpLT, mRightDragging, LabelTrackView::OverTextBox(), and project.

Referenced by Drag(), and Release().

Here is the call graph for this function:

Here is the caller graph for this function:

HitPreview()

HitTestPreview LabelTextHandle::HitPreview ( )

staticprivate

Definition at line 42 of file LabelTextHandle.cpp.

{
   static auto ibeamCursor =
      ::MakeCursor(wxCURSOR_IBEAM, IBeamCursorXpm, 17, 16);
   return {
      XO("Click to edit label text"),
      ibeamCursor.get()
   };
}

References MakeCursor(), and XO().

Referenced by Preview().

Here is the call graph for this function:

Here is the caller graph for this function:

HitTest()

UIHandlePtr LabelTextHandle::HitTest ( std::weak_ptr< LabelTextHandle > &  holder, const wxMouseState &  state, const std::shared_ptr< LabelTrack > &  pLT  )

static

Definition at line 52 of file LabelTextHandle.cpp.

{
   // If Control is down, let the select handle be hit instead
   int labelNum;
   if (!state.ControlDown() &&
       (labelNum =
          LabelTrackView::OverATextBox(*pLT, state.m_x, state.m_y) ) >= 0) {
      auto result = std::make_shared<LabelTextHandle>( pLT, labelNum );
      result = AssignUIHandlePtr(holder, result);
      return result;
   }
 
   return {};
}

References AssignUIHandlePtr(), and LabelTrackView::OverATextBox().

Referenced by LabelTrackView::DetailedHitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

LabelTextHandle & LabelTextHandle::operator= ( const LabelTextHandle &  )

default

Preview()

HitTestPreview LabelTextHandle::Preview ( const TrackPanelMouseState &  state, AudacityProject *  pProject  )

overridevirtual

Implements UIHandle.

Definition at line 259 of file LabelTextHandle.cpp.

{
   return HitPreview();
}

References HitPreview().

Here is the call graph for this function:

Release()

UIHandle::Result LabelTextHandle::Release ( const TrackPanelMouseEvent &  event, AudacityProject *  pProject, wxWindow *  pParent  )

overridevirtual

Reimplemented from LabelDefaultClickHandle.

Definition at line 265 of file LabelTextHandle.cpp.

{
   auto result = LabelDefaultClickHandle::Release( evt, pProject, pParent );
 
   // Only selected a part of a text string and changed track selectedness.
   // No undoable effects.
 
   const wxMouseEvent &event = evt.event;
   auto pLT = TrackList::Get( *pProject ).Lock(mpLT);
   if (pLT)
      HandleTextDragRelease( *pProject, event );
 
   // handle mouse left button up
   if (event.LeftUp())
      mLabelTrackStartXPos = -1;
 
   return result | RefreshCode::RefreshNone;
}

References TrackPanelMouseEvent::event, TrackList::Get(), HandleTextDragRelease(), TrackList::Lock(), mLabelTrackStartXPos, mpLT, RefreshCode::RefreshNone, and LabelDefaultClickHandle::Release().

Here is the call graph for this function:

Member Data Documentation

mLabelNum

int LabelTextHandle::mLabelNum { -1 }

private

Definition at line 67 of file LabelTextHandle.h.

Referenced by GetLabelNum().

mLabelTrackStartXPos

int LabelTextHandle::mLabelTrackStartXPos { -1 }

private

Definition at line 68 of file LabelTextHandle.h.

Referenced by Drag(), and Release().

mLabelTrackStartYPos

int LabelTextHandle::mLabelTrackStartYPos { -1 }

private

Definition at line 69 of file LabelTextHandle.h.

Referenced by Drag().

mpLT

std::weak_ptr<LabelTrack> LabelTextHandle::mpLT {}

private

Definition at line 66 of file LabelTextHandle.h.

Referenced by Click(), Drag(), FindTrack(), HandleTextClick(), HandleTextDragRelease(), and Release().

mRightDragging

bool LabelTextHandle::mRightDragging { false }

private

flag to tell if it's a valid dragging

Definition at line 72 of file LabelTextHandle.h.

Referenced by HandleTextClick(), and HandleTextDragRelease().

---

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

• LabelTextHandle.h
• LabelTextHandle.cpp