LabelDefaultClickHandle Class Reference

#include <LabelDefaultClickHandle.h>

Inheritance diagram for LabelDefaultClickHandle:

Collaboration diagram for LabelDefaultClickHandle:

Classes
struct	LabelState

Public Member Functions
	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)

Private Member Functions
void	SaveState (AudacityProject *pProject)
void	RestoreState (AudacityProject *pProject)

Private Attributes
std::shared_ptr< LabelState >	mLabelState

Additional Inherited Members
Public Types inherited from UIHandle
using	Result = unsigned
using	Cell = TrackPanelCell
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)
Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 21 of file LabelDefaultClickHandle.h.

Constructor & Destructor Documentation

LabelDefaultClickHandle()

LabelDefaultClickHandle::LabelDefaultClickHandle

(

)

Definition at line 21 of file LabelDefaultClickHandle.cpp.

{
}

~LabelDefaultClickHandle()

LabelDefaultClickHandle::~LabelDefaultClickHandle ( )

virtual

Definition at line 25 of file LabelDefaultClickHandle.cpp.

{
}

Member Function Documentation

Cancel()

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

overridevirtual

Implements UIHandle.

Reimplemented in LabelGlyphHandle, and LabelTextHandle.

Definition at line 97 of file LabelDefaultClickHandle.cpp.

{
   UIHandle::Result result = RefreshCode::RefreshNone;
   RestoreState( pProject );
   return result;
}

References RefreshCode::RefreshNone, and RestoreState().

Referenced by LabelGlyphHandle::Cancel(), and LabelTextHandle::Cancel().

Here is the call graph for this function:

Here is the caller graph for this function:

Click()

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

overridevirtual

Implements UIHandle.

Reimplemented in LabelGlyphHandle, and LabelTextHandle.

Definition at line 60 of file LabelDefaultClickHandle.cpp.

{
   using namespace RefreshCode;
   // Redraw to show the change of text box selection status
   UIHandle::Result result = RefreshAll;
 
   if (evt.event.LeftDown())
   {
      SaveState( pProject );
 
      const auto pLT = evt.pCell.get();
      for (auto lt : TrackList::Get(*pProject).Any<LabelTrack>()) {
         if (pLT != &ChannelView::Get(*lt)) {
            auto &view = LabelTrackView::Get( *lt );
            view.ResetFlags();
         }
      }
   }
 
   return result;
}

References TrackList::Any(), TrackPanelMouseEvent::event, TrackList::Get(), ChannelView::Get(), LabelTrackView::Get(), TrackPanelMouseEvent::pCell, RefreshCode::RefreshAll, and SaveState().

Referenced by LabelGlyphHandle::Click(), and LabelTextHandle::Click().

Here is the call graph for this function:

Here is the caller graph for this function:

Drag()

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

overridevirtual

Implements UIHandle.

Reimplemented in LabelGlyphHandle, and LabelTextHandle.

Definition at line 83 of file LabelDefaultClickHandle.cpp.

{
   return RefreshCode::RefreshNone;
}

References RefreshCode::RefreshNone.

Referenced by LabelGlyphHandle::Drag(), and LabelTextHandle::Drag().

Here is the caller graph for this function:

operator=()

LabelDefaultClickHandle & LabelDefaultClickHandle::operator= ( const LabelDefaultClickHandle &  )

default

Release()

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

overridevirtual

Implements UIHandle.

Reimplemented in LabelGlyphHandle, and LabelTextHandle.

Definition at line 89 of file LabelDefaultClickHandle.cpp.

{
   mLabelState.reset();
   return RefreshCode::RefreshNone;
}

References mLabelState, and RefreshCode::RefreshNone.

Referenced by LabelGlyphHandle::Release(), and LabelTextHandle::Release().

Here is the caller graph for this function:

RestoreState()

void LabelDefaultClickHandle::RestoreState ( AudacityProject *  pProject )

private

Definition at line 48 of file LabelDefaultClickHandle.cpp.

{
   if ( mLabelState ) {
      for ( const auto &pair : mLabelState->mPairs )
         if (auto pLt = TrackList::Get( *pProject ).Lock(pair.first)) {
            auto &view = LabelTrackView::Get( *pLt );
            view.RestoreFlags( pair.second );
         }
      mLabelState.reset();
   }
}

References TrackList::Get(), LabelTrackView::Get(), TrackList::Lock(), and mLabelState.

Referenced by Cancel().

Here is the call graph for this function:

Here is the caller graph for this function:

SaveState()

void LabelDefaultClickHandle::SaveState ( AudacityProject *  pProject )

private

Definition at line 35 of file LabelDefaultClickHandle.cpp.

{
   mLabelState = std::make_shared<LabelState>();
   auto &pairs = mLabelState->mPairs;
   auto &tracks = TrackList::Get( *pProject );
 
   for (auto lt : tracks.Any<LabelTrack>()) {
      auto &view = LabelTrackView::Get( *lt );
      pairs.push_back( std::make_pair(
         lt->SharedPointer<LabelTrack>(), view.SaveFlags() ) );
   }
}

References TrackList::Get(), LabelTrackView::Get(), mLabelState, and tracks.

Referenced by Click().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mLabelState

std::shared_ptr< LabelState > LabelDefaultClickHandle::mLabelState

private

Definition at line 46 of file LabelDefaultClickHandle.h.

Referenced by Release(), RestoreState(), and SaveState().

---

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

• LabelDefaultClickHandle.h
• LabelDefaultClickHandle.cpp