Phoenix Logo

phoenix_title wx.SpinEvent

This event class is used for the events generated by wx.SpinButton and wx.SpinCtrl.

events Events Emitted by this Class

Handlers bound for the following event types will receive a wx.SpinEvent parameter.

  • EVT_SPIN: Generated whenever an arrow is pressed.
  • EVT_SPIN_UP: Generated when left/up arrow is pressed.
  • EVT_SPIN_DOWN: Generated when right/down arrow is pressed.

Note that if you handle both SPIN and wx.UP or wx.DOWN events, you will be notified about each of them twice: first the UP/DOWN event will be received and then, if it wasn’t vetoed, the SPIN event will be sent.


class_hierarchy Class Hierarchy

Inheritance diagram for class SpinEvent:


method_summary Methods Summary

__init__ The constructor is not normally used by the user code.
GetPosition Retrieve the current spin button or control value.
SetPosition Set the value associated with the event.

property_summary Properties Summary

Position See GetPosition and SetPosition

api Class API



class wx.SpinEvent(NotifyEvent)

Possible constructors:

SpinEvent(commandType=wxEVT_NULL, id=0)

This event class is used for the events generated by SpinButton and SpinCtrl.


Methods



__init__(self, commandType=wxEVT_NULL, id=0)

The constructor is not normally used by the user code.

Parameters:
  • commandType (wx.EventType) –
  • id (int) –


GetPosition(self)

Retrieve the current spin button or control value.

Return type:int


SetPosition(self, pos)

Set the value associated with the event.

Parameters:pos (int) –

Properties



Position

See GetPosition and SetPosition