Table Of Contents

Previous topic

SButton

Next topic

SToggleButton

This Page

phoenix_title SButtonEvent

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


class_hierarchy Inheritance Diagram

Inheritance diagram for class SButtonEvent

Inheritance diagram of SButtonEvent


super_classes Known Superclasses

PyCommandEvent


method_summary Methods Summary

__init__ Default class constructor.
GetButtonObj Returns the object associated with this event.
GetIsDown Returns True if the button event is “pressed”.
SetButtonObj Sets the event object for the event.
SetIsDown Sets the button event as pressed.

api Class API



class SButtonEvent(PyCommandEvent)

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


Methods



__init__(self, eventType, eventId)

Default class constructor.

Parameters:
  • eventType – the event type;
  • eventId – the event identifier.


GetButtonObj(self)

Returns the object associated with this event.



GetIsDown(self)

Returns True if the button event is “pressed”.



SetButtonObj(self, btn)

Sets the event object for the event.

Parameters:btn – the button object.


SetIsDown(self, isDown)

Sets the button event as pressed.

Parameters:isDownTrue to set the event as “pressed”, False otherwise.