AGW Logo

agw_title __SToggleMixin

A mixin that allows to transform any of SButton, SBitmapButton and SBitmapTextButton in the corresponding toggle buttons.

hierarchy Inheritance Diagram

Inheritance diagram for: __SToggleMixin


method_summary Methods Summary

GetToggleReturns the toggled state of a button.
GetValueReturns the toggled state of a button.
OnKeyDownHandles the wx.EVT_KEY_DOWN event for the button.
OnKeyUpHandles the wx.EVT_KEY_UP event for the button.
OnLeftDownHandles the wx.EVT_LEFT_DOWN event for the button.
OnLeftUpHandles the wx.EVT_LEFT_UP event for the button.
OnMotionHandles the wx.EVT_MOTION event for the button.
SetToggleSets the button as toggled/not toggled.
SetValueSets the button as toggled/not toggled.

API Class API

class __SToggleMixin(object)[source]

A mixin that allows to transform any of SButton, SBitmapButton and SBitmapTextButton in the corresponding toggle buttons.



GetToggle()[source]

Returns the toggled state of a button.



GetValue()

Returns the toggled state of a button.



OnKeyDown(event)[source]

Handles the wx.EVT_KEY_DOWN event for the button.

Parameters:event – a wx.KeyEvent event to be processed.


OnKeyUp(event)[source]

Handles the wx.EVT_KEY_UP event for the button.

Parameters:event – a wx.KeyEvent event to be processed.



OnLeftDown(event)[source]

Handles the wx.EVT_LEFT_DOWN event for the button.

Parameters:event – a wx.MouseEvent event to be processed.


OnLeftUp(event)[source]

Handles the wx.EVT_LEFT_UP event for the button.

Parameters:event – a wx.MouseEvent event to be processed.



OnMotion(event)[source]

Handles the wx.EVT_MOTION event for the button.

Parameters:event – a wx.MouseEvent event to be processed.



SetToggle(flag)[source]

Sets the button as toggled/not toggled.

Parameters:flagTrue to set the button as toggled, False otherwise.


SetValue(flag)

Sets the button as toggled/not toggled.

Parameters:flagTrue to set the button as toggled, False otherwise.
Tree

Table Of Contents

Previous topic

SToggleButton

Next topic

shapedbutton functions