NumericTextCtrl Class Reference

#include <NumericTextCtrl.h>

Inheritance diagram for NumericTextCtrl:

Classes
struct	Options

Public Member Functions
	NumericTextCtrl (wxWindow *parent, wxWindowID winid, NumericConverter::Type type, const NumericFormatId &formatName={}, double value=0.0, double sampleRate=44100, const Options &options={}, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize)
virtual	~NumericTextCtrl ()
bool	Layout () override
void	Fit () override
void	SetSampleRate (double sampleRate)
void	SetValue (double newValue)
void	SetFormatString (const wxString &formatString)
void	SetFormatName (const NumericFormatId &formatName)
void	SetFieldFocus (int)
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 NumericFormatId &formatName={}, double value=0.0f, double sampleRate=1.0f)
virtual	~NumericConverter ()
virtual void	ValueToControls (double rawValue, bool nearest=true)
void	PrintDebugInfo ()
void	SetFormatName (const NumericFormatId &formatName)
void	SetFormatString (const wxString &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 ()
NumericFormatId	GetBuiltinName (const int index)
wxString	GetBuiltinFormat (const int index)
wxString	GetBuiltinFormat (const NumericFormatId &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, FREQUENCY, BANDWIDTH }
Static Public Member Functions inherited from NumericConverter
static NumericFormatId	DefaultSelectionFormat ()
static NumericFormatId	TimeAndSampleFormat ()
static NumericFormatId	SecondsFormat ()
static NumericFormatId	HundredthsFormat ()
static NumericFormatId	HertzFormat ()
static NumericFormatId	LookupFormat (Type type, const wxString &id)
Protected Attributes inherited from NumericConverter
Type	mType
double	mValue
double	mMinValue
double	mMaxValue
double	mInvalidValue
wxString	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 152 of file NumericTextCtrl.h.

Constructor & Destructor Documentation

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

Definition at line 1212 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 = 10;
   mDigitBoxH = 16;

   mReadOnly = options.readOnly;
   mMenuEnabled = options.menuEnabled;
   mButtonWidth = 9;

   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(wxT(""));
   SetAccessible(safenew NumericTextCtrlAx(this));
#endif

   if (options.hasInvalidValue)
      SetInvalidValue( options.invalidValue );

   if (!options.format.empty())
      SetFormatString( options.format );

   if (options.hasValue)
      SetValue( options.value );
}

NumericTextCtrl::~NumericTextCtrl ( )

virtual

Definition at line 1266 of file NumericTextCtrl.cpp.

{
}

Member Function Documentation

void NumericTextCtrl::ControlsToValue ( )

overrideprivatevirtual

Reimplemented from NumericConverter.

Definition at line 1886 of file NumericTextCtrl.cpp.

References NumericConverter::ControlsToValue().

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

{
   NumericConverter::ControlsToValue();
}

void NumericTextCtrl::EnableMenu

(

bool

enable = true

)

Definition at line 1324 of file NumericTextCtrl.cpp.

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

{
#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();
}

void NumericTextCtrl::Fit ( )

override

Definition at line 1467 of file NumericTextCtrl.cpp.

References mButtonWidth, mHeight, and mWidth.

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

{
   wxSize sz = GetSize();
   wxSize csz = GetClientSize();

   sz.x = mButtonWidth + mWidth + (sz.x - csz.x);
   sz.y = mHeight + (sz.y - csz.y);

   SetInitialSize(sz);
}

int NumericTextCtrl::GetFocusedDigit ( )

inline

Definition at line 214 of file NumericTextCtrl.h.

References NumericConverter::mFocusedDigit.

{ return mFocusedDigit; }

int NumericTextCtrl::GetFocusedField ( )

inline

Definition at line 213 of file NumericTextCtrl.h.

References mLastField.

{ return mLastField; }

bool NumericTextCtrl::Layout ( )

override

Definition at line 1351 of file NumericTextCtrl.cpp.

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

Referenced by EnableMenu(), SpectralSelectionBar::Populate(), SetFormatString(), and SetSampleRate().

{
   unsigned int i, j;
   int x, pos;

   wxMemoryDC memDC;

   // Placeholder bitmap so the memDC has something to reference
   mBackgroundBitmap = std::make_unique<wxBitmap>(1, 1, 24);
   memDC.SelectObject(*mBackgroundBitmap);

   mDigits.clear();

   mBorderLeft = 1;
   mBorderTop = 1;
   mBorderRight = 1;
   mBorderBottom = 1;

   int fontSize = 4;
   wxCoord strW, strH;
   wxString exampleText = wxT("0");

   // Keep making the font bigger until it's too big, then subtract one.
   memDC.SetFont(wxFont(fontSize, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL));
   memDC.GetTextExtent(exampleText, &strW, &strH);
   while (strW <= mDigitBoxW && strH <= mDigitBoxH) {
      fontSize++;
      memDC.SetFont(wxFont(fontSize, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL));
      memDC.GetTextExtent(exampleText, &strW, &strH);
   }
   fontSize--;

   mDigitFont = std::make_unique<wxFont>(fontSize, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);
   memDC.SetFont(*mDigitFont);
   memDC.GetTextExtent(exampleText, &strW, &strH);
   mDigitW = strW;
   mDigitH = strH;

   // The label font should be a little smaller
   fontSize--;
   mLabelFont = std::make_unique<wxFont>(fontSize, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL);

   // Figure out the x-position of each field and label in the box
   x = mBorderLeft;
   pos = 0;

   memDC.SetFont(*mLabelFont);
   memDC.GetTextExtent(mPrefix, &strW, &strH);
   x += strW;
   pos += mPrefix.Length();

   for(i = 0; i < mFields.size(); i++) {
      mFields[i].fieldX = x;
      for(j=0; j<(unsigned int)mFields[i].digits; j++) {
         mDigits.push_back(DigitInfo(i, j, pos, wxRect(x, mBorderTop,
                                                 mDigitBoxW, mDigitBoxH)));
         x += mDigitBoxW;
         pos++;
      }

      mFields[i].labelX = x;
      memDC.GetTextExtent(mFields[i].label, &strW, &strH);
      pos += mFields[i].label.Length();
      x += strW;
      mFields[i].fieldW = x;
   }

   mWidth = x + mBorderRight;
   mHeight = mDigitBoxH + mBorderTop + mBorderBottom;

   // 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;
}

void NumericTextCtrl::OnCaptureKey ( wxCommandEvent &  event )

private

Definition at line 1641 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')
            return;
   }

   event.Skip();

   return;
}

void NumericTextCtrl::OnContext ( wxContextMenuEvent &  event )

private

Definition at line 1530 of file NumericTextCtrl.cpp.

References NumericConverter::BANDWIDTH, NumericConverter::FREQUENCY, NumericConverter::GetBuiltinFormat(), NumericConverter::GetBuiltinName(), NumericConverter::GetNumBuiltins(), ID_MENU, NumericConverter::mFormatString, mMenuEnabled, mType, SetFormatString(), and NumericConverter::TIME.

Referenced by OnMouse().

{
   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;
      }
   }

   PopupMenu(&menu, wxPoint(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);
      }
   }

}

void NumericTextCtrl::OnErase ( wxEraseEvent &  event )

private

Definition at line 1478 of file NumericTextCtrl.cpp.

{
   // Ignore it to prevent flashing
}

void NumericTextCtrl::OnFocus ( wxFocusEvent &  event )

private

Definition at line 1627 of file NumericTextCtrl.cpp.

References AudacityProject::CaptureKeyboard(), NumericConverter::mFocusedDigit, AudacityProject::ReleaseKeyboard(), and UpdateAutoFocus().

{
   if (event.GetEventType() == wxEVT_KILL_FOCUS) {
      AudacityProject::ReleaseKeyboard(this);
   }
   else {
      AudacityProject::CaptureKeyboard(this);
      if( mFocusedDigit <=0 )
         UpdateAutoFocus();
   }

   Refresh(false);
}

void NumericTextCtrl::OnKeyDown ( wxKeyEvent &  event )

private

Definition at line 1693 of file NumericTextCtrl.cpp.

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

{
   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')) {
      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());
         GetParent()->GetEventHandler()->ProcessEvent(cevent);
      }
   }

   else {
      event.Skip();
      return;
   }

   if (digit != mFocusedDigit) {
      SetFieldFocus(mFocusedDigit);
   }
}

void NumericTextCtrl::OnKeyUp ( wxKeyEvent &  event )

private

Definition at line 1675 of file NumericTextCtrl.cpp.

References Updated().

{
   int keyCode = event.GetKeyCode();

   event.Skip(true);

   if ((keyCode >= WXK_NUMPAD0) && (keyCode <= WXK_NUMPAD9))
      keyCode -= WXK_NUMPAD0 - '0';

   if ((keyCode >= '0' && keyCode <= '9') ||
       (keyCode == WXK_DELETE) ||
       (keyCode == WXK_BACK) ||
       (keyCode == WXK_UP) ||
       (keyCode == WXK_DOWN)) {
      Updated(true);
   }
}

void NumericTextCtrl::OnMouse ( wxMouseEvent &  event )

private

Definition at line 1587 of file NumericTextCtrl.cpp.

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

{
   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();
   }
}

void NumericTextCtrl::OnPaint ( wxPaintEvent &  event )

private

Definition at line 1483 of file NumericTextCtrl.cpp.

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

{
   wxPaintDC 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 );
}

void NumericTextCtrl::SetFieldFocus

(

int

digit

)

Definition at line 1821 of file NumericTextCtrl.cpp.

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

Referenced by OnKeyDown(), and Updated().

{
#if wxUSE_ACCESSIBILITY
   if (mDigits.size() == 0)
   {
      mFocusedDigit = 0;
      return;
   }
   mFocusedDigit = digit;
   mLastField = mDigits[mFocusedDigit].field + 1;

   // This looks strange (and it is), but it was the only way I could come
   // up with that allowed Jaws, Window-Eyes, and NVDA to read the control
   // somewhat the same.  See NumericTextCtrlAx below for even more odd looking
   // hackery.
   //
   // If you change SetFieldFocus(), Updated(), or NumericTextCtrlAx, make sure
   // you test with Jaws, Window-Eyes, and NVDA.
   GetAccessible()->NotifyEvent(wxACC_EVENT_OBJECT_FOCUS,
                                this,
                                wxOBJID_CLIENT,
                                0);
   GetAccessible()->NotifyEvent(wxACC_EVENT_OBJECT_FOCUS,
                                this,
                                wxOBJID_CLIENT,
                                mFocusedDigit + 1);
#endif
}

void NumericTextCtrl::SetFormatName

(

const NumericFormatId &

formatName

)

Definition at line 1288 of file NumericTextCtrl.cpp.

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

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

{
   SetFormatString(GetBuiltinFormat(formatName));
}

void NumericTextCtrl::SetFormatString

(

const wxString &

formatString

)

Definition at line 1293 of file NumericTextCtrl.cpp.

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

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

{
   NumericConverter::SetFormatString(formatString);
   Layout();
   Fit();
   ValueToControls();
   ControlsToValue();
   UpdateAutoFocus();
}

void NumericTextCtrl::SetInvalidValue

(

double

invalidValue

)

Definition at line 1342 of file NumericTextCtrl.cpp.

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

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

void NumericTextCtrl::SetReadOnly

(

bool

readOnly = true

)

Definition at line 1319 of file NumericTextCtrl.cpp.

References mReadOnly.

{
   mReadOnly = readOnly;
}

void NumericTextCtrl::SetSampleRate

(

double

sampleRate

)

Definition at line 1303 of file NumericTextCtrl.cpp.

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

Referenced by TimeDialog::TransferDataToWindow().

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

void NumericTextCtrl::SetValue

(

double

newValue

)

Definition at line 1312 of file NumericTextCtrl.cpp.

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

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

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

void NumericTextCtrl::UpdateAutoFocus ( )

private

Definition at line 1273 of file NumericTextCtrl.cpp.

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

Referenced by OnFocus(), and SetFormatString().

{
   if (!mAutoPos)
      return;

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

void NumericTextCtrl::Updated ( bool  keyup = false )

private

Definition at line 1850 of file NumericTextCtrl.cpp.

References NumericConverter::mFocusedDigit, SetFieldFocus(), and wxEVT_COMMAND_TEXT_UPDATED.

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

{
   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) {
      SetFieldFocus(mFocusedDigit);
   }
#endif
}

void NumericTextCtrl::ValueToControls ( )

overrideprivatevirtual

Reimplemented from NumericConverter.

Definition at line 1868 of file NumericTextCtrl.cpp.

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

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

{
   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);
   }
}

Friends And Related Function Documentation

friend class NumericTextCtrlAx

friend

Definition at line 154 of file NumericTextCtrl.h.

Member Data Documentation

bool NumericTextCtrl::mAllowInvalidValue

private

Definition at line 268 of file NumericTextCtrl.h.

Referenced by OnKeyDown(), and SetInvalidValue().

bool NumericTextCtrl::mAutoPos

private

Definition at line 261 of file NumericTextCtrl.h.

Referenced by UpdateAutoFocus().

std::unique_ptr<wxBitmap> NumericTextCtrl::mBackgroundBitmap

private

Definition at line 243 of file NumericTextCtrl.h.

Referenced by Layout(), and OnPaint().

int NumericTextCtrl::mBorderBottom

private

Definition at line 253 of file NumericTextCtrl.h.

Referenced by Layout().

int NumericTextCtrl::mBorderLeft

private

Definition at line 250 of file NumericTextCtrl.h.

Referenced by Layout().

int NumericTextCtrl::mBorderRight

private

Definition at line 252 of file NumericTextCtrl.h.

Referenced by Layout().

int NumericTextCtrl::mBorderTop

private

Definition at line 251 of file NumericTextCtrl.h.

Referenced by Layout().

int NumericTextCtrl::mButtonWidth

private

Definition at line 256 of file NumericTextCtrl.h.

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

int NumericTextCtrl::mDigitBoxH

private

Definition at line 247 of file NumericTextCtrl.h.

Referenced by Layout(), and OnPaint().

int NumericTextCtrl::mDigitBoxW

private

Definition at line 246 of file NumericTextCtrl.h.

Referenced by Layout(), and OnPaint().

std::unique_ptr<wxFont> NumericTextCtrl::mDigitFont

private

Definition at line 245 of file NumericTextCtrl.h.

Referenced by Layout(), and OnPaint().

int NumericTextCtrl::mDigitH

private

Definition at line 249 of file NumericTextCtrl.h.

Referenced by Layout(), and OnPaint().

int NumericTextCtrl::mDigitW

private

Definition at line 248 of file NumericTextCtrl.h.

Referenced by Layout(), and OnPaint().

int NumericTextCtrl::mHeight

private

Definition at line 255 of file NumericTextCtrl.h.

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

std::unique_ptr<wxFont> NumericTextCtrl::mLabelFont

private

Definition at line 245 of file NumericTextCtrl.h.

Referenced by Layout().

int NumericTextCtrl::mLastField

private

Definition at line 258 of file NumericTextCtrl.h.

Referenced by GetFocusedField(), and SetFieldFocus().

bool NumericTextCtrl::mMenuEnabled

private

Definition at line 240 of file NumericTextCtrl.h.

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

bool NumericTextCtrl::mReadOnly

private

Definition at line 241 of file NumericTextCtrl.h.

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

double NumericTextCtrl::mScrollRemainder

private

Definition at line 264 of file NumericTextCtrl.h.

Referenced by OnMouse().

NumericConverter::Type NumericTextCtrl::mType

private

Definition at line 266 of file NumericTextCtrl.h.

Referenced by OnContext().

int NumericTextCtrl::mWidth

private

Definition at line 254 of file NumericTextCtrl.h.

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

---

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

• NumericTextCtrl.h
• NumericTextCtrl.cpp