VolumeSliderHandle Class Reference

#include <WaveTrackSliderHandles.h>

Inheritance diagram for VolumeSliderHandle:

Collaboration diagram for VolumeSliderHandle:

Public Member Functions
	VolumeSliderHandle (SliderFn sliderFn, const wxRect &rect, const std::shared_ptr< Track > &pTrack)
VolumeSliderHandle &	operator= (const VolumeSliderHandle &)=default
virtual	~VolumeSliderHandle ()
Public Member Functions inherited from SliderHandle
	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)

Static Public Member Functions
static UIHandlePtr	HitTest (std::weak_ptr< VolumeSliderHandle > &holder, const wxMouseState &state, const wxRect &rect, const std::shared_ptr< Track > &pTrack)
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 Member Functions
float	GetValue () override
Result	SetValue (AudacityProject *pProject, float newValue) override
Result	CommitChanges (const wxMouseEvent &event, AudacityProject *pProject) override
TranslatableString	Tip (const wxMouseState &state, AudacityProject &) const override
bool	StopsOnKeystroke () override
Protected Member Functions inherited from SliderHandle
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)

Private Member Functions
	VolumeSliderHandle (const VolumeSliderHandle &)=delete
std::shared_ptr< WaveTrack >	GetWaveTrack () const

Additional Inherited Members
Public Types inherited from SliderHandle
using	SliderFn = LWSlider *(*)(AudacityProject *, const wxRect &, Track *)
Public Types inherited from UIHandle
using	Result = unsigned
using	Cell = TrackPanelCell
Protected Attributes inherited from SliderHandle
std::weak_ptr< Track >	mpTrack
wxRect	mRect {}
SliderFn	mSliderFn
float	mStartingValue {}
bool	mIsDragging {}
Protected Attributes inherited from UIHandle
Result	mChangeHighlight { 0 }

Detailed Description

Definition at line 19 of file WaveTrackSliderHandles.h.

Constructor & Destructor Documentation

VolumeSliderHandle() [1/2]

VolumeSliderHandle::VolumeSliderHandle ( const VolumeSliderHandle &  )

privatedelete

VolumeSliderHandle() [2/2]

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

explicit

Definition at line 23 of file WaveTrackSliderHandles.cpp.

   : SliderHandle{ sliderFn, rect, pTrack }
{}

~VolumeSliderHandle()

VolumeSliderHandle::~VolumeSliderHandle ( )

virtual

Definition at line 28 of file WaveTrackSliderHandles.cpp.

{
}

Member Function Documentation

CommitChanges()

UIHandle::Result VolumeSliderHandle::CommitChanges ( const wxMouseEvent &  event, AudacityProject *  pProject  )

overrideprotectedvirtual

Implements SliderHandle.

Definition at line 57 of file WaveTrackSliderHandles.cpp.

{
   ProjectHistory::Get( *pProject )
      .PushState(XO("Moved volume slider"), XO("Volume"), UndoPush::CONSOLIDATE);
   return RefreshCode::RefreshCell;
}

References CONSOLIDATE, ProjectHistory::Get(), ProjectHistory::PushState(), RefreshCode::RefreshCell, and XO().

Here is the call graph for this function:

GetValue()

float VolumeSliderHandle::GetValue ( )

overrideprotectedvirtual

Implements SliderHandle.

Definition at line 37 of file WaveTrackSliderHandles.cpp.

{
   if (GetWaveTrack())
      return GetWaveTrack()->GetVolume();
   else
      return 0;
}

References GetWaveTrack().

Here is the call graph for this function:

GetWaveTrack()

std::shared_ptr< WaveTrack > VolumeSliderHandle::GetWaveTrack ( ) const

private

Definition at line 32 of file WaveTrackSliderHandles.cpp.

{
   return std::static_pointer_cast<WaveTrack>(mpTrack.lock());
}

References SliderHandle::mpTrack.

Referenced by GetValue(), SetValue(), and Tip().

Here is the caller graph for this function:

HitTest()

UIHandlePtr VolumeSliderHandle::HitTest ( std::weak_ptr< VolumeSliderHandle > &  holder, const wxMouseState &  state, const wxRect &  rect, const std::shared_ptr< Track > &  pTrack  )

static

Definition at line 85 of file WaveTrackSliderHandles.cpp.

{
   if (!state.ButtonIsDown(wxMOUSE_BTN_LEFT))
      return {};
 
   wxRect sliderRect;
   WaveTrackControls::GetVolumeRect(rect, sliderRect);
   if ( CommonTrackInfo::HideTopItem( rect, sliderRect))
      return {};
   if (sliderRect.Contains(state.m_x, state.m_y)) {
      wxRect sliderRect2;
      WaveTrackControls::GetVolumeRect(rect, sliderRect2);
      auto sliderFn =
      []( AudacityProject *pProject, const wxRect &sliderRect, Track *pTrack ) {
         return WaveTrackControls::VolumeSlider
            (sliderRect, static_cast<WaveTrack*>( pTrack ), true,
             &TrackPanel::Get( *pProject ));
      };
      auto result =
         std::make_shared<VolumeSliderHandle>( sliderFn, sliderRect2, pTrack );
      result = AssignUIHandlePtr(holder, result);
 
      return result;
   }
   else
      return {};
}

References AssignUIHandlePtr(), TrackPanel::Get(), WaveTrackControls::GetVolumeRect(), CommonTrackInfo::HideTopItem(), and WaveTrackControls::VolumeSlider().

Referenced by WaveTrackControls::HitTest().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

VolumeSliderHandle & VolumeSliderHandle::operator= ( const VolumeSliderHandle &  )

default

SetValue()

UIHandle::Result VolumeSliderHandle::SetValue ( AudacityProject *  pProject, float  newValue  )

overrideprotectedvirtual

Implements SliderHandle.

Definition at line 45 of file WaveTrackSliderHandles.cpp.

{
   (void)pProject;//Compiler food
   auto pTrack = GetWaveTrack();
 
   if (pTrack)
      pTrack->SetVolume(newValue);
 
   return RefreshCode::RefreshNone;
}

References GetWaveTrack(), and RefreshCode::RefreshNone.

Here is the call graph for this function:

StopsOnKeystroke()

bool VolumeSliderHandle::StopsOnKeystroke ( )

inlineoverrideprotectedvirtual

Reimplemented from UIHandle.

Definition at line 44 of file WaveTrackSliderHandles.h.

{ return true; }

Tip()

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

overrideprotectedvirtual

Implements SliderHandle.

Definition at line 65 of file WaveTrackSliderHandles.cpp.

{
   TranslatableString val;
   float value = 0;
 
   auto pTrack = GetWaveTrack();
   if (pTrack)
      value = pTrack->GetVolume();
 
   // LLL: Can't access the slider since Tip() is a const method and getting the slider
   //      is not, so duplicate what LWSlider does.
 
   /* i18n-hint dB abbreviates decibels */
   val = XO("%+.1f dB").Format(LINEAR_TO_DB(value));
 
   /* i18n-hint: An item name followed by a value, with appropriate separating punctuation */
   return XO("%s: %s").Format(XO("Volume"), val);
}

References GetWaveTrack(), LINEAR_TO_DB, and XO().

Here is the call graph for this function:

---

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

• WaveTrackSliderHandles.h
• WaveTrackSliderHandles.cpp