UIHandle Class Reference

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 Channel >	FindChannel () 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 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 35 of file UIHandle.h.

Member Typedef Documentation

Cell

using UIHandle::Cell = TrackPanelCell

Definition at line 42 of file UIHandle.h.

Result

using UIHandle::Result = unsigned

Definition at line 39 of file UIHandle.h.

Constructor & Destructor Documentation

~UIHandle()

UIHandle::~UIHandle ( )

pure virtual

Definition at line 16 of file UIHandle.cpp.

{
}

Member Function Documentation

Cancel()

virtual Result UIHandle::Cancel ( AudacityProject *  pProject )

pure virtual

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

Click()

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

pure virtual

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

Drag()

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

pure virtual

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

Enter()

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

virtual

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

Definition at line 20 of file UIHandle.cpp.

{
}

Escape()

bool UIHandle::Escape ( AudacityProject *  pProject )

virtual

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

Definition at line 39 of file UIHandle.cpp.

{
   return false;
}

FindChannel()

virtual std::shared_ptr< const Channel > UIHandle::FindChannel ( ) const

pure virtual

Returns

pointer to associated channel, if any

Implemented in AdornedRulerPanel::CommonRulerHandle, anonymous_namespace{AdornedRulerPanel.cpp}::PlayheadHandle, anonymous_namespace{CellularPanel.cpp}::DefaultRightButtonHandler, TrackPanelResizeHandle, LabelGlyphHandle, LabelTextHandle, NoteTrackButtonHandle, NoteTrackVZoomHandle, StretchHandle, CutlineHandle, 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 130 of file UIHandle.h.

{ return mChangeHighlight; }

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 44 of file UIHandle.cpp.

{
   return false;
}

HasEscape()

bool UIHandle::HasEscape ( AudacityProject *  pProject ) const

virtual

Reimplemented in AdornedRulerPanel::PlayRegionAdjustingHandle, and SelectHandle.

Definition at line 34 of file UIHandle.cpp.

{
   return false;
}

HasRotation()

bool UIHandle::HasRotation ( ) const

virtual

Definition at line 24 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 58 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 137 of file UIHandle.h.

   {
      return 0;
   }

OnProjectChange()

void UIHandle::OnProjectChange ( AudacityProject *  pProject )

virtual

Definition at line 54 of file UIHandle.cpp.

{
}

Preview()

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

pure virtual

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

Release()

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

pure virtual

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

Rotate()

bool UIHandle::Rotate ( bool  forward )

virtual

Definition at line 29 of file UIHandle.cpp.

{
   return false;
}

SetChangeHighlight()

void UIHandle::SetChangeHighlight ( Result  val )

inline

Definition at line 131 of file UIHandle.h.

{ mChangeHighlight = val; }

Referenced by AffordanceHandle::Enter().

Here is the caller graph for this function:

StopsOnKeystroke()

bool UIHandle::StopsOnKeystroke ( )

virtual

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

Definition at line 49 of file UIHandle.cpp.

{
   return false;
}

Member Data Documentation

mChangeHighlight

Result UIHandle::mChangeHighlight { 0 }

protected

Definition at line 147 of file UIHandle.h.

Referenced by ButtonHandle::Enter(), LabelGlyphHandle::Enter(), LabelTextHandle::Enter(), NoteTrackButtonHandle::Enter(), NoteTrackVZoomHandle::Enter(), CutlineHandle::Enter(), SampleHandle::Enter(), SpectrumVZoomHandle::Enter(), WaveformVZoomHandle::Enter(), TimeTrackVZoomHandle::Enter(), EnvelopeHandle::Enter(), SliderHandle::Enter(), TimeShiftHandle::Enter(), AdornedRulerPanel::CommonRulerHandle::Enter(), SelectHandle::SetUseSnap(), and AdornedRulerPanel::PlayRegionAdjustingHandle::Unsnap().

---

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

• UIHandle.h
• UIHandle.cpp