phoenix_title wx.lib.buttons.GenButtonEvent

Event sent from the generic buttons when the button is activated.


class_hierarchy Class Hierarchy

Inheritance diagram for class GenButtonEvent:

super_classes Known Superclasses

wx.CommandEvent


method_summary Methods Summary

__init__

Default class constructor.

GetButtonObj

Returns the object associated with this event.

GetIsDown

Returns the button toggle status as True if the button is down, False

SetButtonObj

Sets the event object for the event.

SetIsDown

Set the button toggle status as ‘down’ or ‘up’.


api Class API

class GenButtonEvent(wx.CommandEvent)

Event sent from the generic buttons when the button is activated.


Methods

__init__(self, eventType, id)

Default class constructor.

Parameters
  • eventType (integer) – the event type;

  • id (integer) – the event identifier.



GetButtonObj(self)

Returns the object associated with this event.

Returns

An instance of GenButton.



GetIsDown(self)

Returns the button toggle status as True if the button is down, False otherwise.

Return type

bool



SetButtonObj(self, btn)

Sets the event object for the event.

Parameters

btn – the button object, an instance of GenButton.



SetIsDown(self, isDown)

Set the button toggle status as ‘down’ or ‘up’.

Parameters

isDown (bool) – True if the button is clicked, False otherwise.