File: wx.grid.GridSizeEvent.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (258 lines) | stat: -rw-r--r-- 7,295 bytes parent folder | download
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
.. 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



.. _wx.grid.GridSizeEvent:

==========================================================================================================================================
|phoenix_title|  **wx.grid.GridSizeEvent**
==========================================================================================================================================

This event class contains information about a row/column resize event.          







.. _GridSizeEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`wx.grid.GridSizeEvent` parameter.

Event macros: 

- EVT_GRID_CMD_COL_SIZE: The user resized a column, corresponds to  ``wxEVT_GRID_COL_SIZE``   event type.   
- EVT_GRID_CMD_ROW_SIZE: The user resized a row, corresponds to  ``wxEVT_GRID_ROW_SIZE``   event type.   
- EVT_GRID_COL_SIZE: Same as EVT_GRID_CMD_COL_SIZE() but uses  ``ID_ANY``   id.   
- EVT_GRID_COL_AUTO_SIZE: This event is sent when a column must be resized to its best size, e.g. when the user double clicks the column divider. The default implementation simply resizes the column to fit the column label (but not its contents as this could be too slow for big grids). This macro corresponds to  ``wxEVT_GRID_COL_AUTO_SIZE``   event type and is new since wxWidgets 2.9.5.   
- EVT_GRID_ROW_SIZE: Same as EVT_GRID_CMD_ROW_SIZE() but uses  ``ID_ANY``   id.   










|

|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>GridSizeEvent</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.GridSizeEvent_inheritance.png" alt="Inheritance diagram of GridSizeEvent" 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.Event.html" title="wx.Event" alt="" coords="45,83,123,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="11,160,156,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="43,5,124,35"/> <area shape="rect" id="node5" href="wx.NotifyEvent.html" title="wx.NotifyEvent" alt="" coords="27,237,141,267"/> <area shape="rect" id="node4" href="wx.grid.GridSizeEvent.html" title="wx.grid.GridSizeEvent" alt="" coords="5,315,163,344"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.grid.GridSizeEvent.__init__`                                          Default constructor.
:meth:`~wx.grid.GridSizeEvent.AltDown`                                           Returns ``True`` if the Alt key was down at the time of the event.
:meth:`~wx.grid.GridSizeEvent.ControlDown`                                       Returns ``True`` if the Control key was down at the time of the event.
:meth:`~wx.grid.GridSizeEvent.GetPosition`                                       Position in pixels at which the event occurred.
:meth:`~wx.grid.GridSizeEvent.GetRowOrCol`                                       Row or column at that was resized.
:meth:`~wx.grid.GridSizeEvent.MetaDown`                                          Returns ``True`` if the Meta key was down at the time of the event.
:meth:`~wx.grid.GridSizeEvent.ShiftDown`                                         Returns ``True`` if the Shift key was down at the time of the event.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.grid.GridSizeEvent.Position`                                          See :meth:`~wx.grid.GridSizeEvent.GetPosition`
:attr:`~wx.grid.GridSizeEvent.RowOrCol`                                          See :meth:`~wx.grid.GridSizeEvent.GetRowOrCol`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.grid.GridSizeEvent(NotifyEvent)

   **Possible constructors**::

       GridSizeEvent()
       
       GridSizeEvent(id, type, obj, rowOrCol=-1, x=-1, y=-1,
                     kbd=KeyboardState())
       
   
   This event class contains information about a row/column resize event.



   .. method:: __init__(self, *args, **kw)



      |overload| Overloaded Implementations:

      **~~~**

      
      **__init__** `(self)`
      
      Default constructor.                   
      
      
      
      
      **~~~**

      
      **__init__** `(self, id, type, obj, rowOrCol=-1, x=-1, y=-1, kbd=KeyboardState())`
      
      Constructor for initializing all event attributes.                  
      
      
      :param `id`: 
      :type `id`: int
      :param `type`: 
      :type `type`: wx.EventType
      :param `obj`: 
      :type `obj`: wx.Object
      :param `rowOrCol`: 
      :type `rowOrCol`: int
      :param `x`: 
      :type `x`: int
      :param `y`: 
      :type `y`: int
      :param `kbd`: 
      :type `kbd`: wx.KeyboardState
      
      
      
      
      
      
      **~~~**






   .. method:: AltDown(self)

      Returns ``True`` if the Alt key was down at the time of the event.                  

      :rtype: `bool`








   .. method:: ControlDown(self)

      Returns ``True`` if the Control key was down at the time of the event.                  

      :rtype: `bool`








   .. method:: GetPosition(self)

      Position in pixels at which the event occurred.                  

      :rtype: :ref:`Point`








   .. method:: GetRowOrCol(self)

      Row or column at that was resized.                  

      :rtype: `int`








   .. method:: MetaDown(self)

      Returns ``True`` if the Meta key was down at the time of the event.                  

      :rtype: `bool`








   .. method:: ShiftDown(self)

      Returns ``True`` if the Shift key was down at the time of the event.                  

      :rtype: `bool`








   .. attribute:: Position

      See :meth:`~wx.grid.GridSizeEvent.GetPosition`


   .. attribute:: RowOrCol

      See :meth:`~wx.grid.GridSizeEvent.GetRowOrCol`