#include <SpinControl.h>

Inheritance diagram for SpinControl:

Collaboration diagram for SpinControl:

Public Types
using	ValueType = double

Public Member Functions
	SpinControl (wxWindow *parent, wxWindowID winid=wxID_ANY, ValueType value=0.0, ValueType min=0.0f, ValueType max=100.0, ValueType step=1.0, bool allowFractional=false, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, const TranslatableString &name={})

void	SetValue (double value)

double	GetValue () const

void	SetMinValue (double value)

double	GetMinValue () const

void	SetMaxValue (double value)

double	GetMaxValue () const

void	SetStep (double step)

double	GetStep () const

void	SetFractionalAllowed (bool allow)

bool	GetFractionalAllowed ()

void	SetName (const TranslatableString &name)

Private Member Functions
void	UpdatePrefs () override

void	CreateUI ()

void	SetupControls ()

void	CommitTextControlValue ()

void	OnCharHook (wxKeyEvent &evt)

void	SetValue (double value, bool silent)

void	DoSteps (double direction)

void	NotifyValueChanged ()

Private Member Functions inherited from PrefsListener
	PrefsListener ()

virtual	~PrefsListener ()

virtual void	UpdatePrefs ()=0

virtual void	UpdateSelectedPrefs (int id)

Private Attributes
ValueType	mValue { std::numeric_limits<ValueType>::quiet_NaN() }

ValueType	mMinValue { -std::numeric_limits<ValueType>::infinity() }

ValueType	mMaxValue { std::numeric_limits<ValueType>::infinity() }

ValueType	mStep

int	mPrecision { 2 }

bool	mFractionalAllowed

wxTextCtrl *	mTextControl { nullptr }

wxButton *	mUpButton { nullptr }

wxButton *	mDownButton { nullptr }

Additional Inherited Members
Static Private Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Detailed Description

Definition at line 29 of file SpinControl.h.

Member Typedef Documentation

◆ ValueType

using SpinControl::ValueType = double

Definition at line 34 of file SpinControl.h.

Constructor & Destructor Documentation

◆ SpinControl()

SpinControl::SpinControl	(	wxWindow *	parent,
		wxWindowID	winid = `wxID_ANY`,
		ValueType	value = `0.0`,
		ValueType	min = `0.0f`,
		ValueType	max = `100.0`,
		ValueType	step = `1.0`,
		bool	allowFractional = `false`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		const TranslatableString &	name = `{}`
	)

Definition at line 63 of file SpinControl.cpp.

    : wxControl(parent, winid, pos, size, wxBORDER_NONE)
    , mStep(step)
    , mFractionalAllowed(allowFractional)
{
   CreateUI();
 
   // Call setter explicitly to ensure that all the clamping happens correctly
   SetMinValue(min);
   SetMaxValue(max);
   SetValue(value);
 
   SetupControls();
 
   SetName(name);
}

References CreateUI(), min(), name, SetMaxValue(), SetMinValue(), SetName(), SetupControls(), and SetValue().

Here is the call graph for this function:

Member Function Documentation

◆ CommitTextControlValue()

void SpinControl::CommitTextControlValue ( )

private

Definition at line 311 of file SpinControl.cpp.

{
   double value;
   if (!mTextControl->GetValue().ToDouble(&value))
      return;
 
   SetValue(value, false);
}

References mTextControl, and SetValue().

Referenced by CreateUI(), and OnCharHook().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateUI()

void SpinControl::CreateUI ( )

private

Definition at line 161 of file SpinControl.cpp.

{
   mTextControl = safenew wxTextCtrl(this, wxID_ANY);
#ifndef __WXGTK__
   const auto editorHeight = mTextControl->GetSize().y;
#else
   // GTK requires the buttons to be at least 16x16
   // TODO: rely on GTK_ICON_SIZE_BUTTON instead of hardcoding the size
   constexpr auto minGtkSize = 16;
   const auto editorHeight = std::max(minGtkSize * 2, mTextControl->GetSize().y);
#endif
 
   auto boxSizer = safenew wxBoxSizer(wxHORIZONTAL);
 
   boxSizer->Add(mTextControl, wxSizerFlags().Border(wxALL, 0));
 
#ifndef __WXGTK__
   mSpinButton = safenew wxSpinButton(this);
   mSpinButton->SetMaxSize({ -1, editorHeight });
 
   // SpinButton is only used to generate the events,
   // so keep the value between min (0 by default) and max (100 by default)
   mSpinButton->SetValue(50);
 
   boxSizer->Add(mSpinButton, wxSizerFlags().Border(wxALL, 0));
#else
   auto buttonsSizer = safenew wxBoxSizer(wxVERTICAL);
 
   const auto buttonSize = wxSize { editorHeight / 2, editorHeight / 2 };
 
   mUpButton = safenew wxButton(this, wxID_ANY, L"+", wxDefaultPosition, buttonSize);
   mUpButton->SetMinSize(buttonSize);
   mUpButton->SetMaxSize(buttonSize);
   buttonsSizer->Add(mUpButton, wxSizerFlags().Border(wxALL, 0));
 
   mDownButton = safenew wxButton(this, wxID_ANY, L"-", wxDefaultPosition, buttonSize);
   mDownButton->SetMinSize(buttonSize);
   mDownButton->SetMaxSize(buttonSize);
   buttonsSizer->Add(mDownButton, wxSizerFlags().Border(wxALL, 0));
 
   boxSizer->Add(buttonsSizer, wxSizerFlags().Border(wxALL, 0));
#endif
 
   const auto width = GetSize().x;
 
   if (width > 0)
   {
#ifndef __WXGTK__
      auto spinWidth = mSpinButton->GetSize().x;
      const auto editorWidth = std::max(10, width - spinWidth);
      mTextControl->SetMaxSize({ editorWidth, editorHeight });
#else
      const auto editorWidth = std::max(10, width - editorHeight / 2);
 
      mTextControl->SetMinSize({ editorWidth, editorHeight });
      mTextControl->SetMaxSize({ editorWidth, editorHeight });
      mTextControl->SetSize({ editorWidth, editorHeight });
#endif
   }
 
   SetSizerAndFit(boxSizer);
   Layout();
 
   Bind(
      wxEVT_SET_FOCUS,
      [this](auto& evt)
      {
         mTextControl->SetFocus();
         evt.Skip();
      });
 
   Bind(wxEVT_CHAR_HOOK, &SpinControl::OnCharHook, this);
 
   mTextControl->Bind(
      wxEVT_KILL_FOCUS,
      [this](auto& evt)
      {
         CommitTextControlValue();
         evt.Skip();
      });
 
   mTextControl->Bind(
      wxEVT_MOUSEWHEEL,
      [this](auto& evt)
      {
         const auto delta = evt.GetWheelDelta();
         const auto rotation = evt.GetWheelRotation();
 
         if (rotation >= delta)
            DoSteps(evt.ShiftDown() ? 10 : 1);
         else if (rotation <= delta)
            DoSteps(evt.ShiftDown() ? -10 : -1);
      });
 
#ifndef __WXGTK__
   mSpinButton->Bind(
      wxEVT_SPIN_UP,
      [this](auto& evt)
      {
         DoSteps(1);
         evt.Veto();
      });
 
   mSpinButton->Bind(
      wxEVT_SPIN_DOWN,
      [this](auto& evt)
      {
         DoSteps(-1);
         evt.Veto();
      });
#else
   mUpButton->Bind(
      wxEVT_BUTTON,
      [this](auto&)
      {
         DoSteps(1);
      });
 
   mDownButton->Bind(
      wxEVT_BUTTON,
      [this](auto&)
      {
         DoSteps(-1);
      });
#endif
}

References CommitTextControlValue(), DoSteps(), mDownButton, mTextControl, mUpButton, OnCharHook(), and safenew.

Referenced by SpinControl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoSteps()

void SpinControl::DoSteps ( double direction )

private

Definition at line 353 of file SpinControl.cpp.

{
   SetValue(mValue + direction * mStep, false);
}

References mStep, mValue, and SetValue().

Referenced by CreateUI(), and OnCharHook().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetFractionalAllowed()

bool SpinControl::GetFractionalAllowed ( )

Definition at line 139 of file SpinControl.cpp.

{
   return mFractionalAllowed;
}

References mFractionalAllowed.

◆ GetMaxValue()

double SpinControl::GetMaxValue ( ) const

Definition at line 114 of file SpinControl.cpp.

{
   return mMaxValue;
}

References mMaxValue.

◆ GetMinValue()

double SpinControl::GetMinValue ( ) const

Definition at line 102 of file SpinControl.cpp.

{
   return mMinValue;
}

References mMinValue.

◆ GetStep()

double SpinControl::GetStep ( ) const

Definition at line 125 of file SpinControl.cpp.

{
   return mStep;
}

References mStep.

◆ GetValue()

double SpinControl::GetValue ( ) const

Definition at line 90 of file SpinControl.cpp.

{
   return mValue;
}

References mValue.

Referenced by ShuttleGuiBase::DoTieSpinControl().

Here is the caller graph for this function:

◆ NotifyValueChanged()

void SpinControl::NotifyValueChanged ( )

private

Definition at line 358 of file SpinControl.cpp.

{
   wxCommandEvent e(wxEVT_SPINCTRL, GetId());
   e.SetEventObject(this);
   ProcessWindowEvent(e);
}

Referenced by SetValue().

Here is the caller graph for this function:

◆ OnCharHook()

void SpinControl::OnCharHook ( wxKeyEvent & evt )

private

Definition at line 320 of file SpinControl.cpp.

{
   const auto keyCode = evt.GetKeyCode();
 
   if (keyCode == WXK_UP || keyCode == WXK_NUMPAD_UP)
      DoSteps(evt.ShiftDown() ? 10.0 : 1.0);
   else if (keyCode == WXK_PAGEUP || keyCode == WXK_NUMPAD_PAGEUP)
      DoSteps(10.0);
   else if (keyCode == WXK_DOWN || keyCode == WXK_NUMPAD_DOWN)
      DoSteps(evt.ShiftDown() ? -10.0 : -1.0);
   else if (keyCode == WXK_PAGEDOWN || keyCode == WXK_NUMPAD_PAGEDOWN)
      DoSteps(-10.0);
   else if (keyCode == WXK_RETURN || keyCode == WXK_NUMPAD_ENTER)
      CommitTextControlValue();
   else
      evt.Skip();
}

References CommitTextControlValue(), and DoSteps().

Referenced by CreateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFractionalAllowed()

void SpinControl::SetFractionalAllowed ( bool allow )

Definition at line 130 of file SpinControl.cpp.

{
   if (mFractionalAllowed == allow)
      return;
 
   mFractionalAllowed = allow;
   SetupControls();
}

References mFractionalAllowed, and SetupControls().

Here is the call graph for this function:

◆ SetMaxValue()

void SpinControl::SetMaxValue ( double value )

Definition at line 107 of file SpinControl.cpp.

{
   mMaxValue = std::max(value, mMinValue);
   SetValue(mValue);
   SetupControls();
}

References mMaxValue, mMinValue, mValue, SetupControls(), and SetValue().

Referenced by SpinControl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMinValue()

void SpinControl::SetMinValue ( double value )

Definition at line 95 of file SpinControl.cpp.

{
   mMinValue = std::min(value, mMaxValue);
   SetValue(mValue);
   SetupControls();
}

References min(), mMaxValue, mMinValue, mValue, SetupControls(), and SetValue().

Referenced by SpinControl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetName()

void SpinControl::SetName ( const TranslatableString & name )

Definition at line 144 of file SpinControl.cpp.

{
#if wxUSE_ACCESSIBILITY
   if (mWindowAccessible == nullptr)
   {
      mWindowAccessible = safenew SpinControlAx(this, mTextControl);
      mTextControl->SetAccessible(mWindowAccessible);
   }
 
   mWindowAccessible->SetName(name);
#endif
}

References mTextControl, name, and safenew.

Referenced by SpinControl().

Here is the caller graph for this function:

◆ SetStep()

void SpinControl::SetStep ( double step )

Definition at line 119 of file SpinControl.cpp.

{
   mStep = step;
   SetupControls();
}

References mStep, and SetupControls().

Here is the call graph for this function:

◆ SetupControls()

void SpinControl::SetupControls ( )

private

Definition at line 288 of file SpinControl.cpp.

{
   if (mFractionalAllowed)
   {
      auto validator = wxFloatingPointValidator<ValueType>(
         mPrecision, nullptr, wxNUM_VAL_NO_TRAILING_ZEROES);
 
      validator.SetMin(mMinValue);
      validator.SetMax(mMaxValue);
 
      mTextControl->SetValidator(validator);
   }
   else
   {
      auto validator = wxIntegerValidator<int>();
 
      validator.SetMin(static_cast<int>(std::ceil(mMinValue)));
      validator.SetMax(static_cast<int>(std::floor(mMaxValue)));
 
      mTextControl->SetValidator(validator);
   }
}

References mFractionalAllowed, mMaxValue, mMinValue, mPrecision, and mTextControl.

Referenced by SetFractionalAllowed(), SetMaxValue(), SetMinValue(), SetStep(), and SpinControl().

Here is the caller graph for this function:

◆ SetValue() [1/2]

void SpinControl::SetValue ( double value )

Definition at line 85 of file SpinControl.cpp.

{
   SetValue(value, true);
}

References SetValue().

Referenced by CommitTextControlValue(), DoSteps(), ShuttleGuiBase::DoTieSpinControl(), SetMaxValue(), SetMinValue(), SetValue(), and SpinControl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetValue() [2/2]

void SpinControl::SetValue	(	double	value,
		bool	silent
	)

private

Definition at line 338 of file SpinControl.cpp.

{
   value = std::clamp(value, mMinValue, mMaxValue);
 
   // Should some epsilon be used here?
   if (value == mValue)
      return;
 
   mValue = value;
   mTextControl->SetValue(wxString::FromDouble(value));
 
   if (!silent)
      NotifyValueChanged();
}

References mMaxValue, mMinValue, mTextControl, mValue, and NotifyValueChanged().

Here is the call graph for this function:

◆ UpdatePrefs()

void SpinControl::UpdatePrefs ( )

overrideprivatevirtual

Implements PrefsListener.

Definition at line 157 of file SpinControl.cpp.

158{

159}

Member Data Documentation

◆ mDownButton

wxButton* SpinControl::mDownButton { nullptr }

private

Definition at line 86 of file SpinControl.h.

Referenced by CreateUI().

◆ mFractionalAllowed

bool SpinControl::mFractionalAllowed

private

Definition at line 79 of file SpinControl.h.

Referenced by GetFractionalAllowed(), SetFractionalAllowed(), and SetupControls().

◆ mMaxValue

ValueType SpinControl::mMaxValue { std::numeric_limits<ValueType>::infinity() }

private

Definition at line 75 of file SpinControl.h.

Referenced by GetMaxValue(), SetMaxValue(), SetMinValue(), SetupControls(), and SetValue().

◆ mMinValue

ValueType SpinControl::mMinValue { -std::numeric_limits<ValueType>::infinity() }

private

Definition at line 74 of file SpinControl.h.

Referenced by GetMinValue(), SetMaxValue(), SetMinValue(), SetupControls(), and SetValue().

◆ mPrecision

int SpinControl::mPrecision { 2 }

private

Definition at line 77 of file SpinControl.h.

Referenced by SetupControls().

◆ mStep

ValueType SpinControl::mStep

private

Definition at line 76 of file SpinControl.h.

Referenced by DoSteps(), GetStep(), and SetStep().

◆ mTextControl

wxTextCtrl* SpinControl::mTextControl { nullptr }

private

Definition at line 81 of file SpinControl.h.

Referenced by CommitTextControlValue(), CreateUI(), SetName(), SetupControls(), and SetValue().

◆ mUpButton

wxButton* SpinControl::mUpButton { nullptr }

private

Definition at line 85 of file SpinControl.h.

Referenced by CreateUI().

◆ mValue

ValueType SpinControl::mValue { std::numeric_limits<ValueType>::quiet_NaN() }

private

Definition at line 73 of file SpinControl.h.

Referenced by DoSteps(), GetValue(), SetMaxValue(), SetMinValue(), and SetValue().

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

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ValueType

Constructor & Destructor Documentation

◆ SpinControl()

Member Function Documentation

◆ CommitTextControlValue()

◆ CreateUI()

◆ DoSteps()

◆ GetFractionalAllowed()

◆ GetMaxValue()

◆ GetMinValue()

◆ GetStep()

◆ GetValue()

◆ NotifyValueChanged()

◆ OnCharHook()

◆ SetFractionalAllowed()

◆ SetMaxValue()

◆ SetMinValue()

◆ SetName()

◆ SetStep()

◆ SetupControls()

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ UpdatePrefs()

Member Data Documentation

◆ mDownButton

◆ mFractionalAllowed

◆ mMaxValue

◆ mMinValue

◆ mPrecision

◆ mStep

◆ mTextControl

◆ mUpButton

◆ mValue