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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
|
.. 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.GridCellRenderer:
==========================================================================================================================================
|phoenix_title| **wx.grid.GridCellRenderer**
==========================================================================================================================================
This class is responsible for actually drawing the cell in the grid.
You may pass it to the :ref:`wx.grid.GridCellAttr` (below) to change the format of one given cell or to :meth:`wx.grid.Grid.SetDefaultRenderer` to change the view of all cells. This is an abstract class, and you will normally use one of the predefined derived classes or derive your own class from it.
.. seealso:: :ref:`wx.grid.GridCellAutoWrapStringRenderer`, :ref:`wx.grid.GridCellBoolRenderer`, :ref:`wx.grid.GridCellDateTimeRenderer`, :ref:`wx.grid.GridCellEnumRenderer`, :ref:`wx.grid.GridCellFloatRenderer`, :ref:`wx.grid.GridCellNumberRenderer`, :ref:`wx.grid.GridCellStringRenderer`
|
|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>GridCellRenderer</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.GridCellRenderer_inheritance.png" alt="Inheritance diagram of GridCellRenderer" 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.GridCellRenderer.html" title="wx.grid.GridCellRenderer" alt="" coords="121,83,305,112"/> <area shape="rect" id="node2" href="wx.SharedClientDataContainer.html" title="wx.SharedClientDataContainer" alt="" coords="5,5,228,35"/> <area shape="rect" id="node3" href="wx.RefCounter.html" title="wx.RefCounter" alt="" coords="251,5,369,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.grid.GridCellBoolRenderer`, :ref:`wx.grid.GridCellStringRenderer`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.grid.GridCellRenderer.__init__`
:meth:`~wx.grid.GridCellRenderer.Clone` This function must be implemented in derived classes to return a copy of itself.
:meth:`~wx.grid.GridCellRenderer.Draw` Draw the given cell on the provided DC inside the given rectangle using the style specified by the attribute and the default or selected state corresponding to the isSelected value.
:meth:`~wx.grid.GridCellRenderer.GetBestHeight` Get the preferred height of the cell at the given width.
:meth:`~wx.grid.GridCellRenderer.GetBestSize` Get the preferred size of the cell for its contents.
:meth:`~wx.grid.GridCellRenderer.GetBestWidth` Get the preferred width of the cell at the given height.
:meth:`~wx.grid.GridCellRenderer.GetMaxBestSize` Get the maximum possible size for a cell using this renderer, if possible.
:meth:`~wx.grid.GridCellRenderer.~wxGridCellRenderer` The destructor is private because only :meth:`~GridCellRenderer.DecRef` can delete us.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.grid.GridCellRenderer(SharedClientDataContainer, RefCounter)
**Possible constructors**::
GridCellRenderer()
This class is responsible for actually drawing the cell in the grid.
.. method:: __init__(self)
.. method:: Clone(self)
This function must be implemented in derived classes to return a copy of itself.
:rtype: :ref:`wx.grid.GridCellRenderer`
.. method:: Draw(self, grid, attr, dc, rect, row, col, isSelected)
Draw the given cell on the provided DC inside the given rectangle using the style specified by the attribute and the default or selected state corresponding to the isSelected value.
This pure virtual function has a default implementation which will prepare the DC using the given attribute: it will draw the rectangle with the background colour from attr and set the text colour and font.
:param `grid`:
:type `grid`: wx.grid.Grid
:param `attr`:
:type `attr`: wx.grid.GridCellAttr
:param `dc`:
:type `dc`: wx.DC
:param `rect`:
:type `rect`: wx.Rect
:param `row`:
:type `row`: int
:param `col`:
:type `col`: int
:param `isSelected`:
:type `isSelected`: bool
.. method:: GetBestHeight(self, grid, attr, dc, row, col, width)
Get the preferred height of the cell at the given width.
Some renderers may not have a well-defined best size, but only be able to provide the best height at the given width, e.g. this is the case of the standard :ref:`wx.grid.GridCellAutoWrapStringRenderer`. In this case, they should override this method, in addition to :meth:`GetBestSize` .
:param `grid`:
:type `grid`: wx.grid.Grid
:param `attr`:
:type `attr`: wx.grid.GridCellAttr
:param `dc`:
:type `dc`: wx.DC
:param `row`:
:type `row`: int
:param `col`:
:type `col`: int
:param `width`:
:type `width`: int
:rtype: `int`
.. versionadded:: 4.1/wxWidgets-3.1.0
.. seealso:: :meth:`GetBestWidth`
.. method:: GetBestSize(self, grid, attr, dc, row, col)
Get the preferred size of the cell for its contents.
This method must be overridden in the derived classes to return the minimal fitting size for displaying the content of the given grid cell.
:param `grid`:
:type `grid`: wx.grid.Grid
:param `attr`:
:type `attr`: wx.grid.GridCellAttr
:param `dc`:
:type `dc`: wx.DC
:param `row`:
:type `row`: int
:param `col`:
:type `col`: int
:rtype: :ref:`Size`
.. seealso:: :meth:`GetBestHeight` , :meth:`GetBestWidth`
.. method:: GetBestWidth(self, grid, attr, dc, row, col, height)
Get the preferred width of the cell at the given height.
See :meth:`GetBestHeight` , this method is symmetric to it.
:param `grid`:
:type `grid`: wx.grid.Grid
:param `attr`:
:type `attr`: wx.grid.GridCellAttr
:param `dc`:
:type `dc`: wx.DC
:param `row`:
:type `row`: int
:param `col`:
:type `col`: int
:param `height`:
:type `height`: int
:rtype: `int`
.. versionadded:: 4.1/wxWidgets-3.1.0
.. method:: GetMaxBestSize(self, grid, attr, dc)
Get the maximum possible size for a cell using this renderer, if possible.
This function may be overridden in the derived class if it can return the maximum size needed for displaying the cells rendered it without iterating over all cells. The base class version simply returns :ref:`wx.DefaultSize`, indicating that this is infeasible and that :meth:`GetBestSize` should be called for each cell individually.
Note that this method will only be used if :meth:`wx.grid.GridTableBase.CanMeasureColUsingSameAttr` is overridden to return ``True``.
:param `grid`:
:type `grid`: wx.grid.Grid
:param `attr`:
:type `attr`: wx.grid.GridCellAttr
:param `dc`:
:type `dc`: wx.DC
:rtype: :ref:`Size`
.. versionadded:: 4.1/wxWidgets-3.1.4
.. method:: ~wxGridCellRenderer(self)
The destructor is private because only :meth:`DecRef` can delete us.
|
