Navigation

Phoenix Logo

phoenix_title wx.lib.intctrl.IntCtrl

This class provides a control that takes and returns integers as value, and provides bounds support and optional value limiting.


class_hierarchy Class Hierarchy

Inheritance diagram for class IntCtrl:

super_classes Known Superclasses

wx.TextCtrl


method_summary Methods Summary

__init__ Default constructor
ChangeValue Change the value without sending an EVT_TEXT event.
Cut Override the TextCtrl.Cut function, with our own
GetBounds This function returns a two-tuple (min,max), indicating the
GetColors Returns a tuple of (default_color, oob_color), indicating
GetMax Gets the maximum value of the control. It will return the current
GetMin Gets the minimum value of the control. It will return the current
GetValue Returns the current integer (long) value of the control.
IsInBounds Returns True if no value is specified and the current value
IsLimited Returns True if the control is currently limiting the
IsLongAllowed Is a long value allowed.
IsNoneAllowed Is a None value allowed.
OnText Handles an event indicating that the text control’s value
Paste Override the TextCtrl.Paste function, with our own
SetBounds This function is a convenience function for setting the min and max
SetColors Tells the control what colors to use for normal and out-of-bounds
SetLimited If called with a value of True, this function will cause the control
SetLongAllowed Change the behavior of the validation code, allowing control
SetMax Sets the maximum value of the control. If a value of None
SetMin Sets the minimum value of the control. If a value of None
SetNoneAllowed Change the behavior of the validation code, allowing control
SetValue Sets the value of the control to the integer value specified.

api Class API


class IntCtrl(wx.TextCtrl)

This class provides a control that takes and returns integers as value, and provides bounds support and optional value limiting.


Methods


__init__(self, parent, id=-1, value = 0, pos = wx.DefaultPosition, size = wx.DefaultSize, style = 0, validator = wx.DefaultValidator, name = "integer", min=None, max=None, limited = 0, allow_none = 0, allow_long = 0, default_color = wx.BLACK, oob_color = wx.RED)

Default constructor

Parameters:
  • parent – parent window
  • id (int) – window identifier. A value of -1 indicates a default value
  • value – If no initial value is set, the default will be zero, or the minimum value, if specified. If an illegal string is specified, a ValueError will result. (You can always later set the initial value with ChangeValue() after instantiation of the control.)
  • pos (tuple) – the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform
  • size (wx.Size) – the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform
  • style (int) – the underlying TextCtrl style
  • validator (wx.Validator) – Normally None, IntCtrl uses its own validator to do value validation and input control. However, a validator derived from IntValidator can be supplied to override the data transfer methods for the IntValidator class.
  • min (int) – The minimum value that the control should allow. This can be adjusted with SetMin(). If the control is not limited, any value below this bound will be colored with the current out-of-bounds color. If min < -sys.maxsize-1 and the control is configured to not allow long values, the minimum bound will still be set to the long value, but the implicit bound will be -sys.maxsize-1.
  • max (int) – The maximum value that the control should allow. This can be adjusted with SetMax(). If the control is not limited, any value above this bound will be colored with the current out-of-bounds color. if max > sys.maxsize and the control is configured to not allow long values, the maximum bound will still be set to the long value, but the implicit bound will be sys.maxsize.
  • limited (bool) – Boolean indicating whether the control prevents values from exceeding the currently set minimum and maximum values (bounds). If False and bounds are set, out-of-bounds values will be colored with the current out-of-bounds color.
  • allow_none (bool) – Boolean indicating whether or not the control is allowed to be empty, representing a value of None for the control.
  • allow_long (bool) – Boolean indicating whether or not the control is allowed to hold and return a long as well as an int.
  • default_color (Color) – Color value used for in-bounds values of the control.
  • oob_color (Color) – Color value used for out-of-bounds values of the control when the bounds are set but the control is not limited.

ChangeValue(self, value)

Change the value without sending an EVT_TEXT event.

Parameters:value (int) – The value to be set

Cut(self)

Override the TextCtrl.Cut function, with our own that does validation. Will result in a value of 0 if entire contents of control are removed.


GetBounds(self)

This function returns a two-tuple (min,max), indicating the current bounds of the control. Each value can be None if that bound is not set.


GetColors(self)

Returns a tuple of (default_color, oob_color), indicating the current color settings for the control.


GetMax(self)

Gets the maximum value of the control. It will return the current maximum integer, or None if not specified.


GetMin(self)

Gets the minimum value of the control. It will return the current minimum integer, or None if not specified.


GetValue(self)

Returns the current integer (long) value of the control.


IsInBounds(self, value=None)

Returns True if no value is specified and the current value of the control falls within the current bounds. This function can also be called with a value to see if that value would fall within the current bounds of the given control.

Parameters:value (int) – value to check or None

IsLimited(self)

Returns True if the control is currently limiting the value to fall within the current bounds.


IsLongAllowed(self)

Is a long value allowed.


IsNoneAllowed(self)

Is a None value allowed.


OnText(self, event)

Handles an event indicating that the text control’s value has changed, and issue EVT_INT event. NOTE: using wx.TextCtrl.SetValue() to change the control’s contents from within a wx.EVT_CHAR handler can cause double text events. So we check for actual changes to the text before passing the events on.


Paste(self)

Override the TextCtrl.Paste function, with our own that does validation. Will raise ValueError if not a valid integerizable value.


SetBounds(self, min=None, max=None)

This function is a convenience function for setting the min and max values at the same time. The function only applies the maximum bound if setting the minimum bound is successful, and returns True only if both operations succeed. ..note:

Leaving out an argument will remove the corresponding bound.
Parameters:
  • min (int) – The value to be set as minimum
  • max (int) – The value to be set as maximum

SetColors(self, default_color=wx.BLACK, oob_color=wx.RED)

Tells the control what colors to use for normal and out-of-bounds values. If the value currently exceeds the bounds, it will be recolored accordingly.

Parameters:
  • default_color (Color) – default color to be used
  • oob_color (Color) – out of bound color to be used

SetLimited(self, limited)

If called with a value of True, this function will cause the control to limit the value to fall within the bounds currently specified. If the control’s value currently exceeds the bounds, it will then be limited accordingly.

If called with a value of 0, this function will disable value limiting, but coloring of out-of-bounds values will still take place if bounds have been set for the control.

Parameters:limited (bool) – If True set to control to be limited.

SetLongAllowed(self, allow_long)

Change the behavior of the validation code, allowing control to have a long value or not, as appropriate. If the value of the control is currently long, and allow_long is 0, the value of the control will be adjusted to fall within the size of an integer type, at either the sys.maxsize or -sys.maxsize-1, for positive and negative values, respectively.

Parameters:allow_long (bool) – If True allow long values for control

SetMax(self, max=None)

Sets the maximum value of the control. If a value of None is provided, then the control will have no explicit maximum value. If the value specified is less than the current minimum value, then the function returns 0 and the maximum will not change from its current setting. On success, the function returns 1.

If successful and the current value is greater than the new upper bound, if the control is limited the value will be automatically adjusted to this maximum value; if not limited, the value in the control will be colored with the current out-of-bounds color.

If max > sys.maxsize and the control is configured to not allow longs, the function will return 0, and the max will not be set.

Parameters:max (int) – The value to be set as maximum

SetMin(self, min=None)

Sets the minimum value of the control. If a value of None is provided, then the control will have no explicit minimum value. If the value specified is greater than the current maximum value, then the function returns 0 and the minimum will not change from its current setting. On success, the function returns 1.

If successful and the current value is lower than the new lower bound, if the control is limited, the value will be automatically adjusted to the new minimum value; if not limited, the value in the control will be colored with the current out-of-bounds color.

If min > -sys.maxsize-1 and the control is configured to not allow longs, the function will return 0, and the min will not be set.

Parameters:min (int) – The value to be set as minimum

SetNoneAllowed(self, allow_none)

Change the behavior of the validation code, allowing control to have a value of None or not, as appropriate. If the value of the control is currently None, and allow_none is 0, the value of the control will be set to the minimum value of the control, or 0 if no lower bound is set.

Parameters:allow_none (bool) – If True a None value is allowed

SetValue(self, value)

Sets the value of the control to the integer value specified. The resulting actual value of the control may be altered to conform with the bounds set on the control if limited, or colored if not limited but the value is out-of-bounds. A ValueError exception will be raised if an invalid value is specified.

Parameters:value (int) – The value to be set