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 CreateWindow.
New in version 2.9.5.
See also
Methods Summary¶__init__ |
Constructor. |
CreateWindow |
Create a window for this page. |
GetLargeIcon |
Return 32x32 icon used for the page on some platforms. |
GetName |
Return name of the page. |
Class API¶
Inheritance diagram for class PreferencesPage:
wx.PreferencesPage(object)¶Possible constructors:
PreferencesPage()
One page of preferences dialog.
__init__(self)¶Constructor.
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.
wx.Panel is usually used, but doesn’t have to be.
| Parameters: | parent (wx.Window) – Parent window to use. |
|---|---|
| Return type: | wx.Window |
GetLargeIcon(self)¶Return 32x32 icon used for the page on some platforms.
Currently only used on OS X.
| Return type: | wx.Bitmap |
|---|
Note
This method is only pure virtual on platforms that require it (OS X). On other platforms, it has default implementation that returns an invalid bitmap. The preprocessor symbol HAS_PREF_EDITOR_ICONS is defined if this method must be implemented.
GetName(self)¶Return name of the page.
The name is used for notebook tab’s label, icon label etc., depending on the platform.
| Return type: | string |
|---|
LargeIcon¶See GetLargeIcon