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
|
.. 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.PreferencesPage:
==========================================================================================================================================
|phoenix_title| **wx.PreferencesPage**
==========================================================================================================================================
One page of preferences dialog.
This is the base class for implementation of application's preferences. Its methods return various properties of the page, such as title or icon. The actual page is created by :meth:`~wx.PreferencesPage.CreateWindow`.
.. versionadded:: 2.9.5
.. seealso:: :ref:`wx.StockPreferencesPage`
|
|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>PreferencesPage</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.PreferencesPage_inheritance.png" alt="Inheritance diagram of PreferencesPage" 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.PreferencesPage.html" title="wx.PreferencesPage" alt="" coords="5,5,159,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.StockPreferencesPage`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.PreferencesPage.__init__` Constructor.
:meth:`~wx.PreferencesPage.CreateWindow` Create a window for this page.
:meth:`~wx.PreferencesPage.GetIcon` Return the icon to be used for the page on some platforms.
:meth:`~wx.PreferencesPage.GetLargeIcon`
:meth:`~wx.PreferencesPage.GetName` Return name of the page.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.PreferencesPage.Icon` See :meth:`~wx.PreferencesPage.GetIcon`
:attr:`~wx.PreferencesPage.LargeIcon` See :meth:`~wx.PreferencesPage.GetLargeIcon`
:attr:`~wx.PreferencesPage.Name` See :meth:`~wx.PreferencesPage.GetName`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.PreferencesPage(object)
**Possible constructors**::
PreferencesPage()
One page of preferences dialog.
.. method:: __init__(self)
Constructor.
.. method:: CreateWindow(self, parent)
Create a window for this page.
The window will be placed into the preferences dialog in platform-specific manner. Depending on the platform, this method may be called before showing the preferences window, when switching to its tab or even more than once. Don't make assumptions about the number of times or the specific time when it is called.
The caller takes ownership of the window.
:ref:`wx.Panel` is usually used, but doesn't have to be.
:param `parent`: Parent window to use.
:type `parent`: wx.Window
:rtype: :ref:`wx.Window`
.. method:: GetIcon(self)
Return the icon to be used for the page on some platforms.
Currently only used on macOS.
:rtype: :ref:`wx.BitmapBundle`
.. versionadded:: 4.1/wxWidgets-3.1.6
.. note::
This method is not pure virtual, but must be implemented on the platforms that require it (macOS). The preprocessor symbol ``HAS_PREF_EDITOR_ICONS`` is defined if this method must be implemented.
.. method:: GetLargeIcon(self)
:rtype: :ref:`wx.Bitmap`
.. wxdeprecated::
This function is deprecated, override :meth:`GetIcon` instead.
.. method:: GetName(self)
Return name of the page.
The name is used for notebook tab's label, icon label etc., depending on the platform.
:rtype: `string`
.. attribute:: Icon
See :meth:`~wx.PreferencesPage.GetIcon`
.. attribute:: LargeIcon
See :meth:`~wx.PreferencesPage.GetLargeIcon`
.. attribute:: Name
See :meth:`~wx.PreferencesPage.GetName`
|
