1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.buttons
.. highlight:: python
.. _wx.lib.buttons.GenButtonEvent:
==========================================================================================================================================
|phoenix_title| **wx.lib.buttons.GenButtonEvent**
==========================================================================================================================================
Event sent from the generic buttons when the button is activated.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>GenButtonEvent</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.buttons.GenButtonEvent_inheritance.png" alt="Inheritance diagram of GenButtonEvent" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="42,160,187,189"/> <area shape="rect" id="node4" href="wx.lib.buttons.GenButtonEvent.html" title="wx.lib.buttons.GenButtonEvent" alt="" coords="5,237,224,267"/> <area shape="rect" id="node2" href="wx.Event.html" title="wx.Event" alt="" coords="75,83,153,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="73,5,155,35"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.CommandEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.buttons.GenButtonEvent.__init__` Default class constructor.
:meth:`~wx.lib.buttons.GenButtonEvent.GetButtonObj` Returns the object associated with this event.
:meth:`~wx.lib.buttons.GenButtonEvent.GetIsDown` Returns the button toggle status as ``True`` if the button is down, ``False``
:meth:`~wx.lib.buttons.GenButtonEvent.SetButtonObj` Sets the event object for the event.
:meth:`~wx.lib.buttons.GenButtonEvent.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.
.. method:: __init__(self, eventType, id)
Default class constructor.
:param integer `eventType`: the event type;
:param integer `id`: the event identifier.
.. method:: GetButtonObj(self)
Returns the object associated with this event.
:return: An instance of :class:`GenButton`.
.. method:: GetIsDown(self)
Returns the button toggle status as ``True`` if the button is down, ``False``
otherwise.
:rtype: bool
.. method:: SetButtonObj(self, btn)
Sets the event object for the event.
:param `btn`: the button object, an instance of :class:`GenButton`.
.. method:: SetIsDown(self, isDown)
Set the button toggle status as 'down' or 'up'.
:param bool `isDown`: ``True`` if the button is clicked, ``False`` otherwise.
|
