ASlider is a custom slider, allowing for a slicker look and feel. More...

#include <ASlider.h>

Inheritance diagram for ASlider:

Collaboration diagram for ASlider:

Classes
struct	Options

struct	Resetter

Public Member Functions
	ASlider (wxWindow *parent, wxWindowID id, const TranslatableString &name, const wxPoint &pos, const wxSize &size, const Options &options=Options{})

virtual	~ASlider ()

bool	AcceptsFocus () const override

bool	AcceptsFocusFromKeyboard () const override

void	SetFocusFromKbd () override

bool	SetBackgroundColour (const wxColour &colour) override

void	GetScroll (float &line, float &page)

void	SetScroll (float line, float page)

void	SetToolTipTemplate (const TranslatableString &tip)

float	Get (bool convert=true)

void	Set (float value)

void	Increase (float steps)

void	Decrease (float steps)

bool	ShowDialog (wxPoint pos=wxPoint(-1, -1))

void	SetSpeed (float speed)

void	OnErase (wxEraseEvent &event)

void	OnPaint (wxPaintEvent &event)

void	OnSize (wxSizeEvent &event)

void	OnMouseEvent (wxMouseEvent &event)

void	OnCaptureLost (wxMouseCaptureLostEvent &event)

void	OnKeyDown (wxKeyEvent &event)

void	OnSlider (wxCommandEvent &event)

void	OnSetFocus (wxFocusEvent &event)

void	OnKillFocus (wxFocusEvent &event)

void	OnTimer (wxTimerEvent &event)

bool	Enable (bool enable=true) override

bool	IsEnabled () const

Static Public Member Functions
static TempAllowFocus	TemporarilyAllowFocus ()

Protected Attributes
int	mStyle

Private Types
using	TempAllowFocus = std::unique_ptr< bool, Resetter >

Private Attributes
std::unique_ptr< LWSlider >	mLWSlider

bool	mSliderIsFocused

wxTimer	mTimer

Static Private Attributes
static bool	s_AcceptsFocus { false }

Friends
class	ASliderAx

Detailed Description

ASlider is a custom slider, allowing for a slicker look and feel.

It allows you to use images for the slider background and the thumb.

Definition at line 259 of file ASlider.h.

Member Typedef Documentation

◆ TempAllowFocus

using ASlider::TempAllowFocus = std::unique_ptr<bool, Resetter>

private

Definition at line 342 of file ASlider.h.

Constructor & Destructor Documentation

◆ ASlider()

ASlider::ASlider	(	wxWindow *	parent,
		wxWindowID	id,
		const TranslatableString &	name,
		const wxPoint &	pos,
		const wxSize &	size,
		const Options &	options = `Options{}`
	)

Definition at line 1683 of file ASlider.cpp.

: wxPanel( parent, id, pos, size, wxWANTS_CHARS )
{
   //wxColour Col(parent->GetBackgroundColour());
   //SetBackgroundColour( Col );
   SetBackgroundColour( theTheme.Colour( clrMedium ) );
   mLWSlider = std::make_unique<LWSlider>( this,
                             name,
                             wxPoint(0,0),
                             size,
                             options.style,
                             options.showLabels,
                             options.drawTicks,
                             options.drawTrack,
                             options.alwaysHideTip,
                             true, // ASlider is always a heavyweight LWSlider
                             options.popup,
                             options.orientation);
   mLWSlider->mStepValue = options.stepValue;
   mLWSlider->SetId( id );
   SetName( name.Translation() );
 
   mSliderIsFocused = false;
   mStyle = options.style;
 
   mTimer.SetOwner(this);
 
#if wxUSE_ACCESSIBILITY
   SetAccessible( safenew ASliderAx( this ) );
#endif
 
   mLWSlider->SetScroll( options.line, options.page );
}

References ThemeBase::Colour(), name, safenew, size, theTheme, and TranslatableString::Translation().

Here is the call graph for this function:

◆ ~ASlider()

ASlider::~ASlider ( )

virtual

Definition at line 1723 of file ASlider.cpp.

{
   if(HasCapture())
      ReleaseMouse();
}

Member Function Documentation

◆ AcceptsFocus()

bool ASlider::AcceptsFocus ( ) const

inlineoverride

Definition at line 303 of file ASlider.h.

303{ return s_AcceptsFocus; }

ASlider::s_AcceptsFocus

static bool s_AcceptsFocus

Definition: ASlider.h:340

◆ AcceptsFocusFromKeyboard()

bool ASlider::AcceptsFocusFromKeyboard ( ) const

inlineoverride

Definition at line 304 of file ASlider.h.

304{ return true; }

◆ Decrease()

void ASlider::Decrease ( float steps )

Definition at line 1860 of file ASlider.cpp.

{
   mLWSlider->Decrease(steps);
}

References mLWSlider.

Referenced by TranscriptionToolBar::AdjustPlaySpeed().

Here is the caller graph for this function:

◆ Enable()

bool ASlider::Enable ( bool enable = true )

override

Definition at line 1875 of file ASlider.cpp.

{
   if (mLWSlider->GetEnabled() == enable)
      return false;
 
   mLWSlider->SetEnabled(enable);
 
   wxWindow::Enable(enable);
 
   return true;
}

References mLWSlider.

◆ Get()

float ASlider::Get ( bool convert = true )

Definition at line 1845 of file ASlider.cpp.

{
   return mLWSlider->Get( convert );
}

References mLWSlider.

Referenced by TranscriptionToolBar::Create(), SliderDialog::Get(), MixerTrackCluster::HandleSliderGain(), MixerTrackCluster::HandleSliderPan(), TranscriptionToolBar::OnSpeedSlider(), and SliderDialog::TransferDataToWindow().

Here is the caller graph for this function:

◆ GetScroll()

void ASlider::GetScroll	(	float &	line,
		float &	page
	)

Definition at line 1830 of file ASlider.cpp.

{
   mLWSlider->GetScroll(line, page);
}

References mLWSlider.

◆ Increase()

void ASlider::Increase ( float steps )

Definition at line 1855 of file ASlider.cpp.

{
   mLWSlider->Increase(steps);
}

References mLWSlider.

Referenced by TranscriptionToolBar::AdjustPlaySpeed().

Here is the caller graph for this function:

◆ IsEnabled()

bool ASlider::IsEnabled ( ) const

Definition at line 1887 of file ASlider.cpp.

{
   return mLWSlider->GetEnabled();
}

References mLWSlider.

◆ OnCaptureLost()

void ASlider::OnCaptureLost ( wxMouseCaptureLostEvent & event )

Definition at line 1801 of file ASlider.cpp.

{
   wxMouseEvent e(wxEVT_LEFT_UP);
   mLWSlider->OnMouseEvent(e);
}

References mLWSlider.

◆ OnErase()

void ASlider::OnErase ( wxEraseEvent & event )

Definition at line 1762 of file ASlider.cpp.

{
   // Ignore it to prevent flashing
}

◆ OnKeyDown()

void ASlider::OnKeyDown ( wxKeyEvent & event )

Definition at line 1807 of file ASlider.cpp.

{
   mLWSlider->OnKeyDown(event);
}

References mLWSlider.

◆ OnKillFocus()

void ASlider::OnKillFocus ( wxFocusEvent & event )

Definition at line 1818 of file ASlider.cpp.

{
   mLWSlider->OnKillFocus();
   mSliderIsFocused = false;
   Refresh();
}

References mLWSlider, and mSliderIsFocused.

◆ OnMouseEvent()

void ASlider::OnMouseEvent ( wxMouseEvent & event )

Definition at line 1787 of file ASlider.cpp.

{
   if (event.Entering())
   {
      mTimer.StartOnce(1000);
   }
   else if (event.Leaving())
   {
      mTimer.Stop();
   }
 
   mLWSlider->OnMouseEvent(event);
}

References mLWSlider, and mTimer.

Referenced by MixerTrackSlider::OnMouseEvent().

Here is the caller graph for this function:

◆ OnPaint()

void ASlider::OnPaint ( wxPaintEvent & event )

Definition at line 1767 of file ASlider.cpp.

{
   wxBufferedPaintDC dc(this);
 
   bool highlighted =
      GetClientRect().Contains(
         ScreenToClient(
            ::wxGetMousePosition() ) );
   mLWSlider->OnPaint(dc, highlighted);
 
   if ( mSliderIsFocused )
   {
      wxRect r( 0, 0, mLWSlider->mWidth, mLWSlider->mHeight );
 
      r.Deflate( 1, 1 );
 
      AColor::DrawFocus( dc, r );
   }
}

References AColor::DrawFocus(), mLWSlider, and mSliderIsFocused.

Here is the call graph for this function:

◆ OnSetFocus()

void ASlider::OnSetFocus ( wxFocusEvent & event )

Definition at line 1812 of file ASlider.cpp.

{
   mSliderIsFocused = true;
   Refresh();
}

References mSliderIsFocused.

◆ OnSize()

void ASlider::OnSize ( wxSizeEvent & event )

Definition at line 1757 of file ASlider.cpp.

{
   mLWSlider->OnSize( event );
}

References mLWSlider.

◆ OnSlider()

void ASlider::OnSlider ( wxCommandEvent & event )

Definition at line 1741 of file ASlider.cpp.

{
 
   if ( event.GetId() == mLWSlider->GetId() )
   {
#if wxUSE_ACCESSIBILITY
      GetAccessible()->NotifyEvent( wxACC_EVENT_OBJECT_VALUECHANGE,
                                    this,
                                    wxOBJID_CLIENT,
                                    wxACC_SELF );
#endif
   }
 
   event.Skip();
}

References mLWSlider.

◆ OnTimer()

void ASlider::OnTimer ( wxTimerEvent & event )

Definition at line 1825 of file ASlider.cpp.

{
   mLWSlider->ShowTip(true);
}

References mLWSlider.

◆ Set()

void ASlider::Set ( float value )

Definition at line 1850 of file ASlider.cpp.

{
   mLWSlider->Set(value);
}

References mLWSlider.

Referenced by TranscriptionToolBar::Populate(), SliderDialog::TransferDataFromWindow(), and MixerTrackCluster::UpdateForStateChange().

Here is the caller graph for this function:

◆ SetBackgroundColour()

bool ASlider::SetBackgroundColour ( const wxColour & colour )

override

Definition at line 1729 of file ASlider.cpp.

{
   auto res = wxPanel::SetBackgroundColour(colour);
 
   if (res && mLWSlider)
   {
      mLWSlider->Redraw();
   }
 
   return res;
}

References mLWSlider.

Referenced by MixerTrackCluster::OnPaint().

Here is the caller graph for this function:

◆ SetFocusFromKbd()

void ASlider::SetFocusFromKbd ( )

override

Definition at line 1902 of file ASlider.cpp.

{
   auto temp = TemporarilyAllowFocus();
   SetFocus();
}

References BasicUI::SetFocus(), and TemporarilyAllowFocus().

Here is the call graph for this function:

◆ SetScroll()

void ASlider::SetScroll	(	float	line,
		float	page
	)

Definition at line 1835 of file ASlider.cpp.

{
   mLWSlider->SetScroll(line, page);
}

References mLWSlider.

◆ SetSpeed()

void ASlider::SetSpeed ( float speed )

Definition at line 1870 of file ASlider.cpp.

{
   mLWSlider->SetSpeed(speed);
}

References mLWSlider.

◆ SetToolTipTemplate()

void ASlider::SetToolTipTemplate ( const TranslatableString & tip )

Definition at line 1840 of file ASlider.cpp.

{
   mLWSlider->SetToolTipTemplate(tip);
}

References mLWSlider.

◆ ShowDialog()

bool ASlider::ShowDialog ( wxPoint pos = wxPoint(-1, -1) )

Definition at line 1865 of file ASlider.cpp.

{
   return mLWSlider->ShowDialog(pos);
}

References mLWSlider.

Referenced by TranscriptionToolBar::ShowPlaySpeedDialog().

Here is the caller graph for this function:

◆ TemporarilyAllowFocus()

auto ASlider::TemporarilyAllowFocus ( )

static

Definition at line 1894 of file ASlider.cpp.

                                                      {
   s_AcceptsFocus = true;
   return TempAllowFocus{ &s_AcceptsFocus };
}

Referenced by anonymous_namespace{NavigationMenus.cpp}::NextOrPrevFrame(), ToolManager::RestoreFocus(), and SetFocusFromKbd().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ ASliderAx

friend class ASliderAx

friend

Definition at line 261 of file ASlider.h.

Member Data Documentation

◆ mLWSlider

std::unique_ptr<LWSlider> ASlider::mLWSlider

private

Definition at line 348 of file ASlider.h.

Referenced by Decrease(), Enable(), Get(), GetScroll(), Increase(), IsEnabled(), OnCaptureLost(), OnKeyDown(), OnKillFocus(), OnMouseEvent(), OnPaint(), OnSize(), OnSlider(), OnTimer(), Set(), SetBackgroundColour(), SetScroll(), SetSpeed(), SetToolTipTemplate(), and ShowDialog().

◆ mSliderIsFocused

bool ASlider::mSliderIsFocused

private

Definition at line 349 of file ASlider.h.

Referenced by OnKillFocus(), OnPaint(), and OnSetFocus().

◆ mStyle

int ASlider::mStyle

protected

Definition at line 353 of file ASlider.h.

Referenced by MixerTrackSlider::OnMouseEvent().

◆ mTimer

wxTimer ASlider::mTimer

private

Definition at line 350 of file ASlider.h.

Referenced by OnMouseEvent().

◆ s_AcceptsFocus

bool ASlider::s_AcceptsFocus { false }

staticprivate

Definition at line 340 of file ASlider.h.

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

Classes

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Types

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ TempAllowFocus

Constructor & Destructor Documentation

◆ ASlider()

◆ ~ASlider()

Member Function Documentation

◆ AcceptsFocus()

◆ AcceptsFocusFromKeyboard()

◆ Decrease()

◆ Enable()

◆ Get()

◆ GetScroll()

◆ Increase()

◆ IsEnabled()

◆ OnCaptureLost()

◆ OnErase()

◆ OnKeyDown()

◆ OnKillFocus()

◆ OnMouseEvent()

◆ OnPaint()

◆ OnSetFocus()

◆ OnSize()

◆ OnSlider()

◆ OnTimer()

◆ Set()

◆ SetBackgroundColour()

◆ SetFocusFromKbd()

◆ SetScroll()

◆ SetSpeed()

◆ SetToolTipTemplate()

◆ ShowDialog()

◆ TemporarilyAllowFocus()

Friends And Related Function Documentation

◆ ASliderAx

Member Data Documentation

◆ mLWSlider

◆ mSliderIsFocused

◆ mStyle

◆ mTimer

◆ s_AcceptsFocus