NumericTextCtrl Class Reference

#include <NumericTextCtrl.h>

Inheritance diagram for NumericTextCtrl:

Collaboration diagram for NumericTextCtrl:

Classes
struct	FieldPosition
struct	Options

Public Member Functions
	NumericTextCtrl (const FormatterContext &context, wxWindow *parent, wxWindowID winid, NumericConverterType type, const NumericFormatID &formatName={}, double value=0.0, 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	SetValue (double newValue)
bool	SetTypeAndFormatName (const NumericConverterType &type, const NumericFormatID &formatName)
bool	SetFormatName (const NumericFormatID &formatName)
bool	SetCustomFormat (const TranslatableString &customFormat)
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	GetFocusedDigit ()
Public Member Functions inherited from NumericConverter
	NumericConverter (const FormatterContext &context, NumericConverterType type, const NumericFormatID &formatName={}, double value=0.0f)
virtual	~NumericConverter ()
virtual void	ValueToControls ()
virtual void	ValueToControls (double rawValue, bool nearest=true)
virtual void	ControlsToValue ()
bool	SetTypeAndFormatName (const NumericConverterType &type, const NumericFormatID &formatName)
bool	SetFormatName (const NumericFormatID &formatName)
NumericFormatID	GetFormatName () const
bool	SetCustomFormat (const TranslatableString &customFormat)
void	SetValue (double newValue)
void	SetMinValue (double minValue)
void	ResetMinValue ()
void	SetMaxValue (double maxValue)
void	ResetMaxValue ()
double	GetValue ()
wxString	GetString ()
void	UpdateFormatToFit (double value)
void	Adjust (int steps, int dir, int focusedDigit)
void	Increment (int focusedDigit=-1)
void	Decrement (int focusedDigit=-1)
Public Member Functions inherited from Observer::Publisher< FormatChangedToFitValueMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Private Member Functions
void	OnFormatUpdated (bool resetFocus) override
void	HandleFormatterChanged (bool resetFocus)
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)
wxRect	GetBox (size_t ii) const

Private Attributes
std::vector< wxRect >	mBoxes
std::vector< FieldPosition >	mFieldPositions
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	mFocusedDigit { 0 }
bool	mAutoPos
double	mScrollRemainder
NumericConverterType	mType
bool	mAllowInvalidValue

Friends
class	NumericTextCtrlAx

Additional Inherited Members
Public Types inherited from Observer::Publisher< FormatChangedToFitValueMessage >
using	message_type = FormatChangedToFitValueMessage
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const FormatChangedToFitValueMessage &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< FormatChangedToFitValueMessage >
static constexpr bool	notifies_all
Protected Member Functions inherited from NumericConverter
bool	UpdateFormatter ()
virtual void	OnFormatUpdated (bool resetFocus)
Protected Member Functions inherited from Observer::Publisher< FormatChangedToFitValueMessage >
CallbackReturn	Publish (const FormatChangedToFitValueMessage &message)
	Send a message to connected callbacks. More...
Protected Attributes inherited from NumericConverter
FormatterContext	mContext
NumericConverterType	mType
double	mMinValue { 0.0 }
double	mMaxValue { std::numeric_limits<double>::max() }
double	mInvalidValue { -1 }
double	mValue { mInvalidValue }
std::unique_ptr< NumericConverterFormatter >	mFormatter
NumericFormatID	mFormatID
TranslatableString	mCustomFormat
wxString	mValueString
std::vector< wxString >	mFieldValueStrings
Observer::Subscription	mFormatUpdatedSubscription

Detailed Description

Definition at line 34 of file NumericTextCtrl.h.

Constructor & Destructor Documentation

NumericTextCtrl()

NumericTextCtrl::NumericTextCtrl	(	const FormatterContext &	context,
		wxWindow *	parent,
		wxWindowID	winid,
		NumericConverterType	type,
		const NumericFormatID &	formatName = {},
		double	value = 0.0,
		const Options &	options = {},
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize
	)

Definition at line 145 of file NumericTextCtrl.cpp.

                                              :
   wxControl(parent, id, pos, size, wxWANTS_CHARS),
   NumericConverter(context, type, formatName, timeValue),
   mBackgroundBitmap{},
   mDigitFont{},
   mLabelFont{},
   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 ? 16 : 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.formatSymbol.empty())
      SetFormatName( options.formatSymbol );
 
   if (!options.customFormat.empty())
      SetCustomFormat( options.customFormat );
 
   if (options.hasValue)
      SetValue( options.value );
}

~NumericTextCtrl()

NumericTextCtrl::~NumericTextCtrl ( )

virtual

Definition at line 208 of file NumericTextCtrl.cpp.

{
}

Member Function Documentation

ComputeSizing()

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

Definition at line 314 of file NumericTextCtrl.cpp.

{
   if (!mFormatter)
      return {};
 
   // 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);
   }
 
   auto& prefix = mFormatter->GetPrefix();
   auto& fields = mFormatter->GetFields();
 
   // Get the width of the prefix, if any
   dc.GetTextExtent(prefix, &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 = prefix.length();
 
      mBoxes.clear();
      // No need to clear - all the data will be reinitialized anyway
      mFieldPositions.resize(fields.size());
 
      // Figure out the x-position of each field and label in the box
      for (int i = 0, fcnt = fields.size(); i < fcnt; ++i) {
         // Get the size of the label
         dc.GetTextExtent(fields[i].label, &strW, &strH);
 
         // Remember this field's x-position
         mFieldPositions[i].fieldX = x;
 
         // Remember metrics for each digit
         for (int j = 0, dcnt = fields[i].digits; j < dcnt; ++j) {
            mBoxes.push_back(wxRect { x, mBorderTop, boxW, boxH });
            x += boxW;
            pos++;
         }
 
         // Remember the label's x-position
         mFieldPositions[i].labelX = x;
 
         // Bump to end of label
         x += strW;
 
         // Remember the label's width
         mFieldPositions[i].fieldW = x;
 
         // Bump character position to end of label
         pos += fields[i].label.length();
      }
   }
   else {
      // Determine the maximum x-position (length) of the remaining fields
      for (int i = 0, fcnt = fields.size(); i < fcnt; ++i) {
         // Get the size of the label
         dc.GetTextExtent(fields[i].label, &strW, &strH);
 
         // Just bump to next field
         x += (boxW * fields[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, mBoxes, mButtonWidth, mDigitBoxH, mDigitBoxW, mDigitFont, mDigitH, mDigitW, mFieldPositions, NumericConverter::mFormatter, mHeight, mLabelFont, mWidth, and wxT().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ControlsToValue()

void NumericTextCtrl::ControlsToValue ( )

overrideprivatevirtual

Reimplemented from NumericConverter.

Definition at line 976 of file NumericTextCtrl.cpp.

{
   NumericConverter::ControlsToValue();
}

References NumericConverter::ControlsToValue().

Referenced by HandleFormatterChanged(), OnKeyDown(), 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 287 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 498 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(), HandleFormatterChanged(), and SetDigitSize().

Here is the caller graph for this function:

GetBox()

wxRect NumericTextCtrl::GetBox ( size_t  ii ) const

private

Definition at line 981 of file NumericTextCtrl.cpp.

{
   if (ii < mBoxes.size())
      return mBoxes[ii];
   return {};
}

References mBoxes.

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

Here is the caller graph for this function:

GetDigitSize()

wxSize NumericTextCtrl::GetDigitSize ( )

inline

Definition at line 100 of file NumericTextCtrl.h.

{ 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 99 of file NumericTextCtrl.h.

{ 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 111 of file NumericTextCtrl.h.

{ return mFocusedDigit; }

HandleFormatterChanged()

void NumericTextCtrl::HandleFormatterChanged ( bool  resetFocus )

private

Definition at line 696 of file NumericTextCtrl.cpp.

{
   const auto boxesCount = mBoxes.size();
   mBoxes.clear();
 
   Layout();
   Fit();
   ValueToControls();
   ControlsToValue();
 
   const auto newBoxesCount = mBoxes.size();
 
   if (resetFocus || boxesCount > newBoxesCount)
   {
      // Handle the case when format was changed as a result of
      // user action or if the format shrunk for some reason
      UpdateAutoFocus();
   }
   else
   {
      // Try to keep the focus on the same digit
      mFocusedDigit += newBoxesCount - boxesCount;
      // Perform sanity check for the focused digit index
      if (mFocusedDigit >= newBoxesCount)
         UpdateAutoFocus();
   }
}

References ControlsToValue(), Fit(), Layout(), mBoxes, mFocusedDigit, UpdateAutoFocus(), and ValueToControls().

Referenced by OnFormatUpdated(), SetCustomFormat(), SetFormatName(), and SetTypeAndFormatName().

Here is the call graph for this function:

Here is the caller graph for this function:

Layout()

bool NumericTextCtrl::Layout ( )

override

Definition at line 435 of file NumericTextCtrl.cpp.

{
   if (!mFormatter)
      return {};
 
   ComputeSizing();
 
   auto& prefix = mFormatter->GetPrefix();
   auto& fields = mFormatter->GetFields();
   auto& digits = mFormatter->GetDigitInfos();
 
   wxMemoryDC memDC;
   wxCoord strW, strH;
   memDC.SetFont(*mLabelFont);
   memDC.GetTextExtent(prefix, &strW, &strH);
 
   int i;
 
   // Draw the background bitmap - it contains black boxes where
   // all of the digits go and all of the other text
   wxPen Pen;
   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(prefix, mBorderLeft, labelTop);
 
   theTheme.SetBrushColour( Brush, clrTimeBack );
   memDC.SetBrush(Brush);
 
   for(i = 0; i < digits.size(); i++)
      memDC.DrawRectangle(GetBox(i));
   memDC.SetBrush( wxNullBrush );
 
   for(i = 0; i < fields.size(); i++)
      memDC.DrawText(fields[i].label, mFieldPositions[i].labelX, labelTop);
 
   if (mMenuEnabled) {
      theTheme.SetPenColour( Pen, clrTimeFont );
      theTheme.SetBrushColour( Brush, clrTimeFont );
      memDC.SetPen(Pen);
      memDC.SetBrush(Brush);
      AColor::Arrow(memDC,
                    mWidth + 5,
                    (mHeight / 2) - 2,
                    mButtonWidth - 7);
   }
   return true;
}

References AColor::Arrow(), ThemeBase::Colour(), ComputeSizing(), GetBox(), mBackgroundBitmap, mBorderLeft, mBorderTop, mButtonWidth, mDigitBoxH, mDigitH, mFieldPositions, NumericConverter::mFormatter, mHeight, mLabelFont, mMenuEnabled, mWidth, ThemeBase::SetBrushColour(), ThemeBase::SetPenColour(), theTheme, and wxT().

Referenced by EnableMenu(), HandleFormatterChanged(), SpectralSelectionBar::Populate(), and SetDigitSize().

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 724 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 566 of file NumericTextCtrl.cpp.

{
 
   if (!mMenuEnabled) {
      event.Skip();
      return;
   }
 
   wxMenu menu;
 
   SetFocus();
 
   std::vector<NumericFormatID> symbols;
 
   NumericConverterRegistry::Visit(
      mContext,
      mType,
      [&menu, &symbols, this, i = ID_MENU](auto& item) mutable
      {
         const auto ID = item.symbol.Internal();
         symbols.push_back(ID);
         menu.AppendRadioItem(i, item.symbol.Translation());
 
         if (mFormatID == ID)
            menu.Check(i, true);
 
         ++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.
   auto menuIndex = ID_MENU;
 
   int eventType = 0;
 
   if (mType == NumericConverterType_TIME())
      eventType = EVT_TIMETEXTCTRL_UPDATED;
   else if (mType == NumericConverterType_FREQUENCY())
      eventType = EVT_FREQUENCYTEXTCTRL_UPDATED;
   else if (mType == NumericConverterType_BANDWIDTH())
      eventType = EVT_BANDWIDTHTEXTCTRL_UPDATED;
   else
   {
      assert(false); // unsupported control type, skip it
      return;
   }
 
   for (const auto& symbol : symbols)
   {
      if (!menu.IsChecked(menuIndex++) || mFormatID == symbol)
         continue;
         
      SetFormatName(symbol);
 
      wxCommandEvent e(eventType, GetId());
      e.SetString(symbol.GET());
      GetParent()->GetEventHandler()->AddPendingEvent(e);
 
      break;
   }
}

References ID_MENU, NumericConverter::mContext, NumericConverter::mFormatID, mMenuEnabled, mType, NumericConverterType_BANDWIDTH(), NumericConverterType_FREQUENCY(), NumericConverterType_TIME(), BasicMenu::Handle::Popup(), BasicUI::SetFocus(), SetFormatName(), and NumericConverterRegistry::Visit().

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 509 of file NumericTextCtrl.cpp.

{
   // Ignore it to prevent flashing
}

OnFocus()

void NumericTextCtrl::OnFocus ( wxFocusEvent &  event )

private

Definition at line 679 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 mFocusedDigit, KeyboardCapture::OnFocus(), and UpdateAutoFocus().

Here is the call graph for this function:

OnFormatUpdated()

void NumericTextCtrl::OnFormatUpdated ( bool  resetFocus )

overrideprivatevirtual

Reimplemented from NumericConverter.

Definition at line 690 of file NumericTextCtrl.cpp.

{
   NumericConverter::OnFormatUpdated(resetFocus);
   HandleFormatterChanged(resetFocus);
}

References HandleFormatterChanged(), and NumericConverter::OnFormatUpdated().

Here is the call graph for this function:

OnKeyDown()

void NumericTextCtrl::OnKeyDown ( wxKeyEvent &  event )

private

Definition at line 776 of file NumericTextCtrl.cpp.

{
   if (!mFormatter || mBoxes.size() == 0)
   {
      mFocusedDigit = 0;
      return;
   }
 
   event.Skip(false);
 
   int keyCode = event.GetKeyCode();
   int digit = mFocusedDigit;
 
   if (mFocusedDigit < 0)
      mFocusedDigit = 0;
   if (mFocusedDigit >= (int)mBoxes.size())
      mFocusedDigit = mBoxes.size() - 1;
 
   // Convert numeric keypad entries.
   if ((keyCode >= WXK_NUMPAD0) && (keyCode <= WXK_NUMPAD9))
      keyCode -= WXK_NUMPAD0 - '0';
 
   auto& digits = mFormatter->GetDigitInfos();
 
   if (!mReadOnly && (keyCode >= '0' && keyCode <= '9' && !event.HasAnyModifiers())) {
      int digitPosition = digits[mFocusedDigit].pos;
      if (mValueString[digitPosition] == wxChar('-')) {
         mValue = std::max(mMinValue, std::min(mMaxValue, 0.0));
         ValueToControls();
         // Beware relocation of the string
         digitPosition = digits[mFocusedDigit].pos;
      }
      mValueString[digitPosition] = wxChar(keyCode);
      ControlsToValue();
      Refresh();// Force an update of the control. [Bug 1497]
      ValueToControls();
      mFocusedDigit = (mFocusedDigit + 1) % (digits.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 += digits.size();
      mFocusedDigit %= digits.size();
      wxString::reference theDigit = mValueString[digits[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 += digits.size();
      mFocusedDigit %= digits.size();
      Refresh();
   }
 
   else if (keyCode == WXK_RIGHT) {
      mFocusedDigit++;
      mFocusedDigit %= digits.size();
      Refresh();
   }
 
   else if (keyCode == WXK_HOME) {
      mFocusedDigit = 0;
      Refresh();
   }
 
   else if (keyCode == WXK_END) {
      mFocusedDigit = digits.size() - 1;
      Refresh();
   }
 
   else if (!mReadOnly && keyCode == WXK_UP) {
      Adjust(1, 1, mFocusedDigit);
      Updated();
   }
 
   else if (!mReadOnly && keyCode == WXK_DOWN) {
      Adjust(1, -1, mFocusedDigit);
      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, mBoxes, mFocusedDigit, NumericConverter::mFormatter, 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 758 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 637 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 < mBoxes.size(); i++) {
         int dist = abs(event.m_x - (GetBox(i).x +
                                     GetBox(i).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, mFocusedDigit);
      Updated();
 
      Refresh();
   }
}

References NumericConverter::Adjust(), GetBox(), mBoxes, mFocusedDigit, mMenuEnabled, mReadOnly, mScrollRemainder, mWidth, OnContext(), BasicUI::SetFocus(), and Updated().

Here is the call graph for this function:

OnPaint()

void NumericTextCtrl::OnPaint ( wxPaintEvent &  event )

private

Definition at line 514 of file NumericTextCtrl.cpp.

{
   if (!mFormatter)
      return;
 
   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 );
 
   auto& digits = mFormatter->GetDigitInfos();
   auto digitsCount = int(digits.size());
   int i;
   for(i = 0; i < digits.size(); i++) {
      wxRect box = GetBox(i);
      if (focused && mFocusedDigit == i) {
         dc.DrawRectangle(box);
         dc.SetTextForeground(theTheme.Colour( clrTimeFontFocus ));
         dc.SetTextBackground(theTheme.Colour( clrTimeBackFocus ));
      }
      int pos = digits[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(), BasicUI::FindFocus(), GetBox(), mBackgroundBitmap, mDigitBoxH, mDigitBoxW, mDigitFont, mDigitH, mDigitW, mFocusedDigit, NumericConverter::mFormatter, mHeight, NumericConverter::mValueString, mWidth, ThemeBase::SetBrushColour(), ThemeBase::SetPenColour(), and theTheme.

Here is the call graph for this function:

SetCustomFormat()

bool NumericTextCtrl::SetCustomFormat

(

const TranslatableString &

customFormat

)

Definition at line 257 of file NumericTextCtrl.cpp.

{
   if (!NumericConverter::SetCustomFormat(customFormat))
   return false;
 
   HandleFormatterChanged(true);
 
   return true;
}

References HandleFormatterChanged(), and NumericConverter::SetCustomFormat().

Here is the call graph for this function:

SetDigitSize()

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

Definition at line 274 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 907 of file NumericTextCtrl.cpp.

{
#if wxUSE_ACCESSIBILITY
   if (!mFormatter || mBoxes.size() == 0)
   {
      mFocusedDigit = 0;
      return;
   }
   mFocusedDigit = digit;
 
   GetAccessible()->NotifyEvent(wxACC_EVENT_OBJECT_FOCUS,
                                this,
                                wxOBJID_CLIENT,
                                mFocusedDigit + 1);
#endif
}

References mBoxes, mFocusedDigit, and NumericConverter::mFormatter.

Referenced by OnKeyDown().

Here is the caller graph for this function:

SetFormatName()

bool NumericTextCtrl::SetFormatName

(

const NumericFormatID &

formatName

)

Definition at line 247 of file NumericTextCtrl.cpp.

{
   if (!NumericConverter::SetFormatName(formatName))
      return false;
 
   HandleFormatterChanged(true);
 
   return true;
}

References HandleFormatterChanged(), and NumericConverter::SetFormatName().

Referenced by OnContext(), EffectChangeSpeed::OnTimeCtrlUpdate(), TimeToolBar::SetAudioTimeFormat(), SpectralSelectionBar::SetBandwidthSelectionFormatName(), SpectralSelectionBar::SetFrequencySelectionFormatName(), TimeDialog::TransferDataToWindow(), EffectChangeSpeed::TransferDataToWindow(), and EffectChangeSpeed::Update_TimeCtrl_ToLength().

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 305 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 212 of file NumericTextCtrl.cpp.

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

References name.

Referenced by LV2Editor::BuildPlain(), VSTEditor::BuildPlain(), SpectralSelectionBar::Populate(), TimeToolBar::Populate(), LadspaEditor::PopulateUI(), and VST3Editor::VST3Editor().

Here is the caller graph for this function:

SetReadOnly()

void NumericTextCtrl::SetReadOnly

(

bool

readOnly = true

)

Definition at line 282 of file NumericTextCtrl.cpp.

{
   mReadOnly = readOnly;
}

References mReadOnly.

Referenced by TimeToolBar::Populate().

Here is the caller graph for this function:

SetTypeAndFormatName()

bool NumericTextCtrl::SetTypeAndFormatName	(	const NumericConverterType &	type,
		const NumericFormatID &	formatName
	)

Definition at line 237 of file NumericTextCtrl.cpp.

{
   if (!NumericConverter::SetTypeAndFormatName(type, formatName))
      return false;
 
   HandleFormatterChanged(true);
 
   return true;
}

References HandleFormatterChanged(), and NumericConverter::SetTypeAndFormatName().

Here is the call graph for this function:

SetValue()

void NumericTextCtrl::SetValue

(

double

newValue

)

Definition at line 267 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(), TimerRecordDialog::UpdateEnd(), and SpectralSelectionBar::ValuesToControls().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateAutoFocus()

void NumericTextCtrl::UpdateAutoFocus ( )

private

Definition at line 220 of file NumericTextCtrl.cpp.

{
   if (!mAutoPos || !mFormatter)
      return;
 
   auto& digits = mFormatter->GetDigitInfos();
 
   mFocusedDigit = 0;
   while (mFocusedDigit < ((int)digits.size() - 1)) {
      wxChar dgt = mValueString[digits[mFocusedDigit].pos];
      if (dgt != '0') {
         break;
      }
      mFocusedDigit++;
   }
}

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

Referenced by HandleFormatterChanged(), and OnFocus().

Here is the caller graph for this function:

Updated()

void NumericTextCtrl::Updated ( bool  keyup = false )

private

Definition at line 924 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 (!mFormatter || mBoxes.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 mBoxes, mFocusedDigit, NumericConverter::mFormatter, 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 958 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 HandleFormatterChanged(), OnKeyDown(), 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 37 of file NumericTextCtrl.h.

Member Data Documentation

mAllowInvalidValue

bool NumericTextCtrl::mAllowInvalidValue

private

Definition at line 178 of file NumericTextCtrl.h.

Referenced by OnKeyDown(), and SetInvalidValue().

mAutoPos

bool NumericTextCtrl::mAutoPos

private

Definition at line 171 of file NumericTextCtrl.h.

Referenced by UpdateAutoFocus().

mBackgroundBitmap

std::unique_ptr<wxBitmap> NumericTextCtrl::mBackgroundBitmap

private

Definition at line 153 of file NumericTextCtrl.h.

Referenced by Layout(), and OnPaint().

mBorderBottom

int NumericTextCtrl::mBorderBottom

private

Definition at line 163 of file NumericTextCtrl.h.

Referenced by ComputeSizing().

mBorderLeft

int NumericTextCtrl::mBorderLeft

private

Definition at line 160 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and Layout().

mBorderRight

int NumericTextCtrl::mBorderRight

private

Definition at line 162 of file NumericTextCtrl.h.

Referenced by ComputeSizing().

mBorderTop

int NumericTextCtrl::mBorderTop

private

Definition at line 161 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and Layout().

mBoxes

std::vector<wxRect> NumericTextCtrl::mBoxes

private

Definition at line 145 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), GetBox(), HandleFormatterChanged(), OnKeyDown(), OnMouse(), SetFieldFocus(), and Updated().

mButtonWidth

int NumericTextCtrl::mButtonWidth

private

Definition at line 166 of file NumericTextCtrl.h.

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

mDigitBoxH

int NumericTextCtrl::mDigitBoxH

private

Definition at line 157 of file NumericTextCtrl.h.

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

mDigitBoxW

int NumericTextCtrl::mDigitBoxW

private

Definition at line 156 of file NumericTextCtrl.h.

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

mDigitFont

std::unique_ptr<wxFont> NumericTextCtrl::mDigitFont

private

Definition at line 155 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and OnPaint().

mDigitH

int NumericTextCtrl::mDigitH

private

Definition at line 159 of file NumericTextCtrl.h.

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

mDigitW

int NumericTextCtrl::mDigitW

private

Definition at line 158 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and OnPaint().

mFieldPositions

std::vector<FieldPosition> NumericTextCtrl::mFieldPositions

private

Definition at line 146 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and Layout().

mFocusedDigit

int NumericTextCtrl::mFocusedDigit { 0 }

private

Definition at line 168 of file NumericTextCtrl.h.

Referenced by HandleFormatterChanged(), OnFocus(), OnKeyDown(), OnMouse(), OnPaint(), SetFieldFocus(), UpdateAutoFocus(), and Updated().

mHeight

int NumericTextCtrl::mHeight

private

Definition at line 165 of file NumericTextCtrl.h.

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

mLabelFont

std::unique_ptr<wxFont> NumericTextCtrl::mLabelFont

private

Definition at line 155 of file NumericTextCtrl.h.

Referenced by ComputeSizing(), and Layout().

mMenuEnabled

bool NumericTextCtrl::mMenuEnabled

private

Definition at line 150 of file NumericTextCtrl.h.

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

mReadOnly

bool NumericTextCtrl::mReadOnly

private

Definition at line 151 of file NumericTextCtrl.h.

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

mScrollRemainder

double NumericTextCtrl::mScrollRemainder

private

Definition at line 174 of file NumericTextCtrl.h.

Referenced by OnMouse().

mType

NumericConverterType NumericTextCtrl::mType

private

Definition at line 176 of file NumericTextCtrl.h.

Referenced by OnContext().

mWidth

int NumericTextCtrl::mWidth

private

Definition at line 164 of file NumericTextCtrl.h.

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

---

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

• NumericTextCtrl.h
• NumericTextCtrl.cpp