AGW Logo

agw_title __ToggleMixin

A mixin that allows to transform AquaButton in the corresponding toggle button.

hierarchy Inheritance Diagram

Inheritance diagram for: __ToggleMixin


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 AquaButton when used as toggle button.
OnKeyUpHandles the wx.EVT_KEY_UP event for AquaButton when used as toggle button.
OnLeftDownHandles the wx.EVT_LEFT_DOWN event for AquaButton when used as toggle button.
OnLeftUpHandles the wx.EVT_LEFT_UP event for AquaButton when used as toggle button.
OnMotionHandles the wx.EVT_MOTION event for AquaButton when used as toggle button.
OnPaintHandles the wx.EVT_PAINT event for AquaButton when used as toggle button.
SetToggleSets the button as toggled/not toggled.
SetValueSets the button as toggled/not toggled.

API Class API

class __ToggleMixin(object)[source]

A mixin that allows to transform AquaButton in the corresponding toggle button.



GetToggle()[source]

Returns the toggled state of a button.

Returns:True is the button is toggled, False if it is not toggled.


GetValue()

Returns the toggled state of a button.

Returns:True is the button is toggled, False if it is not toggled.


OnKeyDown(event)[source]

Handles the wx.EVT_KEY_DOWN event for AquaButton when used as toggle button.

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


OnKeyUp(event)[source]

Handles the wx.EVT_KEY_UP event for AquaButton when used as toggle button.

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



OnLeftDown(event)[source]

Handles the wx.EVT_LEFT_DOWN event for AquaButton when used as toggle button.

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


OnLeftUp(event)[source]

Handles the wx.EVT_LEFT_UP event for AquaButton when used as toggle button.

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



OnMotion(event)[source]

Handles the wx.EVT_MOTION event for AquaButton when used as toggle button.

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



OnPaint(event)[source]

Handles the wx.EVT_PAINT event for AquaButton when used as toggle button.

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


SetToggle(flag)[source]

Sets the button as toggled/not toggled.

Parameters:flag (bool) – True to set the button as toggled, False otherwise.


SetValue(flag)

Sets the button as toggled/not toggled.

Parameters:flag (bool) – True to set the button as toggled, False otherwise.
Tree

Table Of Contents

Previous topic

AquaToggleButton

Next topic

SVN Revision 68343 For aquabutton