wx.StockPreferencesPage

Specialization of wx.PreferencesPage useful for certain commonly used preferences page.

On macOS, 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 behaviour yourself, you can inherit from wx.StockPreferencesPage and get correct title and icon.

Notice that this class only implements GetName and GetIcon, you still have to provide the rest of wx.PreferencesPage implementation.

Added in version 2.9.5.

Class Hierarchy

Inheritance diagram for class StockPreferencesPage:

Methods Summary

__init__	Constructor.
GetIcon	Reimplemented to return stock icon on macOS.
GetKind	Returns the page’s kind.
GetName	Reimplemented to return suitable name for the page’s kind.

Properties Summary

Icon	See GetIcon
Name	See GetName

Class API

class wx.StockPreferencesPage(PreferencesPage)

Possible constructors:

StockPreferencesPage(kind) -> None

Specialization of PreferencesPage useful for certain commonly used preferences page.

Methods

__init__(self, kind)

Constructor.

Parameters:

kind (Kind)

Return type:

None

---

GetIcon(self)

Reimplemented to return stock icon on macOS.

Return type:

wx.BitmapBundle

---

GetKind(self)

Returns the page’s kind.

Return type:

wx.StockPreferencesPage.Kind

---

GetName(self)

Reimplemented to return suitable name for the page’s kind.

Return type:

str

Properties

Icon

See GetIcon

---

Name

See GetName