phoenix_title wx.SpinCtrlDouble

wx.SpinCtrlDouble combines wx.TextCtrl and wx.SpinButton in one control and displays a real number.

( wx.SpinCtrl displays an integer.)

^^

styles 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 generate wxEVT_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 as wx.TE_LEFT for wx.TextCtrl: the text is left aligned (this is the default).

  • wx.ALIGN_CENTRE_HORIZONTAL: Same as wx.TE_CENTRE for wx.TextCtrl: the text is centered.

  • wx.ALIGN_RIGHT: Same as wx.TE_RIGHT for wx.TextCtrl: the text is right aligned. ^^

^^

events 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. ^^

class_hierarchy Class Hierarchy

Inheritance diagram for class SpinCtrlDouble:

appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__

Default constructor.

Create

Creation function called by the spin control constructor.

GetClassDefaultAttributes

GetDigits

Gets precision of the value of the spin control.

GetIncrement

Gets the increment value.

GetMax

Gets maximal allowable value.

GetMin

Gets minimal allowable value.

GetRange

GetTextValue

Returns the text in the text entry part of the control.

GetValue

Gets the value of the spin control.

SetDigits

Sets precision of the value of the spin control.

SetIncrement

Sets the increment value.

SetMax

SetMin

SetRange

Sets range of allowable values.

SetValue

Sets the value of the spin control.


property_summary Properties Summary

Digits

See GetDigits and SetDigits

Increment

See GetIncrement and SetIncrement

Max

See GetMax and SetMax

Min

See GetMin and SetMin

Range

See GetRange

TextValue

See GetTextValue

Value

See GetValue and SetValue


api Class API

class wx.SpinCtrlDouble(Control)

Possible constructors:

SpinCtrlDouble()

SpinCtrlDouble(parent, id=-1, value="", pos=DefaultPosition,
               size=DefaultSize, style=SP_ARROW_KEYS, min=0, max=100, initial=0, inc=1,
               name=T("wxSpinCtrlDouble"))

SpinCtrlDouble combines TextCtrl and SpinButton in one control and displays a real number.


Methods

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor.



__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.

inc. If necessary, default precision can be adjusted by call to SetDigits .

See also

Create





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.

Parameters:
  • parent (wx.Window) –

  • id (wx.WindowID) –

  • value (string) –

  • pos (wx.Point) –

  • size (wx.Size) –

  • style (long) –

  • min (float) –

  • max (float) –

  • initial (float) –

  • inc (float) –

  • name (string) –

Return type:

bool



static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters:

variant (WindowVariant) –

Return type:

wx.VisualAttributes



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:

string

New 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) –



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) –



SetMax(self, maxVal)


SetMin(self, minVal)


SetRange(self, minVal, maxVal)

Sets range of allowable values.

Parameters:
  • minVal (float) –

  • maxVal (float) –



SetValue(self, *args, **kw)

overload Overloaded Implementations:



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) –



SetValue (self, value)

Sets the value of the spin control.

Calling this method doesn’t generate any wxEVT_SPINCTRLDOUBLE events.

Parameters:

value (float) –




Properties

Digits

See GetDigits and SetDigits



Increment

See GetIncrement and SetIncrement



Max

See GetMax and SetMax



Min

See GetMin and SetMin



Range

See GetRange



TextValue

See GetTextValue



Value

See GetValue and SetValue