// Created: 29.01.01
// RCS-ID: $Id$
// Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// License: wxWindows licence
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
#endif //WX_PRECOMP
#include "wx/spinctrl.h"
+#include "wx/tooltip.h"
#if wxUSE_SPINCTRL
// constants
// ----------------------------------------------------------------------------
-// the margin between the text control and the spin
-static const wxCoord MARGIN = 2;
+// The margin between the text control and the spin: the value here is the same
+// as the margin between the spin button and its "buddy" text control in wxMSW
+// so the generic control looks similarly to the native one there, we might
+// need to use different value for the other platforms (and maybe even
+// determine it dynamically?).
+static const wxCoord MARGIN = 1;
#define SPINCTRLBUT_MAX 32000 // large to avoid wrap around trouble
// ----------------------------------------------------------------------------
-// wxSpinCtrlText: text control used by spin control
+// wxSpinCtrlTextGeneric: text control used by spin control
// ----------------------------------------------------------------------------
-class wxSpinCtrlText : public wxTextCtrl
+class wxSpinCtrlTextGeneric : public wxTextCtrl
{
public:
- wxSpinCtrlText(wxSpinCtrlGenericBase *spin, const wxString& value)
- : wxTextCtrl(spin->GetParent(), wxID_ANY, value, wxDefaultPosition,
- wxDefaultSize, wxTE_NOHIDESEL|wxTE_PROCESS_ENTER)
+ wxSpinCtrlTextGeneric(wxSpinCtrlGenericBase *spin, const wxString& value, long style=0)
+ : wxTextCtrl(spin->GetParent(), wxID_ANY, value, wxDefaultPosition, wxDefaultSize,
+ style & wxALIGN_MASK)
{
m_spin = spin;
SetSizeHints(wxDefaultCoord, wxDefaultCoord);
}
- virtual ~wxSpinCtrlText()
+ virtual ~wxSpinCtrlTextGeneric()
{
// MSW sends extra kill focus event on destroy
if (m_spin)
m_spin = NULL;
}
- void OnTextEnter(wxCommandEvent& event)
- {
- if (m_spin)
- m_spin->OnTextEnter(event);
- }
-
void OnChar( wxKeyEvent &event )
{
if (m_spin)
- m_spin->OnTextChar(event);
+ m_spin->ProcessWindowEvent(event);
}
void OnKillFocus(wxFocusEvent& event)
{
if (m_spin)
- {
- m_spin->SyncSpinToText();
- m_spin->DoSendEvent();
- }
+ m_spin->ProcessWindowEvent(event);
event.Skip();
}
DECLARE_EVENT_TABLE()
};
-BEGIN_EVENT_TABLE(wxSpinCtrlText, wxTextCtrl)
- EVT_TEXT_ENTER(wxID_ANY, wxSpinCtrlText::OnTextEnter)
+BEGIN_EVENT_TABLE(wxSpinCtrlTextGeneric, wxTextCtrl)
+ EVT_CHAR(wxSpinCtrlTextGeneric::OnChar)
- EVT_CHAR(wxSpinCtrlText::OnChar)
-
- EVT_KILL_FOCUS(wxSpinCtrlText::OnKillFocus)
+ EVT_KILL_FOCUS(wxSpinCtrlTextGeneric::OnKillFocus)
END_EVENT_TABLE()
// ----------------------------------------------------------------------------
-// wxSpinCtrlButton: spin button used by spin control
+// wxSpinCtrlButtonGeneric: spin button used by spin control
// ----------------------------------------------------------------------------
-class wxSpinCtrlButton : public wxSpinButton
+class wxSpinCtrlButtonGeneric : public wxSpinButton
{
public:
- wxSpinCtrlButton(wxSpinCtrlGenericBase *spin, int style)
+ wxSpinCtrlButtonGeneric(wxSpinCtrlGenericBase *spin, int style)
: wxSpinButton(spin->GetParent(), wxID_ANY, wxDefaultPosition,
wxDefaultSize, style | wxSP_VERTICAL)
{
DECLARE_EVENT_TABLE()
};
-BEGIN_EVENT_TABLE(wxSpinCtrlButton, wxSpinButton)
- EVT_SPIN_UP( wxID_ANY, wxSpinCtrlButton::OnSpinButton)
- EVT_SPIN_DOWN(wxID_ANY, wxSpinCtrlButton::OnSpinButton)
+BEGIN_EVENT_TABLE(wxSpinCtrlButtonGeneric, wxSpinButton)
+ EVT_SPIN_UP( wxID_ANY, wxSpinCtrlButtonGeneric::OnSpinButton)
+ EVT_SPIN_DOWN(wxID_ANY, wxSpinCtrlButtonGeneric::OnSpinButton)
END_EVENT_TABLE()
// ============================================================================
// the text control borders (but we might want to use style border bits to
// select the text control style)
if ( !wxControl::Create(parent, id, wxDefaultPosition, wxDefaultSize,
- wxBORDER_NONE, wxDefaultValidator, name) )
+ (style & ~wxBORDER_MASK) | wxBORDER_NONE,
+ wxDefaultValidator, name) )
{
return false;
}
m_max = max;
m_increment = increment;
- m_textCtrl = new wxSpinCtrlText(this, value);
- m_spinButton = new wxSpinCtrlButton(this, style);
+ m_textCtrl = new wxSpinCtrlTextGeneric(this, value, style);
+ m_spinButton = new wxSpinCtrlButtonGeneric(this, style);
+#if wxUSE_TOOLTIPS
+ m_textCtrl->SetToolTip(GetToolTipText());
+ m_spinButton->SetToolTip(GetToolTipText());
+#endif // wxUSE_TOOLTIPS
m_spin_value = m_spinButton->GetValue();
if (m_textCtrl)
{
- // null this since MSW sends KILL_FOCUS on deletion, see ~wxSpinCtrlText
- wxDynamicCast(m_textCtrl, wxSpinCtrlText)->m_spin = NULL;
+ // null this since MSW sends KILL_FOCUS on deletion, see ~wxSpinCtrlTextGeneric
+ wxDynamicCast(m_textCtrl, wxSpinCtrlTextGeneric)->m_spin = NULL;
- wxSpinCtrlText *text = (wxSpinCtrlText*)m_textCtrl;
+ wxSpinCtrlTextGeneric *text = (wxSpinCtrlTextGeneric*)m_textCtrl;
m_textCtrl = NULL;
delete text;
}
- delete m_spinButton;
- m_spinButton = NULL;
+ wxDELETE(m_spinButton);
}
// ----------------------------------------------------------------------------
// position the subcontrols inside the client area
wxSize sizeBtn = m_spinButton->GetSize();
- wxCoord wText = width - sizeBtn.x;
+ wxCoord wText = width - sizeBtn.x - MARGIN;
m_textCtrl->SetSize(x, y, wText, height);
m_spinButton->SetSize(x + wText + MARGIN, y, wxDefaultCoord, height);
}
// operations forwarded to the subcontrols
// ----------------------------------------------------------------------------
+void wxSpinCtrlGenericBase::SetFocus()
+{
+ if ( m_textCtrl )
+ m_textCtrl->SetFocus();
+}
+
bool wxSpinCtrlGenericBase::Enable(bool enable)
{
- if ( !wxControl::Enable(enable) )
+ // Notice that we never enable this control itself, it must stay disabled
+ // to avoid interfering with the siblings event handling (see e.g. #12045
+ // for the kind of problems which arise otherwise).
+ if ( enable == m_isEnabled )
return false;
+ m_isEnabled = enable;
+
m_spinButton->Enable(enable);
m_textCtrl->Enable(enable);
return true;
}
-bool wxSpinCtrlGenericBase::Reparent(wxWindow *newParent)
+bool wxSpinCtrlGenericBase::Reparent(wxWindowBase *newParent)
{
if ( m_spinButton )
{
return true;
}
+#if wxUSE_TOOLTIPS
+void wxSpinCtrlGenericBase::DoSetToolTip(wxToolTip *tip)
+{
+ // Notice that we must check for the subcontrols not being NULL (as they
+ // could be if we were created with the default ctor and this is called
+ // before Create() for some reason) and that we can't call SetToolTip(tip)
+ // because this would take ownership of the wxToolTip object (twice).
+ if ( m_textCtrl )
+ {
+ if ( tip )
+ m_textCtrl->SetToolTip(tip->GetTip());
+ else
+ m_textCtrl->SetToolTip(NULL);
+ }
+
+ if ( m_spinButton )
+ {
+ if( tip )
+ m_spinButton->SetToolTip(tip->GetTip());
+ else
+ m_spinButton->SetToolTip(NULL);
+ }
+
+ wxWindowBase::DoSetToolTip(tip);
+}
+#endif // wxUSE_TOOLTIPS
+
// ----------------------------------------------------------------------------
// Handle sub controls events
// ----------------------------------------------------------------------------
+BEGIN_EVENT_TABLE(wxSpinCtrlGenericBase, wxSpinCtrlBase)
+ EVT_CHAR(wxSpinCtrlGenericBase::OnTextChar)
+ EVT_KILL_FOCUS(wxSpinCtrlGenericBase::OnTextLostFocus)
+END_EVENT_TABLE()
+
void wxSpinCtrlGenericBase::OnSpinButton(wxSpinEvent& event)
{
event.Skip();
// Sync the textctrl since the user expects that the button will modify
// what they see in the textctrl.
- if ( m_textCtrl && m_textCtrl->IsModified() )
- SyncSpinToText();
+ SyncSpinToText();
int spin_value = event.GetPosition();
double step = (event.GetEventType() == wxEVT_SCROLL_LINEUP) ? 1 : -1;
if (((spin_value >= 0) && (m_spin_value >= 0)) || ((spin_value <= 0) && (m_spin_value <= 0)))
step *= abs(spin_value - m_spin_value);
- double value = m_value + step*m_increment;
-
- // we can always reach the ends using the spinbutton
- if (value < m_min) value = m_min;
- if (value > m_max) value = m_max;
+ double value = AdjustToFitInRange(m_value + step*m_increment);
// Ignore the edges when it wraps since the up/down event may be opposite
// They are in GTK and Mac
m_spin_value = spin_value;
- if (InRange(value) && DoSetValue(value))
+ if ( DoSetValue(value) )
DoSendEvent();
}
-void wxSpinCtrlGenericBase::OnTextEnter(wxCommandEvent& event)
+void wxSpinCtrlGenericBase::OnTextLostFocus(wxFocusEvent& event)
{
SyncSpinToText();
DoSendEvent();
+
event.Skip();
}
void wxSpinCtrlGenericBase::OnTextChar(wxKeyEvent& event)
{
+ if ( !HasFlag(wxSP_ARROW_KEYS) )
+ {
+ event.Skip();
+ return;
+ }
+
double value = m_value;
switch ( event.GetKeyCode() )
{
return;
}
- if ( m_textCtrl && m_textCtrl->IsModified() )
- SyncSpinToText();
+ value = AdjustToFitInRange(value);
+
+ SyncSpinToText();
if ( DoSetValue(value) )
DoSendEvent();
// Textctrl functions
// ----------------------------------------------------------------------------
-void wxSpinCtrlGenericBase::SyncSpinToText()
+bool wxSpinCtrlGenericBase::SyncSpinToText()
{
- if (!m_textCtrl)
- return;
+ if ( !m_textCtrl || !m_textCtrl->IsModified() )
+ return false;
double textValue;
if ( m_textCtrl->GetValue().ToDouble(&textValue) )
textValue = m_max;
else if (textValue < m_min)
textValue = m_min;
-
- if (m_value != textValue)
- {
- DoSetValue(textValue);
- }
}
- else
+ else // text contents is not a valid number at all
{
- // textctrl is out of sync, discard and reset
- DoSetValue(m_value);
+ // replace its contents with the last valid value
+ textValue = m_value;
}
+
+ // we must always set the value here, even if it's equal to m_value, as
+ // otherwise we could be left with an out of range value when leaving the
+ // text control and the current value is already m_max for example
+ return DoSetValue(textValue);
}
// ----------------------------------------------------------------------------
void wxSpinCtrlGenericBase::SetValue(const wxString& text)
{
- wxCHECK_RET( m_textCtrl, _T("invalid call to wxSpinCtrl::SetValue") );
+ wxCHECK_RET( m_textCtrl, wxT("invalid call to wxSpinCtrl::SetValue") );
double val;
if ( text.ToDouble(&val) && InRange(val) )
{
m_textCtrl->SetValue(text);
m_textCtrl->SetSelection(0, -1);
+ m_textCtrl->SetInsertionPointEnd();
}
}
bool wxSpinCtrlGenericBase::DoSetValue(double val)
{
- wxCHECK_MSG( m_textCtrl, false, _T("invalid call to wxSpinCtrl::SetValue") );
+ wxCHECK_MSG( m_textCtrl, false, wxT("invalid call to wxSpinCtrl::SetValue") );
if (!InRange(val))
return false;
m_value = val;
str.ToDouble( &m_value ); // wysiwyg for textctrl
m_textCtrl->SetValue( str );
+ m_textCtrl->SetInsertionPointEnd();
m_textCtrl->DiscardEdits();
return true;
}
return false;
}
+double wxSpinCtrlGenericBase::AdjustToFitInRange(double value) const
+{
+ if (value < m_min)
+ value = HasFlag(wxSP_WRAP) ? m_max : m_min;
+ if (value > m_max)
+ value = HasFlag(wxSP_WRAP) ? m_min : m_max;
+
+ return value;
+}
+
void wxSpinCtrlGenericBase::DoSetRange(double min, double max)
{
m_min = min;
void wxSpinCtrlGenericBase::SetSelection(long from, long to)
{
- wxCHECK_RET( m_textCtrl, _T("invalid call to wxSpinCtrl::SetSelection") );
+ wxCHECK_RET( m_textCtrl, wxT("invalid call to wxSpinCtrl::SetSelection") );
m_textCtrl->SetSelection(from, to);
}
// wxSpinCtrl
//-----------------------------------------------------------------------------
-IMPLEMENT_DYNAMIC_CLASS(wxSpinCtrl, wxSpinCtrlGenericBase)
-
void wxSpinCtrl::DoSendEvent()
{
wxSpinEvent event( wxEVT_COMMAND_SPINCTRL_UPDATED, GetId());
{
wxCHECK_RET( digits <= 20, "too many digits for wxSpinCtrlDouble" );
+ if ( digits == m_digits )
+ return;
+
+ m_digits = digits;
+
m_format.Printf(wxT("%%0.%ulf"), digits);
DoSetValue(m_value);