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
|
.. 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.propgrid.PGCellRenderer:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.PGCellRenderer**
==========================================================================================================================================
Base class for :ref:`wx.propgrid.PropertyGrid` cell renderers.
|
|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>PGCellRenderer</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.propgrid.PGCellRenderer_inheritance.png" alt="Inheritance diagram of PGCellRenderer" 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.ObjectRefData.html" title="wx.ObjectRefData" alt="" coords="37,5,171,35"/> <area shape="rect" id="node2" href="wx.propgrid.PGCellRenderer.html" title="wx.propgrid.PGCellRenderer" alt="" coords="5,83,203,112"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.propgrid.PGDefaultRenderer`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.PGCellRenderer.__init__`
:meth:`~wx.propgrid.PGCellRenderer.DrawCaptionSelectionRect` Paints property category selection rectangle.
:meth:`~wx.propgrid.PGCellRenderer.DrawEditorValue` Utility to draw editor's value, or vertically aligned text if editor is ``None``.
:meth:`~wx.propgrid.PGCellRenderer.DrawText` Utility to draw vertically centered text.
:meth:`~wx.propgrid.PGCellRenderer.GetImageSize` Returns size of the image in front of the editable area.
:meth:`~wx.propgrid.PGCellRenderer.PostDrawCell` Utility to be called after drawing is done, to revert whatever changes :meth:`~PGCellRenderer.PreDrawCell` did.
:meth:`~wx.propgrid.PGCellRenderer.PreDrawCell` Utility to render cell bitmap and set text colour plus bg brush colour.
:meth:`~wx.propgrid.PGCellRenderer.Render` Returns ``True`` if rendered something in the foreground (text or bitmap.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.PGCellRenderer(RefCounter)
**Possible constructors**::
PGCellRenderer()
Base class for PropertyGrid cell renderers.
.. method:: __init__(self)
.. method:: DrawCaptionSelectionRect(self, dc, x, y, w, h)
Paints property category selection rectangle.
:param `dc`:
:type `dc`: wx.DC
:param `x`:
:type `x`: int
:param `y`:
:type `y`: int
:param `w`:
:type `w`: int
:param `h`:
:type `h`: int
.. method:: DrawEditorValue(self, dc, rect, xOffset, text, property, editor)
Utility to draw editor's value, or vertically aligned text if editor is ``None``.
:param `dc`:
:type `dc`: wx.DC
:param `rect`:
:type `rect`: wx.Rect
:param `xOffset`:
:type `xOffset`: int
:param `text`:
:type `text`: string
:param `property`:
:type `property`: wx.propgrid.PGProperty
:param `editor`:
:type `editor`: wx.propgrid.PGEditor
.. method:: DrawText(self, dc, rect, imageWidth, text)
Utility to draw vertically centered text.
:param `dc`:
:type `dc`: wx.DC
:param `rect`:
:type `rect`: wx.Rect
:param `imageWidth`:
:type `imageWidth`: int
:param `text`:
:type `text`: string
.. method:: GetImageSize(self, property, column, item)
Returns size of the image in front of the editable area.
:param `property`:
:type `property`: wx.propgrid.PGProperty
:param `column`:
:type `column`: int
:param `item`:
:type `item`: int
:rtype: :ref:`Size`
.. note::
If property is ``None``, then this call is for a custom value. In that case the item is index to :ref:`wx.propgrid.PropertyGrid`'s custom values.
.. method:: PostDrawCell(self, dc, propGrid, cell, flags)
Utility to be called after drawing is done, to revert whatever changes :meth:`PreDrawCell` did.
:param `dc`:
:type `dc`: wx.DC
:param `propGrid`:
:type `propGrid`: wx.propgrid.PropertyGrid
:param `cell`:
:type `cell`: wx.propgrid.PGCell
:param `flags`: Same as those passed to :meth:`PreDrawCell` .
:type `flags`: int
.. method:: PreDrawCell(self, dc, rect, cell, flags)
Utility to render cell bitmap and set text colour plus bg brush colour.
:param `dc`:
:type `dc`: wx.DC
:param `rect`:
:type `rect`: wx.Rect
:param `cell`:
:type `cell`: wx.propgrid.PGCell
:param `flags`:
:type `flags`: int
:rtype: `int`
:returns:
Returns image width, which, for instance, can be passed to DrawText.
.. method:: Render(self, dc, rect, propertyGrid, property, column, item, flags)
Returns ``True`` if rendered something in the foreground (text or bitmap.
:param `dc`:
:type `dc`: wx.DC
:param `rect`:
:type `rect`: wx.Rect
:param `propertyGrid`:
:type `propertyGrid`: wx.propgrid.PropertyGrid
:param `property`:
:type `property`: wx.propgrid.PGProperty
:param `column`:
:type `column`: int
:param `item`:
:type `item`: int
:param `flags`:
:type `flags`: int
:rtype: `bool`
|
