SliderHandle Class Reference

#include <SliderHandle.h>

Inheritance diagram for SliderHandle:

Collaboration diagram for SliderHandle:

Public Types
using	SliderFn = LWSlider *(*)(AudacityProject *, const wxRect &, Track *)
Public Types inherited from UIHandle
using	Result = unsigned
using	Cell = TrackPanelCell

Public Member Functions
	SliderHandle (SliderFn sliderFn, const wxRect &rect, const std::shared_ptr< Track > &pTrack)
SliderHandle &	operator= (const SliderHandle &)=default
std::shared_ptr< const Track >	FindTrack () const override
std::shared_ptr< Track >	GetTrack () const
bool	IsDragging () const 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)

Protected Member Functions
virtual	~SliderHandle ()
virtual float	GetValue ()=0
virtual Result	SetValue (AudacityProject *pProject, float newValue)=0
virtual Result	CommitChanges (const wxMouseEvent &event, AudacityProject *pProject)=0
virtual TranslatableString	Tip (const wxMouseState &state, AudacityProject &project) const =0
void	Enter (bool forward, AudacityProject *) override
Result	Click (const TrackPanelMouseEvent &event, AudacityProject *pProject) final override
Result	Drag (const TrackPanelMouseEvent &event, AudacityProject *pProject) final override
HitTestPreview	Preview (const TrackPanelMouseState &state, AudacityProject *pProject) final override
Result	Release (const TrackPanelMouseEvent &event, AudacityProject *pProject, wxWindow *pParent) final override
Result	Cancel (AudacityProject *pProject) final override
LWSlider *	GetSlider (AudacityProject *pProject)

Protected Attributes
std::weak_ptr< Track >	mpTrack
wxRect	mRect {}
SliderFn	mSliderFn
float	mStartingValue {}
bool	mIsDragging {}
Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Private Member Functions
	SliderHandle (const SliderHandle &)=delete

Additional Inherited Members
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)

Detailed Description

Definition at line 22 of file SliderHandle.h.

Member Typedef Documentation

SliderFn

using SliderHandle::SliderFn = LWSlider *(*)( AudacityProject*, const wxRect&, Track* )

Definition at line 27 of file SliderHandle.h.

Constructor & Destructor Documentation

SliderHandle() [1/2]

SliderHandle::SliderHandle ( const SliderHandle &  )

privatedelete

SliderHandle() [2/2]

SliderHandle::SliderHandle ( SliderFn  sliderFn, const wxRect &  rect, const std::shared_ptr< Track > &  pTrack  )

explicit

Definition at line 20 of file SliderHandle.cpp.

   : mpTrack{ pTrack }
   , mRect{ rect }
   , mSliderFn{ sliderFn }
{
}

~SliderHandle()

SliderHandle::~SliderHandle ( )

protectedvirtual

Definition at line 33 of file SliderHandle.cpp.

{
}

Member Function Documentation

Cancel()

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

finaloverrideprotectedvirtual

Implements UIHandle.

Definition at line 115 of file SliderHandle.cpp.

{
   wxMouseEvent event(wxEVT_LEFT_UP);
   GetSlider( pProject )->OnMouseEvent(event);
 
   // Undo un-committed changes to project data:
   auto result = SetValue(pProject, mStartingValue);
   mpTrack.reset();
   return RefreshCode::RefreshCell | result;
}

References GetSlider(), mpTrack, mStartingValue, LWSlider::OnMouseEvent(), RefreshCode::RefreshCell, and SetValue().

Here is the call graph for this function:

Click()

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

finaloverrideprotectedvirtual

Implements UIHandle.

Definition at line 47 of file SliderHandle.cpp.

{
   wxMouseEvent &event = evt.event;
   using namespace RefreshCode;
   if (!event.Button(wxMOUSE_BTN_LEFT))
      return Cancelled;
 
   // Come here for left click or double click
   mStartingValue = GetValue();
   auto slider = GetSlider( pProject );
   slider->OnMouseEvent(event);
   const float newValue = slider->Get();
 
   // Make a non-permanent change to the project data:
   auto result = SetValue(pProject, newValue);
 
   if (event.ButtonDClick())
      // Just did a modal dialog in OnMouseEvent
      // Do not start a drag
      return result | RefreshCell | Cancelled;
   else {
      mIsDragging = true;
      return result | RefreshCell;
   }
}

References Cancelled, TrackPanelMouseEvent::event, GetSlider(), GetValue(), mIsDragging, mStartingValue, RefreshCode::RefreshCell, and SetValue().

Here is the call graph for this function:

CommitChanges()

virtual Result SliderHandle::CommitChanges ( const wxMouseEvent &  event, AudacityProject *  pProject  )

protectedpure virtual

Implemented in VelocitySliderHandle, VolumeSliderHandle, and PanSliderHandle.

Referenced by Release().

Here is the caller graph for this function:

Drag()

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

finaloverrideprotectedvirtual

Implements UIHandle.

Definition at line 74 of file SliderHandle.cpp.

{
   wxMouseEvent &event = evt.event;
   using namespace RefreshCode;
   GetSlider( pProject )->OnMouseEvent(event);
   const float newValue = GetSlider( pProject )->Get();
 
   // Make a non-permanent change to the project data:
   return RefreshCell | SetValue(pProject, newValue);
}

References TrackPanelMouseEvent::event, LWSlider::Get(), GetSlider(), LWSlider::OnMouseEvent(), RefreshCode::RefreshCell, and SetValue().

Here is the call graph for this function:

Enter()

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

overrideprotectedvirtual

Reimplemented from UIHandle.

Definition at line 28 of file SliderHandle.cpp.

{
   mChangeHighlight = RefreshCode::RefreshCell;
}

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

FindTrack()

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

overridevirtual

Returns

pointer to associated track, if any

Implements UIHandle.

Definition at line 37 of file SliderHandle.cpp.

{
   return mpTrack.lock();
}

References mpTrack.

GetSlider()

LWSlider * SliderHandle::GetSlider ( AudacityProject *  pProject )

protected

Definition at line 126 of file SliderHandle.cpp.

{
   auto pTrack = TrackList::Get( *pProject ).Lock(mpTrack);
   return mSliderFn( pProject, mRect, pTrack.get() );
}

References TrackList::Get(), TrackList::Lock(), mpTrack, mRect, and mSliderFn.

Referenced by Cancel(), Click(), Drag(), and Release().

Here is the call graph for this function:

Here is the caller graph for this function:

GetTrack()

std::shared_ptr< Track > SliderHandle::GetTrack ( ) const

inline

Definition at line 36 of file SliderHandle.h.

{ return mpTrack.lock(); }

Referenced by anonymous_namespace{NoteTrackControls.cpp}::VelocitySliderDrawFunction().

Here is the caller graph for this function:

GetValue()

virtual float SliderHandle::GetValue ( )

protectedpure virtual

Implemented in VelocitySliderHandle, VolumeSliderHandle, and PanSliderHandle.

Referenced by Click().

Here is the caller graph for this function:

IsDragging()

bool SliderHandle::IsDragging ( ) const

overridevirtual

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

Reimplemented from UIHandle.

Definition at line 42 of file SliderHandle.cpp.

{
   return mIsDragging;
}

References mIsDragging.

operator=()

SliderHandle & SliderHandle::operator= ( const SliderHandle &  )

default

Preview()

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

finaloverrideprotectedvirtual

Implements UIHandle.

Definition at line 86 of file SliderHandle.cpp.

{
   // No special cursor
   TranslatableString message;
   if (project)
      message = Tip(st.state, *project);
   return { message, {}, message };
}

References project, TrackPanelMouseState::state, and Tip().

Here is the call graph for this function:

Release()

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

finaloverrideprotectedvirtual

Implements UIHandle.

Definition at line 96 of file SliderHandle.cpp.

{
   using namespace RefreshCode;
   wxMouseEvent &event = evt.event;
   GetSlider( pProject )->OnMouseEvent(event);
   const float newValue = GetSlider( pProject )->Get();
 
   Result result = RefreshCell;
 
   // Commit changes to the project data:
   result |= SetValue(pProject, newValue);
   result |= CommitChanges(event, pProject);
 
   mpTrack.reset();
   return result;
}

References CommitChanges(), TrackPanelMouseEvent::event, LWSlider::Get(), GetSlider(), mpTrack, LWSlider::OnMouseEvent(), RefreshCode::RefreshCell, and SetValue().

Here is the call graph for this function:

SetValue()

virtual Result SliderHandle::SetValue ( AudacityProject *  pProject, float  newValue  )

protectedpure virtual

Implemented in VelocitySliderHandle, VolumeSliderHandle, and PanSliderHandle.

Referenced by Cancel(), Click(), Drag(), and Release().

Here is the caller graph for this function:

Tip()

virtual TranslatableString SliderHandle::Tip ( const wxMouseState &  state, AudacityProject &  project  ) const

protectedpure virtual

Implemented in VelocitySliderHandle, VolumeSliderHandle, and PanSliderHandle.

Referenced by Preview().

Here is the caller graph for this function:

Member Data Documentation

mIsDragging

bool SliderHandle::mIsDragging {}

protected

Definition at line 83 of file SliderHandle.h.

Referenced by Click(), and IsDragging().

mpTrack

std::weak_ptr<Track> SliderHandle::mpTrack

protected

Definition at line 76 of file SliderHandle.h.

Referenced by Cancel(), FindTrack(), VelocitySliderHandle::GetNoteTrack(), GetSlider(), VolumeSliderHandle::GetWaveTrack(), PanSliderHandle::GetWaveTrack(), and Release().

mRect

wxRect SliderHandle::mRect {}

protected

Definition at line 77 of file SliderHandle.h.

Referenced by GetSlider().

mSliderFn

SliderFn SliderHandle::mSliderFn

protected

Definition at line 78 of file SliderHandle.h.

Referenced by GetSlider().

mStartingValue

float SliderHandle::mStartingValue {}

protected

Definition at line 81 of file SliderHandle.h.

Referenced by Cancel(), and Click().

---

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

• SliderHandle.h
• SliderHandle.cpp