b736d59eb5
After the changes of r53758 wxMSW didn't generate any wxEVT_TEXT events but this was still the case for the generic version (and hence for wxSpinCtrlDouble under MSW too) and wasn't documented. Fix all versions to avoid sending events for programmatic actions, add unit tests checking this behaviour and document it. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74631 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
433 lines
14 KiB
C++
433 lines
14 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/generic/spinctlg.h
|
|
// Purpose: generic wxSpinCtrl class
|
|
// Author: Vadim Zeitlin
|
|
// Modified by:
|
|
// Created: 28.10.99
|
|
// Copyright: (c) Vadim Zeitlin
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_GENERIC_SPINCTRL_H_
|
|
#define _WX_GENERIC_SPINCTRL_H_
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxSpinCtrl is a combination of wxSpinButton and wxTextCtrl, so if
|
|
// wxSpinButton is available, this is what we do - but if it isn't, we still
|
|
// define wxSpinCtrl class which then has the same appearance as wxTextCtrl but
|
|
// the different interface. This allows to write programs using wxSpinCtrl
|
|
// without tons of #ifdefs.
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#if wxUSE_SPINBTN
|
|
|
|
#include "wx/compositewin.h"
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxSpinButton;
|
|
class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
|
|
|
|
class wxSpinCtrlTextGeneric; // wxTextCtrl used for the wxSpinCtrlGenericBase
|
|
|
|
// The !wxUSE_SPINBTN version's GetValue() function conflicts with the
|
|
// wxTextCtrl's GetValue() and so you have to input a dummy int value.
|
|
#define wxSPINCTRL_GETVALUE_FIX
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxSpinCtrlGeneric is a combination of wxTextCtrl and wxSpinButton
|
|
//
|
|
// This class manages a double valued generic spinctrl through the DoGet/SetXXX
|
|
// functions that are made public as Get/SetXXX functions for int or double
|
|
// for the wxSpinCtrl and wxSpinCtrlDouble classes respectively to avoid
|
|
// function ambiguity.
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_CORE wxSpinCtrlGenericBase
|
|
: public wxNavigationEnabled<wxCompositeWindow<wxSpinCtrlBase> >
|
|
{
|
|
public:
|
|
wxSpinCtrlGenericBase() { Init(); }
|
|
|
|
bool Create(wxWindow *parent,
|
|
wxWindowID id = wxID_ANY,
|
|
const wxString& value = wxEmptyString,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
|
|
double min = 0, double max = 100, double initial = 0,
|
|
double inc = 1,
|
|
const wxString& name = wxT("wxSpinCtrl"));
|
|
|
|
virtual ~wxSpinCtrlGenericBase();
|
|
|
|
// accessors
|
|
// T GetValue() const
|
|
// T GetMin() const
|
|
// T GetMax() const
|
|
// T GetIncrement() const
|
|
virtual bool GetSnapToTicks() const { return m_snap_to_ticks; }
|
|
// unsigned GetDigits() const - wxSpinCtrlDouble only
|
|
|
|
// operations
|
|
virtual void SetValue(const wxString& text);
|
|
// void SetValue(T val)
|
|
// void SetRange(T minVal, T maxVal)
|
|
// void SetIncrement(T inc)
|
|
virtual void SetSnapToTicks(bool snap_to_ticks);
|
|
// void SetDigits(unsigned digits) - wxSpinCtrlDouble only
|
|
|
|
// Select text in the textctrl
|
|
void SetSelection(long from, long to);
|
|
|
|
// implementation from now on
|
|
|
|
// forward these functions to all subcontrols
|
|
virtual bool Enable(bool enable = true);
|
|
virtual bool Show(bool show = true);
|
|
#if wxUSE_TOOLTIPS
|
|
virtual void DoSetToolTip(wxToolTip *tip);
|
|
#endif // wxUSE_TOOLTIPS
|
|
|
|
virtual bool SetBackgroundColour(const wxColour& colour);
|
|
|
|
// get the subcontrols
|
|
wxTextCtrl *GetText() const { return m_textCtrl; }
|
|
wxSpinButton *GetSpinButton() const { return m_spinButton; }
|
|
|
|
// forwarded events from children windows
|
|
void OnSpinButton(wxSpinEvent& event);
|
|
void OnTextLostFocus(wxFocusEvent& event);
|
|
void OnTextChar(wxKeyEvent& event);
|
|
|
|
// this window itself is used only as a container for its sub windows so it
|
|
// shouldn't accept the focus at all and any attempts to explicitly set
|
|
// focus to it should give focus to its text constol part
|
|
virtual bool AcceptsFocus() const { return false; }
|
|
virtual void SetFocus();
|
|
|
|
friend class wxSpinCtrlTextGeneric;
|
|
|
|
protected:
|
|
// override the base class virtuals involved into geometry calculations
|
|
virtual wxSize DoGetBestSize() const;
|
|
virtual wxSize DoGetSizeFromTextSize(int xlen, int ylen = -1) const;
|
|
virtual void DoMoveWindow(int x, int y, int width, int height);
|
|
|
|
#ifdef __WXMSW__
|
|
// and, for MSW, enabling this window itself
|
|
virtual void DoEnable(bool enable);
|
|
#endif // __WXMSW__
|
|
|
|
enum SendEvent
|
|
{
|
|
SendEvent_None,
|
|
SendEvent_Text
|
|
};
|
|
|
|
// generic double valued functions
|
|
double DoGetValue() const { return m_value; }
|
|
bool DoSetValue(double val, SendEvent sendEvent);
|
|
void DoSetRange(double min_val, double max_val);
|
|
void DoSetIncrement(double inc);
|
|
|
|
// update our value to reflect the text control contents (if it has been
|
|
// modified by user, do nothing otherwise)
|
|
//
|
|
// can also change the text control if its value is invalid
|
|
//
|
|
// return true if our value has changed
|
|
bool SyncSpinToText(SendEvent sendEvent);
|
|
|
|
// Send the correct event type
|
|
virtual void DoSendEvent() = 0;
|
|
|
|
// Convert the text to/from the corresponding value.
|
|
virtual bool DoTextToValue(const wxString& text, double *val) = 0;
|
|
virtual wxString DoValueToText(double val) = 0;
|
|
|
|
// check if the value is in range
|
|
bool InRange(double n) const { return (n >= m_min) && (n <= m_max); }
|
|
|
|
// ensure that the value is in range wrapping it round if necessary
|
|
double AdjustToFitInRange(double value) const;
|
|
|
|
|
|
double m_value;
|
|
double m_min;
|
|
double m_max;
|
|
double m_increment;
|
|
bool m_snap_to_ticks;
|
|
|
|
int m_spin_value;
|
|
|
|
// the subcontrols
|
|
wxTextCtrl *m_textCtrl;
|
|
wxSpinButton *m_spinButton;
|
|
|
|
private:
|
|
// common part of all ctors
|
|
void Init();
|
|
|
|
// Implement pure virtual function inherited from wxCompositeWindow.
|
|
virtual wxWindowList GetCompositeWindowParts() const;
|
|
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
#else // !wxUSE_SPINBTN
|
|
|
|
#define wxSPINCTRL_GETVALUE_FIX int = 1
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxSpinCtrl is just a text control
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#include "wx/textctrl.h"
|
|
|
|
class WXDLLIMPEXP_CORE wxSpinCtrlGenericBase : public wxTextCtrl
|
|
{
|
|
public:
|
|
wxSpinCtrlGenericBase() : m_value(0), m_min(0), m_max(100),
|
|
m_increment(1), m_snap_to_ticks(false),
|
|
m_format(wxT("%g")) { }
|
|
|
|
bool Create(wxWindow *parent,
|
|
wxWindowID id = wxID_ANY,
|
|
const wxString& value = wxEmptyString,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
|
|
double min = 0, double max = 100, double initial = 0,
|
|
double inc = 1,
|
|
const wxString& name = wxT("wxSpinCtrl"))
|
|
{
|
|
m_min = min;
|
|
m_max = max;
|
|
m_value = initial;
|
|
m_increment = inc;
|
|
|
|
bool ok = wxTextCtrl::Create(parent, id, value, pos, size, style,
|
|
wxDefaultValidator, name);
|
|
DoSetValue(initial, SendEvent_None);
|
|
|
|
return ok;
|
|
}
|
|
|
|
// accessors
|
|
// T GetValue() const
|
|
// T GetMin() const
|
|
// T GetMax() const
|
|
// T GetIncrement() const
|
|
virtual bool GetSnapToTicks() const { return m_snap_to_ticks; }
|
|
// unsigned GetDigits() const - wxSpinCtrlDouble only
|
|
|
|
// operations
|
|
virtual void SetValue(const wxString& text) { wxTextCtrl::SetValue(text); }
|
|
// void SetValue(T val)
|
|
// void SetRange(T minVal, T maxVal)
|
|
// void SetIncrement(T inc)
|
|
virtual void SetSnapToTicks(bool snap_to_ticks)
|
|
{ m_snap_to_ticks = snap_to_ticks; }
|
|
// void SetDigits(unsigned digits) - wxSpinCtrlDouble only
|
|
|
|
// Select text in the textctrl
|
|
//void SetSelection(long from, long to);
|
|
|
|
protected:
|
|
// generic double valued
|
|
double DoGetValue() const
|
|
{
|
|
double n;
|
|
if ( (wxSscanf(wxTextCtrl::GetValue(), wxT("%lf"), &n) != 1) )
|
|
n = INT_MIN;
|
|
|
|
return n;
|
|
}
|
|
|
|
bool DoSetValue(double val, SendEvent sendEvent)
|
|
{
|
|
wxString str(wxString::Format(m_format, val));
|
|
switch ( sendEvent )
|
|
{
|
|
case SendEvent_None:
|
|
wxTextCtrl::ChangeValue(str);
|
|
break;
|
|
|
|
case SendEvent_Text:
|
|
wxTextCtrl::SetValue(str);
|
|
break;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
void DoSetRange(double min_val, double max_val)
|
|
{
|
|
m_min = min_val;
|
|
m_max = max_val;
|
|
}
|
|
void DoSetIncrement(double inc) { m_increment = inc; } // Note: unused
|
|
|
|
double m_value;
|
|
double m_min;
|
|
double m_max;
|
|
double m_increment;
|
|
bool m_snap_to_ticks;
|
|
wxString m_format;
|
|
};
|
|
|
|
#endif // wxUSE_SPINBTN/!wxUSE_SPINBTN
|
|
|
|
#if !defined(wxHAS_NATIVE_SPINCTRL)
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// wxSpinCtrl
|
|
//-----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_CORE wxSpinCtrl : public wxSpinCtrlGenericBase
|
|
{
|
|
public:
|
|
wxSpinCtrl() { Init(); }
|
|
wxSpinCtrl(wxWindow *parent,
|
|
wxWindowID id = wxID_ANY,
|
|
const wxString& value = wxEmptyString,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
|
|
int min = 0, int max = 100, int initial = 0,
|
|
const wxString& name = wxT("wxSpinCtrl"))
|
|
{
|
|
Init();
|
|
|
|
Create(parent, id, value, pos, size, style, min, max, initial, name);
|
|
}
|
|
|
|
bool Create(wxWindow *parent,
|
|
wxWindowID id = wxID_ANY,
|
|
const wxString& value = wxEmptyString,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
|
|
int min = 0, int max = 100, int initial = 0,
|
|
const wxString& name = wxT("wxSpinCtrl"))
|
|
{
|
|
return wxSpinCtrlGenericBase::Create(parent, id, value, pos, size,
|
|
style, min, max, initial, 1, name);
|
|
}
|
|
|
|
// accessors
|
|
int GetValue(wxSPINCTRL_GETVALUE_FIX) const { return int(DoGetValue()); }
|
|
int GetMin() const { return int(m_min); }
|
|
int GetMax() const { return int(m_max); }
|
|
int GetIncrement() const { return int(m_increment); }
|
|
|
|
// operations
|
|
void SetValue(const wxString& value)
|
|
{ wxSpinCtrlGenericBase::SetValue(value); }
|
|
void SetValue( int value ) { DoSetValue(value, SendEvent_None); }
|
|
void SetRange( int minVal, int maxVal ) { DoSetRange(minVal, maxVal); }
|
|
void SetIncrement(int inc) { DoSetIncrement(inc); }
|
|
|
|
virtual int GetBase() const { return m_base; }
|
|
virtual bool SetBase(int base);
|
|
|
|
protected:
|
|
virtual void DoSendEvent();
|
|
|
|
virtual bool DoTextToValue(const wxString& text, double *val);
|
|
virtual wxString DoValueToText(double val);
|
|
|
|
private:
|
|
// Common part of all ctors.
|
|
void Init()
|
|
{
|
|
m_base = 10;
|
|
}
|
|
|
|
int m_base;
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxSpinCtrl)
|
|
};
|
|
|
|
#endif // wxHAS_NATIVE_SPINCTRL
|
|
|
|
//-----------------------------------------------------------------------------
|
|
// wxSpinCtrlDouble
|
|
//-----------------------------------------------------------------------------
|
|
|
|
class WXDLLIMPEXP_CORE wxSpinCtrlDouble : public wxSpinCtrlGenericBase
|
|
{
|
|
public:
|
|
wxSpinCtrlDouble() { Init(); }
|
|
wxSpinCtrlDouble(wxWindow *parent,
|
|
wxWindowID id = wxID_ANY,
|
|
const wxString& value = wxEmptyString,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
|
|
double min = 0, double max = 100, double initial = 0,
|
|
double inc = 1,
|
|
const wxString& name = wxT("wxSpinCtrlDouble"))
|
|
{
|
|
Init();
|
|
|
|
Create(parent, id, value, pos, size, style,
|
|
min, max, initial, inc, name);
|
|
}
|
|
|
|
bool Create(wxWindow *parent,
|
|
wxWindowID id = wxID_ANY,
|
|
const wxString& value = wxEmptyString,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxSP_ARROW_KEYS | wxALIGN_RIGHT,
|
|
double min = 0, double max = 100, double initial = 0,
|
|
double inc = 1,
|
|
const wxString& name = wxT("wxSpinCtrlDouble"))
|
|
{
|
|
return wxSpinCtrlGenericBase::Create(parent, id, value, pos, size,
|
|
style, min, max, initial,
|
|
inc, name);
|
|
}
|
|
|
|
// accessors
|
|
double GetValue(wxSPINCTRL_GETVALUE_FIX) const { return DoGetValue(); }
|
|
double GetMin() const { return m_min; }
|
|
double GetMax() const { return m_max; }
|
|
double GetIncrement() const { return m_increment; }
|
|
unsigned GetDigits() const { return m_digits; }
|
|
|
|
// operations
|
|
void SetValue(const wxString& value)
|
|
{ wxSpinCtrlGenericBase::SetValue(value); }
|
|
void SetValue(double value) { DoSetValue(value, SendEvent_None); }
|
|
void SetRange(double minVal, double maxVal) { DoSetRange(minVal, maxVal); }
|
|
void SetIncrement(double inc) { DoSetIncrement(inc); }
|
|
void SetDigits(unsigned digits);
|
|
|
|
// We don't implement bases support for floating point numbers, this is not
|
|
// very useful in practice.
|
|
virtual int GetBase() const { return 10; }
|
|
virtual bool SetBase(int WXUNUSED(base)) { return 0; }
|
|
|
|
protected:
|
|
virtual void DoSendEvent();
|
|
|
|
virtual bool DoTextToValue(const wxString& text, double *val);
|
|
virtual wxString DoValueToText(double val);
|
|
|
|
unsigned m_digits;
|
|
|
|
private:
|
|
// Common part of all ctors.
|
|
void Init()
|
|
{
|
|
m_digits = 0;
|
|
m_format = wxS("%g");
|
|
}
|
|
|
|
wxString m_format;
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxSpinCtrlDouble)
|
|
};
|
|
|
|
#endif // _WX_GENERIC_SPINCTRL_H_
|