#include <NumericTextCtrl.h>

Inheritance diagram for NumericTextCtrl:

Collaboration diagram for NumericTextCtrl:

Classes
struct	Options

Public Member Functions
	NumericTextCtrl (wxWindow *parent, wxWindowID winid, NumericConverter::Type type, const NumericFormatSymbol &formatName={}, double value=0.0, double sampleRate=44100, const Options &options={}, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)

virtual	~NumericTextCtrl ()

void	SetName (const TranslatableString &name)

wxSize	ComputeSizing (bool update=true, wxCoord digitW=0, wxCoord digitH=0)

bool	Layout () override

void	Fit () override

void	SetSampleRate (double sampleRate)

void	SetValue (double newValue)

bool	SetFormatString (const FormatStrings &formatString)

bool	SetFormatName (const NumericFormatSymbol &formatName)

void	SetFieldFocus (int)

wxSize	GetDimensions ()

wxSize	GetDigitSize ()

void	SetDigitSize (int width, int height)

void	SetReadOnly (bool readOnly=true)

void	EnableMenu (bool enable=true)

void	SetInvalidValue (double invalidValue)

int	GetFocusedField ()

int	GetFocusedDigit ()

Public Member Functions inherited from NumericConverter
	NumericConverter (Type type, const NumericFormatSymbol &formatName={}, double value=0.0f, double sampleRate=1.0f)

	NumericConverter (const NumericConverter &)

virtual	~NumericConverter ()

virtual void	ValueToControls ()

virtual void	ValueToControls (double rawValue, bool nearest=true)

virtual void	ControlsToValue ()

void	PrintDebugInfo ()

bool	SetFormatName (const NumericFormatSymbol &formatName)

bool	SetFormatString (const FormatStrings &formatString)

void	SetSampleRate (double sampleRate)

void	SetValue (double newValue)

void	SetMinValue (double minValue)

void	ResetMinValue ()

void	SetMaxValue (double maxValue)

void	ResetMaxValue ()

double	GetValue ()

wxString	GetString ()

int	GetFormatIndex ()

int	GetNumBuiltins ()

NumericFormatSymbol	GetBuiltinName (const int index)

FormatStrings	GetBuiltinFormat (const int index)

FormatStrings	GetBuiltinFormat (const NumericFormatSymbol &name)

void	Adjust (int steps, int dir)

void	Increment ()

void	Decrement ()

Private Member Functions
void	OnCaptureKey (wxCommandEvent &event)

void	OnKeyDown (wxKeyEvent &event)

void	OnKeyUp (wxKeyEvent &event)

void	OnMouse (wxMouseEvent &event)

void	OnErase (wxEraseEvent &event)

void	OnPaint (wxPaintEvent &event)

void	OnFocus (wxFocusEvent &event)

void	OnContext (wxContextMenuEvent &event)

void	ValueToControls () override

void	ControlsToValue () override

void	UpdateAutoFocus ()

void	Updated (bool keyup=false)

Private Attributes
bool	mMenuEnabled

bool	mReadOnly

std::unique_ptr< wxBitmap >	mBackgroundBitmap

std::unique_ptr< wxFont >	mDigitFont

std::unique_ptr< wxFont >	mLabelFont

int	mDigitBoxW

int	mDigitBoxH

int	mDigitW

int	mDigitH

int	mBorderLeft

int	mBorderTop

int	mBorderRight

int	mBorderBottom

int	mWidth

int	mHeight

int	mButtonWidth

int	mLastField

bool	mAutoPos

double	mScrollRemainder

NumericConverter::Type	mType

bool	mAllowInvalidValue

Friends
class	NumericTextCtrlAx

Additional Inherited Members
Public Types inherited from NumericConverter
enum	Type { TIME , ATIME , FREQUENCY , BANDWIDTH }

Static Public Member Functions inherited from NumericConverter
static NumericFormatSymbol	DefaultSelectionFormat ()

static NumericFormatSymbol	TimeAndSampleFormat ()

static NumericFormatSymbol	SecondsFormat ()

static NumericFormatSymbol	HoursMinsSecondsFormat ()

static NumericFormatSymbol	HundredthsFormat ()

static NumericFormatSymbol	HertzFormat ()

static NumericFormatSymbol	LookupFormat (Type type, const wxString &id)

Protected Attributes inherited from NumericConverter
Type	mType

double	mValue

double	mMinValue

double	mMaxValue

double	mInvalidValue

FormatStrings	mFormatString

std::vector< NumericField >	mFields

wxString	mPrefix

wxString	mValueTemplate

wxString	mValueMask

wxString	mValueString

double	mScalingFactor

double	mSampleRate

bool	mNtscDrop

int	mFocusedDigit

std::vector< DigitInfo >	mDigits

const BuiltinFormatString *	mBuiltinFormatStrings

const size_t	mNBuiltins

int	mDefaultNdx

Detailed Description

Definition at line 170 of file NumericTextCtrl.h.

Constructor & Destructor Documentation

◆ NumericTextCtrl()

NumericTextCtrl::NumericTextCtrl	(	wxWindow *	parent,
		wxWindowID	winid,
		NumericConverter::Type	type,
		const NumericFormatSymbol &	formatName = `{}`,
		double	value = `0.0`,
		double	sampleRate = `44100`,
		const Options &	options = `{}`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`
	)

Definition at line 1357 of file NumericTextCtrl.cpp.

                                              :
   wxControl(parent, id, pos, size, wxSUNKEN_BORDER | wxWANTS_CHARS),
   NumericConverter(type, formatName, timeValue, sampleRate),
   mBackgroundBitmap{},
   mDigitFont{},
   mLabelFont{},
   mLastField(1),
   mAutoPos(options.autoPos)
   , mType(type)
{
   mAllowInvalidValue = false;
 
   mDigitBoxW = 11;
   mDigitBoxH = 19;
 
   mBorderLeft = 1;
   mBorderTop = 1;
   mBorderRight = 1;
   mBorderBottom = 1;
 
   mReadOnly = options.readOnly;
   mMenuEnabled = options.menuEnabled;
   mButtonWidth = mMenuEnabled ? 9 : 0;
 
   SetLayoutDirection(wxLayout_LeftToRight);
   Layout();
   Fit();
   ValueToControls();
 
   //PRL -- would this fix the following?
   //ValueToControls();
 
   //mchinen - aug 15 09 - this seems to put the mValue back to zero, and do nothing else.
   //ControlsToValue();
 
   mScrollRemainder = 0.0;
 
#if wxUSE_ACCESSIBILITY
   SetLabel(wxT(""));
   SetName( {} );
   SetAccessible(safenew NumericTextCtrlAx(this));
#endif
 
   if (options.hasInvalidValue)
      SetInvalidValue( options.invalidValue );
 
   if (!options.format.formatStr.empty())
      SetFormatString( options.format );
 
   if (options.hasValue)
      SetValue( options.value );
 
}

◆ ~NumericTextCtrl()

NumericTextCtrl::~NumericTextCtrl ( )

virtual

Definition at line 1418 of file NumericTextCtrl.cpp.

1419{

1420}

Member Function Documentation

◆ ComputeSizing()

wxSize NumericTextCtrl::ComputeSizing	(	bool	update = `true`,
		wxCoord	digitW = `0`,
		wxCoord	digitH = `0`
	)

Definition at line 1521 of file NumericTextCtrl.cpp.

{
   // Get current box size
   if (boxW == 0) {
      boxW = mDigitBoxW;
   }
 
   if (boxH == 0) {
      boxH = mDigitBoxH;
   }
   boxH -= (mBorderTop + mBorderBottom);
 
   // We can use the screen device context since we're not drawing to it
   wxScreenDC dc;
 
   // First calculate a rough point size
   wxFont pf(wxSize(boxW, boxH), wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
   int fontSize = pf.GetPointSize();
   wxCoord strW;
   wxCoord strH;
 
   // Now decrease it until we fit within our digit box
   dc.SetFont(pf);
   dc.GetTextExtent(wxT("0"), &strW, &strH);
   while (strW > boxW || strH > boxH) {
      dc.SetFont(wxFont(--fontSize, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL));
      dc.GetTextExtent(wxT("0"), &strW, &strH);
   }
   fontSize--;
 
   // Create the digit font with the new point size
   if (update) {
      mDigitFont = std::make_unique<wxFont>(fontSize, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
      dc.SetFont(*mDigitFont);
 
      // Remember the actual digit width and height using the new font
      dc.GetTextExtent(wxT("0"), &mDigitW, &mDigitH);
   }
 
   // The label font should be a little smaller
   std::unique_ptr<wxFont> labelFont = std::make_unique<wxFont>(fontSize - 1, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
 
   // Use the label font for all remaining measurements since only non-digit text is left
   dc.SetFont(*labelFont);
 
   // Remember the pointer if updating
   if (update) {
      mLabelFont = std::move(labelFont);
   }
 
   // Get the width of the prefix, if any
   dc.GetTextExtent(mPrefix, &strW, &strH);
 
   // Bump x-position to the end of the prefix
   int x = mBorderLeft + strW;
 
   if (update) {
      // Set the character position past the prefix
      int pos = mPrefix.length();
 
      // Reset digits array
      mDigits.clear();
 
      // Figure out the x-position of each field and label in the box
      for (int i = 0, fcnt = mFields.size(); i < fcnt; ++i) {
         // Get the size of the label
         dc.GetTextExtent(mFields[i].label, &strW, &strH);
 
         // Remember this field's x-position
         mFields[i].fieldX = x;
 
         // Remember metrics for each digit
         for (int j = 0, dcnt = mFields[i].digits; j < dcnt; ++j) {
            mDigits.push_back(DigitInfo(i, j, pos, wxRect(x, mBorderTop, boxW, boxH)));
            x += boxW;
            pos++;
         }
 
         // Remember the label's x-position
         mFields[i].labelX = x;
 
         // Bump to end of label
         x += strW;
 
         // Remember the label's width
         mFields[i].fieldW = x;
 
         // Bump character position to end of label
         pos += mFields[i].label.length();
      }
   }
   else {
      // Determine the maximum x-position (length) of the remaining fields
      for (int i = 0, fcnt = mFields.size(); i < fcnt; ++i) {
         // Get the size of the label
         dc.GetTextExtent(mFields[i].label, &strW, &strH);
 
         // Just bump to next field
         x += (boxW * mFields[i].digits) + strW;
      }
   }
 
   // Calculate the maximum dimensions
   wxSize dim(x + mBorderRight, boxH + mBorderTop + mBorderBottom);
 
   // Save maximumFinally, calculate the minimum dimensions
   if (update) {
      mWidth = dim.x;
      mHeight = dim.y;
   }
 
   return wxSize(dim.x + mButtonWidth, dim.y);
}

References label, mBorderBottom, mBorderLeft, mBorderRight, mBorderTop, mButtonWidth, mDigitBoxH, mDigitBoxW, mDigitFont, mDigitH, NumericConverter::mDigits, mDigitW, NumericConverter::mFields, mHeight, mLabelFont, NumericConverter::mPrefix, and mWidth.

Referenced by TimeToolBar::ComputeSizing(), and Layout().

Here is the caller graph for this function:

◆ ControlsToValue()

void NumericTextCtrl::ControlsToValue ( )

overrideprivatevirtual

Reimplemented from NumericConverter.

Definition at line 2118 of file NumericTextCtrl.cpp.

{
   NumericConverter::ControlsToValue();
}

References NumericConverter::ControlsToValue().

Referenced by OnKeyDown(), SetFormatString(), SetSampleRate(), and SetValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnableMenu()

void NumericTextCtrl::EnableMenu ( bool enable = true )

Definition at line 1494 of file NumericTextCtrl.cpp.

{
#if wxUSE_TOOLTIPS
   wxString tip(_("(Use context menu to change format.)"));
   if (enable)
      SetToolTip(tip);
   else {
      wxToolTip *tt = GetToolTip();
      if (tt && tt->GetTip() == tip)
         SetToolTip(NULL);
   }
#endif
   mMenuEnabled = enable;
   mButtonWidth = enable ? 9 : 0;
   Layout();
   Fit();
}

References _, Fit(), Layout(), mButtonWidth, and mMenuEnabled.

Here is the call graph for this function:

◆ Fit()

void NumericTextCtrl::Fit ( )

override

Definition at line 1692 of file NumericTextCtrl.cpp.

{
   wxSize sz = GetSize();
   wxSize csz = GetClientSize();
 
   sz.x = mButtonWidth + mWidth + (sz.x - csz.x);
   sz.y = mHeight + (sz.y - csz.y);
 
   SetInitialSize(sz);
}

References mButtonWidth, mHeight, and mWidth.

Referenced by EnableMenu(), SetDigitSize(), SetFormatString(), and SetSampleRate().

Here is the caller graph for this function:

◆ GetDigitSize()

wxSize NumericTextCtrl::GetDigitSize ( )

inline

Definition at line 232 of file NumericTextCtrl.h.

232{ return wxSize(mDigitBoxW, mDigitBoxH); }

Referenced by TimeToolBar::OnSize(), and TimeToolBar::Populate().

Here is the caller graph for this function:

◆ GetDimensions()

wxSize NumericTextCtrl::GetDimensions ( )

inline

Definition at line 231 of file NumericTextCtrl.h.

231{ return wxSize(mWidth + mButtonWidth, mHeight); }

Referenced by TimeToolBar::OnSize().

Here is the caller graph for this function:

◆ GetFocusedDigit()

int NumericTextCtrl::GetFocusedDigit ( )

inline

Definition at line 244 of file NumericTextCtrl.h.

244{ return mFocusedDigit; }

NumericConverter::mFocusedDigit

int mFocusedDigit

Definition: NumericTextCtrl.h:162

◆ GetFocusedField()

int NumericTextCtrl::GetFocusedField ( )

inline

Definition at line 243 of file NumericTextCtrl.h.

243{ return mLastField; }

◆ Layout()

bool NumericTextCtrl::Layout ( )

override

Definition at line 1635 of file NumericTextCtrl.cpp.

{
   ComputeSizing();
 
   wxMemoryDC memDC;
   wxCoord strW, strH;
   memDC.SetFont(*mLabelFont);
   memDC.GetTextExtent(mPrefix, &strW, &strH);
 
   int i;
 
   // Draw the background bitmap - it contains black boxes where
   // all of the digits go and all of the other text
 
   wxBrush Brush;
 
   mBackgroundBitmap = std::make_unique<wxBitmap>(mWidth + mButtonWidth, mHeight,24);
   memDC.SelectObject(*mBackgroundBitmap);
 
   theTheme.SetBrushColour( Brush, clrTimeHours );
   memDC.SetBrush(Brush);
   memDC.SetPen(*wxTRANSPARENT_PEN);
   memDC.DrawRectangle(0, 0, mWidth + mButtonWidth, mHeight);
 
   int numberBottom = mBorderTop + (mDigitBoxH - mDigitH)/2 + mDigitH;
 
   memDC.GetTextExtent(wxT("0"), &strW, &strH);
   int labelTop = numberBottom - strH;
 
   memDC.SetTextForeground(theTheme.Colour( clrTimeFont ));
   memDC.SetTextBackground(theTheme.Colour( clrTimeBack ));
   memDC.DrawText(mPrefix, mBorderLeft, labelTop);
 
   theTheme.SetBrushColour( Brush, clrTimeBack );
   memDC.SetBrush(Brush);
   //memDC.SetBrush(*wxLIGHT_GREY_BRUSH);
   for(i = 0; i < mDigits.size(); i++)
      memDC.DrawRectangle(mDigits[i].digitBox);
   memDC.SetBrush( wxNullBrush );
 
   for(i = 0; i < mFields.size(); i++)
      memDC.DrawText(mFields[i].label,
                     mFields[i].labelX, labelTop);
 
   if (mMenuEnabled) {
      wxRect r(mWidth, 0, mButtonWidth - 1, mHeight - 1);
      AColor::Bevel(memDC, true, r);
      memDC.SetBrush(*wxBLACK_BRUSH);
      memDC.SetPen(*wxBLACK_PEN);
      AColor::Arrow(memDC,
                    mWidth + 1,
                    (mHeight / 2) - 2,
                    mButtonWidth - 2);
   }
   return true;
}

References AColor::Arrow(), AColor::Bevel(), ThemeBase::Colour(), ComputeSizing(), mBackgroundBitmap, mBorderLeft, mBorderTop, mButtonWidth, mDigitBoxH, mDigitH, NumericConverter::mDigits, NumericConverter::mFields, mHeight, mLabelFont, mMenuEnabled, NumericConverter::mPrefix, mWidth, ThemeBase::SetBrushColour(), and theTheme.

Referenced by EnableMenu(), SetDigitSize(), SetFormatString(), and SetSampleRate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnCaptureKey()

void NumericTextCtrl::OnCaptureKey ( wxCommandEvent & event )

private

Definition at line 1867 of file NumericTextCtrl.cpp.

{
   wxKeyEvent *kevent = (wxKeyEvent *)event.GetEventObject();
   int keyCode = kevent->GetKeyCode();
 
   // Convert numeric keypad entries.
   if ((keyCode >= WXK_NUMPAD0) && (keyCode <= WXK_NUMPAD9))
      keyCode -= WXK_NUMPAD0 - '0';
 
   switch (keyCode)
   {
      case WXK_BACK:
      case WXK_LEFT:
      case WXK_RIGHT:
      case WXK_HOME:
      case WXK_END:
      case WXK_UP:
      case WXK_DOWN:
      case WXK_TAB:
      case WXK_RETURN:
      case WXK_NUMPAD_ENTER:
      case WXK_DELETE:
         return;
 
      default:
         if (keyCode >= '0' && keyCode <= '9' && !kevent->HasAnyModifiers())
            return;
   }
 
   event.Skip();
 
   return;
}

◆ OnContext()

void NumericTextCtrl::OnContext ( wxContextMenuEvent & event )

private

Definition at line 1755 of file NumericTextCtrl.cpp.

{
   wxMenu menu;
   int i;
 
   if (!mMenuEnabled) {
      event.Skip();
      return;
   }
 
   SetFocus();
 
   int currentSelection = -1;
   for (i = 0; i < GetNumBuiltins(); i++) {
      menu.AppendRadioItem(ID_MENU + i, GetBuiltinName(i).Translation());
      if (mFormatString == GetBuiltinFormat(i)) {
         menu.Check(ID_MENU + i, true);
         currentSelection = i;
      }
   }
 
   menu.Bind(wxEVT_MENU, [](auto&){});
   BasicMenu::Handle{ &menu }.Popup(
      wxWidgetsWindowPlacement{ this },
      { 0, 0 }
   );
 
   // This used to be in an EVT_MENU() event handler, but GTK
   // is sensitive to what is done within the handler if the
   // user happens to check the first menuitem and then is 
   // moving down the menu when the ...CTRL_UPDATED event
   // handler kicks in.
   for (i = 0; i < GetNumBuiltins(); i++) {
      if (menu.IsChecked(ID_MENU + i) && i != currentSelection) {
         SetFormatString(GetBuiltinFormat(i));
      
         int eventType = 0;
         switch (mType) {
            case NumericConverter::TIME:
               eventType = EVT_TIMETEXTCTRL_UPDATED;
               break;
            case NumericConverter::FREQUENCY:
               eventType = EVT_FREQUENCYTEXTCTRL_UPDATED;
               break;
            case NumericConverter::BANDWIDTH:
               eventType = EVT_BANDWIDTHTEXTCTRL_UPDATED;
               break;
            default:
               wxASSERT(false);
               break;
         }
      
         wxCommandEvent e(eventType, GetId());
         e.SetInt(i);
         e.SetString(GetBuiltinName(i).Internal());
         GetParent()->GetEventHandler()->AddPendingEvent(e);
      }
   }
 
}

References NumericConverter::BANDWIDTH, NumericConverter::FREQUENCY, NumericConverter::GetBuiltinFormat(), NumericConverter::GetBuiltinName(), NumericConverter::GetNumBuiltins(), ID_MENU, Internal, NumericConverter::mFormatString, mMenuEnabled, mType, BasicMenu::Handle::Popup(), SetFormatString(), NumericConverter::TIME, and ComponentInterfaceSymbol::Translation().

Referenced by OnMouse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnErase()

void NumericTextCtrl::OnErase ( wxEraseEvent & event )

private

Definition at line 1703 of file NumericTextCtrl.cpp.

{
   // Ignore it to prevent flashing
}

◆ OnFocus()

void NumericTextCtrl::OnFocus ( wxFocusEvent & event )

private

Definition at line 1856 of file NumericTextCtrl.cpp.

{
   KeyboardCapture::OnFocus( *this, event );
 
   if (event.GetEventType() != wxEVT_KILL_FOCUS &&
       mFocusedDigit <= 0 )
      UpdateAutoFocus();
 
   event.Skip( false ); // PRL: not sure why, but preserving old behavior
}

References NumericConverter::mFocusedDigit, KeyboardCapture::OnFocus(), and UpdateAutoFocus().

Here is the call graph for this function:

◆ OnKeyDown()

void NumericTextCtrl::OnKeyDown ( wxKeyEvent & event )

private

Definition at line 1919 of file NumericTextCtrl.cpp.

{
   if (mDigits.size() == 0)
   {
      mFocusedDigit = 0;
      return;
   }
 
   event.Skip(false);
 
   int keyCode = event.GetKeyCode();
   int digit = mFocusedDigit;
 
   if (mFocusedDigit < 0)
      mFocusedDigit = 0;
   if (mFocusedDigit >= (int)mDigits.size())
      mFocusedDigit = mDigits.size() - 1;
 
   // Convert numeric keypad entries.
   if ((keyCode >= WXK_NUMPAD0) && (keyCode <= WXK_NUMPAD9))
      keyCode -= WXK_NUMPAD0 - '0';
 
   if (!mReadOnly && (keyCode >= '0' && keyCode <= '9' && !event.HasAnyModifiers())) {
      int digitPosition = mDigits[mFocusedDigit].pos;
      if (mValueString[digitPosition] == wxChar('-')) {
         mValue = std::max(mMinValue, std::min(mMaxValue, 0.0));
         ValueToControls();
         // Beware relocation of the string
         digitPosition = mDigits[mFocusedDigit].pos;
      }
      mValueString[digitPosition] = wxChar(keyCode);
      ControlsToValue();
      Refresh();// Force an update of the control. [Bug 1497]
      ValueToControls();
      mFocusedDigit = (mFocusedDigit + 1) % (mDigits.size());
      Updated();
   }
 
   else if (!mReadOnly && keyCode == WXK_DELETE) {
      if (mAllowInvalidValue)
         SetValue(mInvalidValue);
   }
 
   else if (!mReadOnly && keyCode == WXK_BACK) {
      // Moves left, replaces that char with '0', stays there...
      mFocusedDigit--;
      mFocusedDigit += mDigits.size();
      mFocusedDigit %= mDigits.size();
      wxString::reference theDigit = mValueString[mDigits[mFocusedDigit].pos];
      if (theDigit != wxChar('-'))
         theDigit = '0';
      ControlsToValue();
      Refresh();// Force an update of the control. [Bug 1497]
      ValueToControls();
      Updated();
   }
 
   else if (keyCode == WXK_LEFT) {
      mFocusedDigit--;
      mFocusedDigit += mDigits.size();
      mFocusedDigit %= mDigits.size();
      Refresh();
   }
 
   else if (keyCode == WXK_RIGHT) {
      mFocusedDigit++;
      mFocusedDigit %= mDigits.size();
      Refresh();
   }
 
   else if (keyCode == WXK_HOME) {
      mFocusedDigit = 0;
      Refresh();
   }
 
   else if (keyCode == WXK_END) {
      mFocusedDigit = mDigits.size() - 1;
      Refresh();
   }
 
   else if (!mReadOnly && keyCode == WXK_UP) {
      Adjust(1, 1);
      Updated();
   }
 
   else if (!mReadOnly && keyCode == WXK_DOWN) {
      Adjust(1, -1);
      Updated();
   }
 
   else if (keyCode == WXK_TAB) {
#if defined(__WXMSW__)
      // Using Navigate() on Windows, rather than the following code causes
      // bug 1542
      wxWindow* parent = GetParent();
      wxNavigationKeyEvent nevent;
      nevent.SetWindowChange(event.ControlDown());
      nevent.SetDirection(!event.ShiftDown());
      nevent.SetEventObject(parent);
      nevent.SetCurrentFocus(parent);
      GetParent()->GetEventHandler()->ProcessEvent(nevent);
#else
      Navigate(event.ShiftDown()
               ? wxNavigationKeyEvent::IsBackward
               : wxNavigationKeyEvent::IsForward);
#endif
   }
 
   else if (keyCode == WXK_RETURN || keyCode == WXK_NUMPAD_ENTER) {
      wxTopLevelWindow *tlw = wxDynamicCast(wxGetTopLevelParent(this), wxTopLevelWindow);
      wxWindow *def = tlw->GetDefaultItem();
      if (def && def->IsEnabled()) {
         wxCommandEvent cevent(wxEVT_COMMAND_BUTTON_CLICKED,
                               def->GetId());
         cevent.SetEventObject( def );
         GetParent()->GetEventHandler()->ProcessEvent(cevent);
      }
   }
 
   else {
      event.Skip();
      return;
   }
 
   if (digit != mFocusedDigit) {
      SetFieldFocus(mFocusedDigit);
   }
}

References NumericConverter::Adjust(), ControlsToValue(), mAllowInvalidValue, NumericConverter::mDigits, NumericConverter::mFocusedDigit, min(), NumericConverter::mInvalidValue, NumericConverter::mMaxValue, NumericConverter::mMinValue, mReadOnly, NumericConverter::mValue, NumericConverter::mValueString, SetFieldFocus(), SetValue(), Updated(), ValueToControls(), and wxEVT_COMMAND_BUTTON_CLICKED.

Here is the call graph for this function:

◆ OnKeyUp()

void NumericTextCtrl::OnKeyUp ( wxKeyEvent & event )

private

Definition at line 1901 of file NumericTextCtrl.cpp.

{
   int keyCode = event.GetKeyCode();
 
   event.Skip(true);
 
   if ((keyCode >= WXK_NUMPAD0) && (keyCode <= WXK_NUMPAD9))
      keyCode -= WXK_NUMPAD0 - '0';
 
   if ((keyCode >= '0' && keyCode <= '9' && !event.HasAnyModifiers()) ||
       (keyCode == WXK_DELETE) ||
       (keyCode == WXK_BACK) ||
       (keyCode == WXK_UP) ||
       (keyCode == WXK_DOWN)) {
      Updated(true);
   }
}

References Updated().

Here is the call graph for this function:

◆ OnMouse()

void NumericTextCtrl::OnMouse ( wxMouseEvent & event )

private

Definition at line 1816 of file NumericTextCtrl.cpp.

{
   if (event.LeftDown() && event.GetX() >= mWidth) {
      wxContextMenuEvent e;
      OnContext(e);
   }
   else if (event.LeftDown()) {
      SetFocus();
 
      int bestDist = 9999;
      unsigned int i;
 
      mFocusedDigit = 0;
      for(i = 0; i < mDigits.size(); i++) {
         int dist = abs(event.m_x - (mDigits[i].digitBox.x +
                                     mDigits[i].digitBox.width/2));
         if (dist < bestDist) {
            mFocusedDigit = i;
            bestDist = dist;
         }
      }
 
      Refresh(false);
   }
   else if (event.RightDown() && mMenuEnabled) {
      wxContextMenuEvent e;
      OnContext(e);
   }
   else if(!mReadOnly && event.m_wheelRotation != 0 ) {
      double steps = event.m_wheelRotation /
         (event.m_wheelDelta > 0 ? (double)event.m_wheelDelta : 120.0) +
         mScrollRemainder;
      mScrollRemainder = steps - floor(steps);
      steps = floor(steps);
 
      Adjust((int)fabs(steps), steps < 0.0 ? -1 : 1);
      Updated();
   }
}

References NumericConverter::Adjust(), NumericConverter::mDigits, NumericConverter::mFocusedDigit, mMenuEnabled, mReadOnly, mScrollRemainder, mWidth, OnContext(), and Updated().

Here is the call graph for this function:

◆ OnPaint()

void NumericTextCtrl::OnPaint ( wxPaintEvent & event )

private

Definition at line 1708 of file NumericTextCtrl.cpp.

{
   wxBufferedPaintDC dc(this);
   bool focused = (FindFocus() == this);
 
   dc.DrawBitmap(*mBackgroundBitmap, 0, 0);
 
   wxPen   Pen;
   wxBrush Brush;
   if (focused) {
      theTheme.SetPenColour( Pen, clrTimeFontFocus );
      dc.SetPen(Pen);
      dc.SetBrush(*wxTRANSPARENT_BRUSH);
      dc.DrawRectangle(0, 0, mWidth, mHeight);
      dc.SetPen( wxNullPen );
   }
 
   dc.SetFont(*mDigitFont);
   dc.SetTextForeground(theTheme.Colour( clrTimeFont ));
   dc.SetTextBackground(theTheme.Colour( clrTimeBack ));
 
   dc.SetPen(*wxTRANSPARENT_PEN);
   theTheme.SetBrushColour( Brush , clrTimeBackFocus );
   dc.SetBrush( Brush );
 
   int i;
   for(i = 0; i < (int)mDigits.size(); i++) {
      wxRect box = mDigits[i].digitBox;
      if (focused && mFocusedDigit == i) {
         dc.DrawRectangle(box);
         dc.SetTextForeground(theTheme.Colour( clrTimeFontFocus ));
         dc.SetTextBackground(theTheme.Colour( clrTimeBackFocus ));
      }
      int pos = mDigits[i].pos;
      wxString digit = mValueString.Mid(pos, 1);
      int x = box.x + (mDigitBoxW - mDigitW)/2;
      int y = box.y + (mDigitBoxH - mDigitH)/2;
      dc.DrawText(digit, x, y);
      if (focused && mFocusedDigit == i) {
         dc.SetTextForeground(theTheme.Colour( clrTimeFont ));
         dc.SetTextBackground(theTheme.Colour( clrTimeBack ));
      }
   }
   dc.SetPen( wxNullPen );
   dc.SetBrush( wxNullBrush );
}

References ThemeBase::Colour(), mBackgroundBitmap, mDigitBoxH, mDigitBoxW, mDigitFont, mDigitH, NumericConverter::mDigits, mDigitW, NumericConverter::mFocusedDigit, mHeight, NumericConverter::mValueString, mWidth, ThemeBase::SetBrushColour(), ThemeBase::SetPenColour(), and theTheme.

Here is the call graph for this function:

◆ SetDigitSize()

void NumericTextCtrl::SetDigitSize	(	int	width,
		int	height
	)

Definition at line 1481 of file NumericTextCtrl.cpp.

{
   mDigitBoxW = width;
   mDigitBoxH = height;
   Layout();
   Fit();
}

References Fit(), Layout(), mDigitBoxH, and mDigitBoxW.

Referenced by TimeToolBar::OnSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFieldFocus()

void NumericTextCtrl::SetFieldFocus ( int digit )

Definition at line 2048 of file NumericTextCtrl.cpp.

{
#if wxUSE_ACCESSIBILITY
   if (mDigits.size() == 0)
   {
      mFocusedDigit = 0;
      return;
   }
   mFocusedDigit = digit;
   mLastField = mDigits[mFocusedDigit].field + 1;
 
   GetAccessible()->NotifyEvent(wxACC_EVENT_OBJECT_FOCUS,
                                this,
                                wxOBJID_CLIENT,
                                mFocusedDigit + 1);
#endif
}

References NumericConverter::mDigits, NumericConverter::mFocusedDigit, and mLastField.

Referenced by OnKeyDown().

Here is the caller graph for this function:

◆ SetFormatName()

bool NumericTextCtrl::SetFormatName ( const NumericFormatSymbol & formatName )

Definition at line 1445 of file NumericTextCtrl.cpp.

{
   return
      SetFormatString(GetBuiltinFormat(formatName));
}

References NumericConverter::GetBuiltinFormat(), and SetFormatString().

Referenced by EffectChangeSpeed::OnTimeCtrlUpdate(), EffectChangeSpeed::TransferDataToWindow(), and EffectChangeSpeed::Update_TimeCtrl_ToLength().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFormatString()

bool NumericTextCtrl::SetFormatString ( const FormatStrings & formatString )

Definition at line 1451 of file NumericTextCtrl.cpp.

{
   auto result =
      NumericConverter::SetFormatString(formatString);
   if (result) {
      Layout();
      Fit();
      ValueToControls();
      ControlsToValue();
      UpdateAutoFocus();
   }
   return result;
}

References ControlsToValue(), Fit(), Layout(), NumericConverter::SetFormatString(), UpdateAutoFocus(), and ValueToControls().

Referenced by OnContext(), TimeToolBar::SetAudioTimeFormat(), SetFormatName(), SelectionBar::SetSelectionFormat(), and TimeDialog::TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetInvalidValue()

void NumericTextCtrl::SetInvalidValue ( double invalidValue )

Definition at line 1512 of file NumericTextCtrl.cpp.

{
   const bool wasInvalid = mAllowInvalidValue && (mValue == mInvalidValue);
   mAllowInvalidValue = true;
   mInvalidValue = invalidValue;
   if (wasInvalid)
      SetValue(invalidValue);
}

References mAllowInvalidValue, NumericConverter::mInvalidValue, NumericConverter::mValue, and SetValue().

Here is the call graph for this function:

◆ SetName()

void NumericTextCtrl::SetName ( const TranslatableString & name )

Definition at line 1422 of file NumericTextCtrl.cpp.

{
   wxControl::SetName( name.Translation() );
}

References name, and TranslatableString::Translation().

Referenced by LV2Effect::BuildPlain(), VSTEffect::BuildPlain(), TimeToolBar::Populate(), and VST3Effect::PopulateUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetReadOnly()

void NumericTextCtrl::SetReadOnly ( bool readOnly = true )

Definition at line 1489 of file NumericTextCtrl.cpp.

{
   mReadOnly = readOnly;
}

References mReadOnly.

Referenced by TimeToolBar::Populate().

Here is the caller graph for this function:

◆ SetSampleRate()

void NumericTextCtrl::SetSampleRate ( double sampleRate )

Definition at line 1465 of file NumericTextCtrl.cpp.

{
   NumericConverter::SetSampleRate(sampleRate);
   Layout();
   Fit();
   ValueToControls();
   ControlsToValue();
}

References ControlsToValue(), Fit(), Layout(), NumericConverter::SetSampleRate(), and ValueToControls().

Referenced by TimeToolBar::OnRateChanged(), and TimeDialog::TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetValue()

void NumericTextCtrl::SetValue ( double newValue )

Definition at line 1474 of file NumericTextCtrl.cpp.

{
   NumericConverter::SetValue(newValue);
   ValueToControls();
   ControlsToValue();
}

References ControlsToValue(), NumericConverter::SetValue(), and ValueToControls().

Referenced by TimerRecordDialog::OnDatePicker_End(), ContrastDialog::OnGetBackground(), ContrastDialog::OnGetForeground(), TimeToolBar::OnIdle(), OnKeyDown(), ContrastDialog::OnReset(), NyquistEffect::OnTime(), EffectChangeSpeed::OnTimeCtrlUpdate(), TimerRecordDialog::OnTimer(), TimerRecordDialog::OnTimeText_End(), TimerRecordDialog::OnTimeText_Start(), NumericEditor::Reset(), SetInvalidValue(), NyquistEffect::TransferDataToEffectWindow(), TimeDialog::TransferDataToWindow(), EffectChangeSpeed::TransferDataToWindow(), EffectNoise::TransferDataToWindow(), EffectSilence::TransferDataToWindow(), EffectToneGen::TransferDataToWindow(), EffectChangeSpeed::Update_TimeCtrl_ToLength(), TimerRecordDialog::UpdateDuration(), and TimerRecordDialog::UpdateEnd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateAutoFocus()

void NumericTextCtrl::UpdateAutoFocus ( )

private

Definition at line 1430 of file NumericTextCtrl.cpp.

{
   if (!mAutoPos)
      return;
 
   mFocusedDigit = 0;
   while (mFocusedDigit < ((int)mDigits.size() - 1)) {
      wxChar dgt = mValueString[mDigits[mFocusedDigit].pos];
      if (dgt != '0') {
         break;
      }
      mFocusedDigit++;
   }
}

References mAutoPos, NumericConverter::mDigits, NumericConverter::mFocusedDigit, and NumericConverter::mValueString.

Referenced by OnFocus(), and SetFormatString().

Here is the caller graph for this function:

◆ Updated()

void NumericTextCtrl::Updated ( bool keyup = false )

private

Definition at line 2066 of file NumericTextCtrl.cpp.

{
   wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
 
   // This will give listeners the ability to do tasks when the
   // update has been completed, like when the UP ARROW has been
   // held down and is finally released.
   event.SetInt(keyup);
   event.SetEventObject(this);
   GetEventHandler()->ProcessEvent(event);
 
#if wxUSE_ACCESSIBILITY
   if (!keyup) {
      if (mDigits.size() == 0)
      {
         mFocusedDigit = 0;
         return;
      }
 
      // The object_focus event is only needed by Window-Eyes
      // and can be removed when we cease to support this screen reader.
      GetAccessible()->NotifyEvent(wxACC_EVENT_OBJECT_FOCUS,
         this,
         wxOBJID_CLIENT,
         mFocusedDigit + 1);
 
      GetAccessible()->NotifyEvent(wxACC_EVENT_OBJECT_NAMECHANGE,
         this,
         wxOBJID_CLIENT,
         mFocusedDigit + 1);
   }
#endif
}

References NumericConverter::mDigits, NumericConverter::mFocusedDigit, and wxEVT_COMMAND_TEXT_UPDATED.

Referenced by OnKeyDown(), OnKeyUp(), and OnMouse().

Here is the caller graph for this function:

◆ ValueToControls()

void NumericTextCtrl::ValueToControls ( )

overrideprivatevirtual

Reimplemented from NumericConverter.

Definition at line 2100 of file NumericTextCtrl.cpp.

{
   const wxString previousValueString = mValueString;
   NumericConverter::ValueToControls(mValue);
   if (mValueString != previousValueString) {
      // Doing this only when needed is an optimization.
      // NumerixTextCtrls are used in the selection bar at the bottom
      // of Audacity, and are updated at high frequency through
      // SetValue() when Audacity is playing. This consumes a
      // significant amount of CPU. Typically, when a track is
      // playing, only one of the NumericTextCtrl actually changes
      // (the audio position). We save CPU by updating the control
      // only when needed.
      Refresh(false);
   }
}

References NumericConverter::mValue, NumericConverter::mValueString, and NumericConverter::ValueToControls().

Referenced by OnKeyDown(), SetFormatString(), SetSampleRate(), and SetValue().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ NumericTextCtrlAx

friend class NumericTextCtrlAx

friend

Definition at line 173 of file NumericTextCtrl.h.

Member Data Documentation

◆ mAllowInvalidValue

bool NumericTextCtrl::mAllowInvalidValue

private

Definition at line 298 of file NumericTextCtrl.h.

Referenced by OnKeyDown(), and SetInvalidValue().

◆ mAutoPos

bool NumericTextCtrl::mAutoPos

private

Definition at line 291 of file NumericTextCtrl.h.

Referenced by UpdateAutoFocus().

◆ mBackgroundBitmap

std::unique_ptr<wxBitmap> NumericTextCtrl::mBackgroundBitmap

private

Definition at line 273 of file NumericTextCtrl.h.

Referenced by Layout(), and OnPaint().

◆ mBorderBottom

int NumericTextCtrl::mBorderBottom

private

Definition at line 283 of file NumericTextCtrl.h.

Referenced by ComputeSizing().

◆ mBorderLeft

int NumericTextCtrl::mBorderLeft

private

Definition at line 280 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and Layout().

◆ mBorderRight

int NumericTextCtrl::mBorderRight

private

Definition at line 282 of file NumericTextCtrl.h.

Referenced by ComputeSizing().

◆ mBorderTop

int NumericTextCtrl::mBorderTop

private

Definition at line 281 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and Layout().

◆ mButtonWidth

int NumericTextCtrl::mButtonWidth

private

Definition at line 286 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), EnableMenu(), Fit(), and Layout().

◆ mDigitBoxH

int NumericTextCtrl::mDigitBoxH

private

Definition at line 277 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), Layout(), OnPaint(), and SetDigitSize().

◆ mDigitBoxW

int NumericTextCtrl::mDigitBoxW

private

Definition at line 276 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), OnPaint(), and SetDigitSize().

◆ mDigitFont

std::unique_ptr<wxFont> NumericTextCtrl::mDigitFont

private

Definition at line 275 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and OnPaint().

◆ mDigitH

int NumericTextCtrl::mDigitH

private

Definition at line 279 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), Layout(), and OnPaint().

◆ mDigitW

int NumericTextCtrl::mDigitW

private

Definition at line 278 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and OnPaint().

◆ mHeight

int NumericTextCtrl::mHeight

private

Definition at line 285 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), Fit(), Layout(), and OnPaint().

◆ mLabelFont

std::unique_ptr<wxFont> NumericTextCtrl::mLabelFont

private

Definition at line 275 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and Layout().

◆ mLastField

int NumericTextCtrl::mLastField

private

Definition at line 288 of file NumericTextCtrl.h.

Referenced by SetFieldFocus().

◆ mMenuEnabled

bool NumericTextCtrl::mMenuEnabled

private

Definition at line 270 of file NumericTextCtrl.h.

Referenced by EnableMenu(), Layout(), OnContext(), and OnMouse().

◆ mReadOnly

bool NumericTextCtrl::mReadOnly

private

Definition at line 271 of file NumericTextCtrl.h.

Referenced by OnKeyDown(), OnMouse(), and SetReadOnly().

◆ mScrollRemainder

double NumericTextCtrl::mScrollRemainder

private

Definition at line 294 of file NumericTextCtrl.h.

Referenced by OnMouse().

◆ mType

NumericConverter::Type NumericTextCtrl::mType

private

Definition at line 296 of file NumericTextCtrl.h.

Referenced by OnContext().

◆ mWidth

int NumericTextCtrl::mWidth

private

Definition at line 284 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), Fit(), Layout(), OnMouse(), and OnPaint().

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NumericTextCtrl()

◆ ~NumericTextCtrl()

Member Function Documentation

◆ ComputeSizing()

◆ ControlsToValue()

◆ EnableMenu()

◆ Fit()

◆ GetDigitSize()

◆ GetDimensions()

◆ GetFocusedDigit()

◆ GetFocusedField()

◆ Layout()

◆ OnCaptureKey()

◆ OnContext()

◆ OnErase()

◆ OnFocus()

◆ OnKeyDown()

◆ OnKeyUp()

◆ OnMouse()

◆ OnPaint()

◆ SetDigitSize()

◆ SetFieldFocus()

◆ SetFormatName()

◆ SetFormatString()

◆ SetInvalidValue()

◆ SetName()

◆ SetReadOnly()

◆ SetSampleRate()

◆ SetValue()

◆ UpdateAutoFocus()

◆ Updated()

◆ ValueToControls()

Friends And Related Function Documentation

◆ NumericTextCtrlAx

Member Data Documentation

◆ mAllowInvalidValue

◆ mAutoPos

◆ mBackgroundBitmap

◆ mBorderBottom

◆ mBorderLeft

◆ mBorderRight

◆ mBorderTop

◆ mButtonWidth

◆ mDigitBoxH

◆ mDigitBoxW

◆ mDigitFont

◆ mDigitH

◆ mDigitW

◆ mHeight

◆ mLabelFont

◆ mLastField

◆ mMenuEnabled

◆ mReadOnly

◆ mScrollRemainder

◆ mType

◆ mWidth