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
|
.. 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.StockPreferencesPage:
==========================================================================================================================================
|phoenix_title| **wx.StockPreferencesPage**
==========================================================================================================================================
Specialization of :ref:`wx.PreferencesPage` useful for certain commonly used preferences page.
On OS X, preferences pages named "General" and "Advanced" are commonly used in apps and the OS provides stock icons for them that should be used. Instead of reimplementing this behavior yourself, you can inherit from :ref:`wx.StockPreferencesPage` and get correct title and icon.
Notice that this class only implements :meth:`~wx.StockPreferencesPage.GetName` and :meth:`~wx.StockPreferencesPage.GetLargeIcon`, you still have to provide the rest of :ref:`wx.PreferencesPage` implementation.
.. versionadded:: 2.9.5
|
|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>StockPreferencesPage</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.StockPreferencesPage_inheritance.png" alt="Inheritance diagram of StockPreferencesPage" 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.PreferencesPage.html" title="wx.PreferencesPage" alt="" coords="23,5,171,35"/> <area shape="rect" id="node2" href="wx.StockPreferencesPage.html" title="wx.StockPreferencesPage" alt="" coords="5,83,189,112"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.StockPreferencesPage.__init__` Constructor.
:meth:`~wx.StockPreferencesPage.GetKind` Returns the page's kind.
:meth:`~wx.StockPreferencesPage.GetLargeIcon` Reimplemented to return stock icon on OS X.
:meth:`~wx.StockPreferencesPage.GetName` Reimplemented to return suitable name for the page's kind.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.StockPreferencesPage.LargeIcon` See :meth:`~wx.StockPreferencesPage.GetLargeIcon`
:attr:`~wx.StockPreferencesPage.Name` See :meth:`~wx.StockPreferencesPage.GetName`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.StockPreferencesPage(PreferencesPage)
**Possible constructors**::
StockPreferencesPage(kind)
Specialization of PreferencesPage useful for certain commonly used
preferences page.
.. method:: __init__(self, kind)
Constructor.
:param `kind`:
:type `kind`: wx.StockPreferencesPage.Kind
.. method:: GetKind(self)
Returns the page's kind.
:rtype: :ref:`wx.StockPreferencesPage.Kind`
.. method:: GetLargeIcon(self)
Reimplemented to return stock icon on OS X.
:rtype: :ref:`wx.Bitmap`
.. method:: GetName(self)
Reimplemented to return suitable name for the page's kind.
:rtype: `string`
.. attribute:: LargeIcon
See :meth:`~wx.StockPreferencesPage.GetLargeIcon`
.. attribute:: Name
See :meth:`~wx.StockPreferencesPage.GetName`
.. toctree::
:maxdepth: 1
:hidden:
wx.StockPreferencesPage.Kind.enumeration
|
