.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.gradientbutton
.. highlight:: python
.. _wx.lib.agw.gradientbutton.GradientButtonEvent:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.gradientbutton.GradientButtonEvent**
==========================================================================================================================================
Event sent from :class:`GradientButton` when the button is activated.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
GradientButtonEvent:
|
|super_classes| Known Superclasses
==================================
:class:`wx.PyCommandEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.gradientbutton.GradientButtonEvent.__init__` Default class constructor.
:meth:`~wx.lib.agw.gradientbutton.GradientButtonEvent.GetButtonObj` Returns the object associated with this event.
:meth:`~wx.lib.agw.gradientbutton.GradientButtonEvent.SetButtonObj` Sets the event object for the event.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: GradientButtonEvent(wx.PyCommandEvent)
Event sent from :class:`GradientButton` when the button is activated.
.. method:: __init__(self, eventType, eventId)
Default class constructor.
:param `eventType`: the event type;
:param `eventId`: the event identifier.
.. method:: GetButtonObj(self)
Returns the object associated with this event.
.. method:: SetButtonObj(self, btn)
Sets the event object for the event.
:param `btn`: the button object, an instance of :class:`GradientButton`.