wx.SpinCtrlDouble¶
wx.SpinCtrlDouble combines wx.TextCtrl and wx.SpinButton in one control and displays a real number.
( wx.SpinCtrl displays an integer.)
Window Styles¶
This class supports the following styles:
wx.SP_ARROW_KEYS
: The user can use arrow keys to change the value.wx.SP_WRAP
: The value wraps at the minimum and maximum.wx.TE_PROCESS_ENTER
: Indicates that the control should generatewxEVT_TEXT_ENTER
events. Using this style will prevent the user from using the Enter key for dialog navigation (e.g. activating the default button in the dialog) under MSW.wx.ALIGN_LEFT
: Same aswx.TE_LEFT
for wx.TextCtrl: the text is left aligned (this is the default).wx.ALIGN_CENTRE_HORIZONTAL
: Same aswx.TE_CENTRE
for wx.TextCtrl: the text is centered.wx.ALIGN_RIGHT
: Same aswx.TE_RIGHT
for wx.TextCtrl: the text is right aligned.
Events Emitted by this Class¶
Handlers bound for the following event types will receive a wx.SpinDoubleEvent parameter.
EVT_SPINCTRLDOUBLE: Generated whenever the numeric value of the spin control is changed, that is, when the up/down spin button is clicked, when
ENTER
is pressed, or the control loses focus and the new value is different from the last. See wx.SpinDoubleEvent.
See also
Class Hierarchy¶
Control Appearance¶
Methods Summary¶
Default constructor. |
|
Creation function called by the spin control constructor. |
|
Gets precision of the value of the spin control. |
|
Gets the increment value. |
|
Gets maximal allowable value. |
|
Gets minimal allowable value. |
|
Returns the text in the text entry part of the control. |
|
Gets the value of the spin control. |
|
Sets precision of the value of the spin control. |
|
Sets the increment value. |
|
Sets range of allowable values. |
|
Sets the value of the spin control. |
Properties Summary¶
See |
|
See |
|
See |
|
Class API¶
- class wx.SpinCtrlDouble(Control)¶
Possible constructors:
SpinCtrlDouble() -> None SpinCtrlDouble(parent, id=-1, value='', pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, inc=1, name=T("wxSpinCtrlDouble")) -> None
SpinCtrlDouble combines TextCtrl and SpinButton in one control and displays a real number.
Methods¶
- __init__(self, *args, **kw)¶
-
__init__ (self)
Default constructor.
- Return type:
None
__init__ (self, parent, id=-1, value=’’, pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, inc=1, name=T(“wxSpinCtrlDouble”))
Constructor, creating and showing a spin control.
If value is non-empty, it will be shown in the text entry part of the control and if it has numeric value, the initial numeric value of the control, as returned by
GetValue
will also be determined by it instead of by initial. Hence, it only makes sense to specify initial if value is an empty string or is not convertible to a number, otherwise initial is simply ignored and the number specified by value is used.- Parameters:
parent (wx.Window) – Parent window. Must not be
None
.id (wx.WindowID) – Window identifier. The value
wx.ID_ANY
indicates a default value.value (string) – Default value (as text).
pos (wx.Point) – Window position. If
wx.DefaultPosition
is specified then a default position is chosen.size (wx.Size) – Window size. If
wx.DefaultSize
is specified then a default size is chosen.style (long) – Window style. See wx.SpinButton.
min (float) – Minimal value.
max (float) – Maximal value.
initial (float) – Initial value.
inc (float) – Increment value.
name (string) – Window name.
- Return type:
None
inc. If necessary, default precision can be adjusted by call to
SetDigits
.See also
- Create(self, parent, id=ID_ANY, value='', pos=DefaultPosition, size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, inc=1, name='wxSpinCtrlDouble')¶
Creation function called by the spin control constructor.
See wx.SpinCtrlDouble for details.
- static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶
- Parameters:
variant (WindowVariant)
- Return type:
- GetDigits(self)¶
Gets precision of the value of the spin control.
- Return type:
int
- GetIncrement(self)¶
Gets the increment value.
- Return type:
float
- GetMax(self)¶
Gets maximal allowable value.
- Return type:
float
- GetMin(self)¶
Gets minimal allowable value.
- Return type:
float
- GetRange(self)¶
- GetTextValue(self)¶
Returns the text in the text entry part of the control.
- Return type:
str
Added in version 4.1/wxWidgets-3.1.6.
- GetValue(self)¶
Gets the value of the spin control.
- Return type:
float
- SetDigits(self, digits)¶
Sets precision of the value of the spin control.
Up to 20 digits are allowed after the decimal point.
- Parameters:
digits (int)
- Return type:
None
- SetIncrement(self, inc)¶
Sets the increment value.
Using this method changes the number of digits used by the control to at least match the value of inc, e.g. using the increment of
0.01
sets the number of digits to 2 if it had been less than 2 before. However it doesn’t change the number of digits if it had been already high enough.In any case, you may call
SetDigits
explicitly to override the automatic determination of the number of digits.- Parameters:
inc (float)
- Return type:
None
- SetMax(self, maxVal)¶
- SetMin(self, minVal)¶
- SetRange(self, minVal, maxVal)¶
Sets range of allowable values.
- Parameters:
minVal (float)
maxVal (float)
- Return type:
None
- SetValue(self, *args, **kw)¶
-
SetValue (self, text)
Sets the value of the spin control.
It is recommended to use the overload taking a float value instead. If text doesn’t represent a valid number, it may not be shown in the text part of the control at all (only empty string is guaranteed to be supported under all platforms) and the numeric value will be changed to
GetMin
.Notice that, unlike
wx.TextCtrl.SetValue
, but like most of the other setter methods in wxWidgets, calling this method does not generate any events as events are only generated for the user actions.- Parameters:
text (string)
- Return type:
None
SetValue (self, value)
Sets the value of the spin control.
Calling this method doesn’t generate any
wxEVT_SPINCTRLDOUBLE
events.- Parameters:
value (float)
- Return type:
None
Properties¶
- Increment¶
See
GetIncrement
andSetIncrement
- TextValue¶
See
GetTextValue