Phoenix Logo

phoenix_title wx.StockPreferencesPage

Specialization of 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 wx.StockPreferencesPage and get correct title and icon.

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

New in version 2.9.5.


class_hierarchy Class Hierarchy

Inheritance diagram for class StockPreferencesPage:

method_summary Methods Summary

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

property_summary Properties Summary

LargeIcon See GetLargeIcon
Name See GetName

api Class API



class wx.StockPreferencesPage(PreferencesPage)

Possible constructors:

StockPreferencesPage(kind)

Specialization of PreferencesPage useful for certain commonly used preferences page.


Methods



__init__(self, kind)

Constructor.

Parameters:kind (Kind) –


GetKind(self)

Returns the page’s kind.

Return type: wx.StockPreferencesPage.Kind


GetLargeIcon(self)

Reimplemented to return stock icon on OS X.

Return type: wx.Bitmap


GetName(self)

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

Return type:string

Properties



LargeIcon

See GetLargeIcon



Name

See GetName