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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
.. 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
.. _wx.grid.GridActivationSource:
==========================================================================================================================================
|phoenix_title| **wx.grid.GridActivationSource**
==========================================================================================================================================
Represents a source of cell activation, which may be either a user event (mouse or keyboard) or the program itself.
An object of this class is passed to :meth:`wx.grid.GridCellEditor.TryActivate` by the library and the code overriding this method may use its :meth:`~wx.grid.GridActivationSource.GetOrigin` method to determine how exactly the cell is being activated.
.. versionadded:: 4.1/wxWidgets-3.1.4
|
|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>GridActivationSource</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.grid.GridActivationSource_inheritance.png" alt="Inheritance diagram of GridActivationSource" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.grid.GridActivationSource.html" title="wx.grid.GridActivationSource" alt="" coords="5,5,216,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.grid.GridActivationSource.GetKeyEvent` Get the key event corresponding to the key press activating the cell.
:meth:`~wx.grid.GridActivationSource.GetMouseEvent` Get the mouse event corresponding to the click activating the cell.
:meth:`~wx.grid.GridActivationSource.GetOrigin` Get the origin of the activation.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.grid.GridActivationSource.KeyEvent` See :meth:`~wx.grid.GridActivationSource.GetKeyEvent`
:attr:`~wx.grid.GridActivationSource.MouseEvent` See :meth:`~wx.grid.GridActivationSource.GetMouseEvent`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.grid.GridActivationSource(object)
Represents a source of cell activation, which may be either a user
event (mouse or keyboard) or the program itself.
.. method:: GetKeyEvent(self)
Get the key event corresponding to the key press activating the cell.
This method can be called for objects with Key origin only, use :meth:`GetOrigin` to check for this first.
:rtype: :ref:`KeyEvent`
.. method:: GetMouseEvent(self)
Get the mouse event corresponding to the click activating the cell.
This method can be called for objects with Mouse origin only, use :meth:`GetOrigin` to check for this first.
:rtype: :ref:`MouseEvent`
.. method:: GetOrigin(self)
Get the origin of the activation.
:rtype: :ref:`wx.grid.GridActivationSource.Origin`
.. attribute:: KeyEvent
See :meth:`~wx.grid.GridActivationSource.GetKeyEvent`
.. attribute:: MouseEvent
See :meth:`~wx.grid.GridActivationSource.GetMouseEvent`
.. toctree::
:maxdepth: 1
:hidden:
wx.grid.GridActivationSource.Origin.enumeration
|
