Short-lived drawing and event-handling object associated with a TrackPanelCell. More...

#include <UIHandle.h>

Inheritance diagram for UIHandle:

Collaboration diagram for UIHandle:

Public Types
using	Result = unsigned

using	Cell = TrackPanelCell

Public Member Functions
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 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
Result	mChangeHighlight { 0 }

Detailed Description

Short-lived drawing and event-handling object associated with a TrackPanelCell.

Definition at line 36 of file UIHandle.h.

Member Typedef Documentation

◆ Cell

using UIHandle::Cell = TrackPanelCell

Definition at line 43 of file UIHandle.h.

◆ Result

using UIHandle::Result = unsigned

Definition at line 40 of file UIHandle.h.

Constructor & Destructor Documentation

◆ ~UIHandle()

UIHandle::~UIHandle ( )

pure virtual

Definition at line 15 of file UIHandle.cpp.

16{

17}

Member Function Documentation

◆ Cancel()

virtual Result UIHandle::Cancel ( AudacityProject * pProject )

pure virtual

◆ Click()

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

pure virtual

◆ Drag()

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

pure virtual

◆ Enter()

void UIHandle::Enter	(	bool	forward,
		AudacityProject *	pProject
	)

virtual

Reimplemented in ButtonHandle, LabelGlyphHandle, LabelTextHandle, NoteTrackButtonHandle, NoteTrackVZoomHandle, CutlineHandle, SampleHandle, SpectrumVZoomHandle, WaveformVZoomHandle, TimeTrackVZoomHandle, EnvelopeHandle, SliderHandle, TimeShiftHandle, HighlitClipButtonHandle, AffordanceHandle, BrushHandle, SelectHandle, AdornedRulerPanel::CommonRulerHandle, and anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle.

Definition at line 19 of file UIHandle.cpp.

20{

21}

◆ Escape()

bool UIHandle::Escape ( AudacityProject * pProject )

virtual

Reimplemented in AdornedRulerPanel::PlayRegionAdjustingHandle, BrushHandle, and SelectHandle.

Definition at line 38 of file UIHandle.cpp.

{
   return false;
}

◆ FindTrack()

virtual std::shared_ptr< const Track > UIHandle::FindTrack ( ) const

pure virtual

Returns: pointer to associated track, if any

Implemented in AdornedRulerPanel::CommonRulerHandle, anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle, anonymous_namespace{CellularPanel.cpp}::DefaultRightButtonHandler, TrackPanelResizeHandle, LabelGlyphHandle, LabelTextHandle, NoteTrackButtonHandle, NoteTrackVZoomHandle, StretchHandle, CutlineHandle, HighlitClipButtonHandle, SampleHandle, SpectrumVZoomHandle, SubViewAdjustHandle, SubViewRearrangeHandle, WaveClipAdjustBorderHandle, WaveformVZoomHandle, WaveClipTitleEditHandle, TimeTrackVZoomHandle, BackgroundHandle, BrushHandle, ButtonHandle, EnvelopeHandle, SelectHandle, SliderHandle, TimeShiftHandle, TrackSelectHandle, and ZoomHandle.

Referenced by CommonTrackInfo::DrawCloseButton().

Here is the caller graph for this function:

◆ GetChangeHighlight()

Result UIHandle::GetChangeHighlight ( ) const

inline

Definition at line 131 of file UIHandle.h.

131{ return mChangeHighlight; }

UIHandle::mChangeHighlight

Result mChangeHighlight

Definition: UIHandle.h:152

◆ HandlesRightClick()

bool UIHandle::HandlesRightClick ( )

virtual

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 in AdornedRulerPanel::CommonRulerHandle, LabelTextHandle, NoteTrackVZoomHandle, CutlineHandle, SpectrumVZoomHandle, WaveformVZoomHandle, WaveTrackAffordanceHandle, TimeTrackVZoomHandle, and ZoomHandle.

Definition at line 43 of file UIHandle.cpp.

{
   return false;
}

◆ HasEscape()

bool UIHandle::HasEscape ( AudacityProject * pProject ) const

virtual

Reimplemented in AdornedRulerPanel::PlayRegionAdjustingHandle, and SelectHandle.

Definition at line 33 of file UIHandle.cpp.

{
   return false;
}

◆ HasRotation()

bool UIHandle::HasRotation ( ) const

virtual

Definition at line 23 of file UIHandle.cpp.

{
   return false;
}

◆ IsDragging()

bool UIHandle::IsDragging ( ) const

virtual

Whether the handle is dragging, affecting other panel painting; default returns false

Reimplemented in BrushHandle, ButtonHandle, SelectHandle, and SliderHandle.

Definition at line 57 of file UIHandle.cpp.

{
   return false;
}

Referenced by CommonTrackInfo::DrawCloseButton().

Here is the caller graph for this function:

◆ NeedChangeHighlight()

static UIHandle::Result UIHandle::NeedChangeHighlight	(	const UIHandle &	,
		const UIHandle &
	)

inlinestatic

Definition at line 138 of file UIHandle.h.

   {
      return 0;
   }

◆ OnProjectChange()

void UIHandle::OnProjectChange ( AudacityProject * pProject )

virtual

Definition at line 53 of file UIHandle.cpp.

54{

55}

◆ Preview()

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

pure virtual

◆ Release()

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

pure virtual

◆ Rotate()

bool UIHandle::Rotate ( bool forward )

virtual

Definition at line 28 of file UIHandle.cpp.

{
   return false;
}

◆ SetChangeHighlight()

void UIHandle::SetChangeHighlight ( Result val )

inline

Definition at line 132 of file UIHandle.h.

132{ mChangeHighlight = val; }

Referenced by AffordanceHandle::Enter().

Here is the caller graph for this function:

◆ StopsOnKeystroke()

bool UIHandle::StopsOnKeystroke ( )

virtual

Reimplemented in LabelGlyphHandle, VelocitySliderHandle, StretchHandle, MuteButtonHandle, SoloButtonHandle, EffectsButtonHandle, CutlineHandle, SampleHandle, VolumeSliderHandle, PanSliderHandle, EnvelopeHandle, TimeShiftHandle, CloseButtonHandle, and TrackSelectHandle.

Definition at line 48 of file UIHandle.cpp.

{
   return false;
}

◆ TrackFromChannel()

std::shared_ptr< const Track > UIHandle::TrackFromChannel ( const std::shared_ptr< const Channel > & pChannel )

static

A frequent convenience in the definition of UIHandles.

Definition at line 63 of file UIHandle.cpp.

{
   return pChannel
      ? static_cast<const Track &>(pChannel->GetChannelGroup())
         .shared_from_this()
      : nullptr;
}

Referenced by TrackPanelResizeHandle::FindTrack(), SampleHandle::FindTrack(), SpectrumVZoomHandle::FindTrack(), SubViewAdjustHandle::FindTrack(), SubViewRearrangeHandle::FindTrack(), WaveformVZoomHandle::FindTrack(), BrushHandle::FindTrack(), EnvelopeHandle::FindTrack(), and SelectHandle::FindTrack().

Here is the caller graph for this function:

Member Data Documentation

◆ mChangeHighlight

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Cell

◆ Result

Constructor & Destructor Documentation

◆ ~UIHandle()

Member Function Documentation

◆ Cancel()

◆ Click()

◆ Drag()

◆ Enter()

◆ Escape()

◆ FindTrack()

◆ GetChangeHighlight()

◆ HandlesRightClick()

◆ HasEscape()

◆ HasRotation()

◆ IsDragging()

◆ NeedChangeHighlight()

◆ OnProjectChange()

◆ Preview()

◆ Release()

◆ Rotate()

◆ SetChangeHighlight()

◆ StopsOnKeystroke()

◆ TrackFromChannel()

Member Data Documentation

◆ mChangeHighlight