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-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.propgrid.PropertyGridPage:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.PropertyGridPage**
==========================================================================================================================================
Holder of property grid page information.
You can subclass this and give instance in :meth:`wx.propgrid.PropertyGridManager.AddPage` . It inherits from :ref:`wx.EvtHandler` and can be used to process events specific to this page (id of events will still be same as manager's). If you don't want to use it to process all events of the page, you need to return ``False`` in the derived :meth:`wx.propgrid.PropertyGridPage.IsHandlingAllEvents` .
Please note that :ref:`wx.propgrid.PropertyGridPage` lacks many non-const property manipulation functions found in :ref:`wx.propgrid.PropertyGridManager`. Please use parent manager (m_manager member variable) when needed.
Please note that most member functions are inherited and as such not documented on this page. This means you will probably also want to read :ref:`wx.propgrid.PropertyGridInterface` class reference.
|phoenix_title| Event Handling
==============================
:ref:`wx.propgrid.PropertyGridPage` receives events emitted by its :ref:`wx.propgrid.PropertyGridManager`, but only those events that are specific to that page. If :ref:`wx.propgrid.PropertyGridPage`:: IsHandlingAllEvents returns ``False``, then unhandled events are sent to the manager's parent, as usual. See :ref:`PropertyGrid Event Handling <wx.propgrid.PropertyGrid>` for more information.
|
|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>PropertyGridPage</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.PropertyGridPage_inheritance.png" alt="Inheritance diagram of PropertyGridPage" 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.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node2" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> <area shape="rect" id="node6" href="wx.propgrid.PropertyGridPage.html" title="wx.propgrid.PropertyGridPage" alt="" coords="196,160,405,189"/> <area shape="rect" id="node4" href="wx.propgrid.PropertyGridInterface.html" title="wx.propgrid.PropertyGridInterface" alt="" coords="184,83,417,112"/> <area shape="rect" id="node5" href="wx.propgrid.PropertyGridPageState.html" title="wx.propgrid.PropertyGridPageState" alt="" coords="443,83,688,112"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.PropertyGridPage.__init__`
:meth:`~wx.propgrid.PropertyGridPage.Clear` Deletes all properties on page.
:meth:`~wx.propgrid.PropertyGridPage.FitColumns` Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well).
:meth:`~wx.propgrid.PropertyGridPage.GetIndex` Returns page index in manager;.
:meth:`~wx.propgrid.PropertyGridPage.GetRoot` Returns "root property".
:meth:`~wx.propgrid.PropertyGridPage.GetSplitterPosition` Returns x-coordinate position of splitter on a page.
:meth:`~wx.propgrid.PropertyGridPage.GetToolId` Returns id of the tool bar item that represents this page on :ref:`wx.propgrid.PropertyGridManager`'s :ref:`wx.ToolBar`.
:meth:`~wx.propgrid.PropertyGridPage.Init` Do any member initialization in this method.
:meth:`~wx.propgrid.PropertyGridPage.IsHandlingAllEvents` Return ``False`` here to indicate unhandled events should be propagated to manager's parent, as normal.
:meth:`~wx.propgrid.PropertyGridPage.OnShow` Called every time page is about to be shown.
:meth:`~wx.propgrid.PropertyGridPage.RefreshProperty` Refreshes given property on page.
:meth:`~wx.propgrid.PropertyGridPage.SetSplitterPosition` Sets splitter position on page.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.propgrid.PropertyGridPage.Index` See :meth:`~wx.propgrid.PropertyGridPage.GetIndex`
:attr:`~wx.propgrid.PropertyGridPage.Root` See :meth:`~wx.propgrid.PropertyGridPage.GetRoot`
:attr:`~wx.propgrid.PropertyGridPage.SplitterPosition` See :meth:`~wx.propgrid.PropertyGridPage.GetSplitterPosition` and :meth:`~wx.propgrid.PropertyGridPage.SetSplitterPosition`
:attr:`~wx.propgrid.PropertyGridPage.ToolId` See :meth:`~wx.propgrid.PropertyGridPage.GetToolId`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.PropertyGridPage(EvtHandler, PropertyGridInterface, PropertyGridPageState)
**Possible constructors**::
PropertyGridPage()
Holder of property grid page information.
.. method:: __init__(self)
.. method:: Clear(self)
Deletes all properties on page.
.. method:: FitColumns(self)
Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well).
Note that you can also get calculated column widths by calling :meth:`GetColumnWidth` immediately after this function returns.
:rtype: :ref:`Size`
:returns:
Returns minimum size for the page to still display everything.
.. note::
This function only works properly if size of containing grid was already fairly large.
.. method:: GetIndex(self)
Returns page index in manager;.
:rtype: `int`
.. method:: GetRoot(self)
Returns "root property".
It does not have name, etc. and it is not visible. It is only useful for accessing its children.
:rtype: :ref:`wx.propgrid.PGProperty`
.. method:: GetSplitterPosition(self, col=0)
Returns x-coordinate position of splitter on a page.
:param `col`:
:type `col`: int
:rtype: `int`
.. method:: GetToolId(self)
Returns id of the tool bar item that represents this page on :ref:`wx.propgrid.PropertyGridManager`'s :ref:`wx.ToolBar`.
:rtype: `int`
.. method:: Init(self)
Do any member initialization in this method.
.. note::
- Called every time the page is added into a manager.
- You can add properties to the page here.
.. method:: IsHandlingAllEvents(self)
Return ``False`` here to indicate unhandled events should be propagated to manager's parent, as normal.
:rtype: `bool`
.. method:: OnShow(self)
Called every time page is about to be shown.
Useful, for instance, creating properties just-in-time.
.. method:: RefreshProperty(self, p)
Refreshes given property on page.
:param `p`:
:type `p`: wx.propgrid.PGProperty
.. method:: SetSplitterPosition(self, splitterPos, col=0)
Sets splitter position on page.
:param `splitterPos`:
:type `splitterPos`: int
:param `col`:
:type `col`: int
.. note::
Splitter position cannot exceed grid size, and therefore setting it during form creation may fail as initial grid size is often smaller than desired splitter position, especially when sizers are being used.
.. attribute:: Index
See :meth:`~wx.propgrid.PropertyGridPage.GetIndex`
.. attribute:: Root
See :meth:`~wx.propgrid.PropertyGridPage.GetRoot`
.. attribute:: SplitterPosition
See :meth:`~wx.propgrid.PropertyGridPage.GetSplitterPosition` and :meth:`~wx.propgrid.PropertyGridPage.SetSplitterPosition`
.. attribute:: ToolId
See :meth:`~wx.propgrid.PropertyGridPage.GetToolId`
|
