wx.PreferencesEditor

Manage preferences dialog.

This class encapsulates the differences – both in appearance and behaviour – between preferences dialogs on different platforms. In particular, macOS preferences look very different from the typical notebook control used on other platforms, and both macOS and GTK+ preferences windows are modeless unlike Windows options dialogs that are typically modal.

wx.PreferencesEditor is able to hide the differences by hiding the creation of preferences window from the API. Instead, you create an instance of wx.PreferencesEditor and add page descriptions in the form of wx.PreferencesPage using its AddPage method. After setting up the editor object, you must call Show to present preferences to the user.

New in version 2.9.5.

Note

Notice that this class is not derived from wx.Window and hence doesn’t represent a window, even if its Show method does create one internally.

Class Hierarchy

Inheritance diagram for class PreferencesEditor:

Methods Summary

__init__	Constructor.
AddPage	Add a new page to the editor.
Dismiss	Hide the currently shown dialog, if any.
ShouldApplyChangesImmediately	Returns whether changes to values in preferences pages should be applied immediately or only when the user clicks the wx.OK button.
Show	Show the preferences dialog or bring it to the top if it’s already shown.
ShownModally	Returns whether the preferences dialog is shown modally.

Class API

class wx.PreferencesEditor(object)

Possible constructors:

PreferencesEditor(title="")

Manage preferences dialog.

Methods

__init__(self, title="")

Constructor.

Creates an empty editor, use AddPage to add controls to it.

Parameters

title (string) – The title overriding the default title of the top level window used by the editor. It is recommended to not specify this parameter to use the native convention for the preferences dialogs instead.

---

AddPage(self, page)

Add a new page to the editor.

The editor takes ownership of the page and will delete it from its destructor (but not sooner).

Parameters

page (wx.PreferencesPage) –

See also

wx.PreferencesPage, wx.StockPreferencesPage

---

Dismiss(self)

Hide the currently shown dialog, if any.

This is typically called to dismiss the dialog if the object whose preferences it is editing was closed.

---

static ShouldApplyChangesImmediately()

Returns whether changes to values in preferences pages should be applied immediately or only when the user clicks the wx.OK button.

Currently, changes are applied immediately on macOS and GTK+.

The preprocessor macro HAS_PREF_EDITOR_APPLY_IMMEDIATELY is defined in this case as well.

Return type

bool

---

Show(self, parent)

Show the preferences dialog or bring it to the top if it’s already shown.

Notice that this method may or may not block depending on the platform, i.e. depending on whether the dialog is modal or not.

Parameters

parent (wx.Window) – The window that invokes the preferences. Call Dismiss before it’s destroyed.

---

static ShownModally()

Returns whether the preferences dialog is shown modally.

If this method returns False, as it currently does in wxGTK and wxOSX, Show simply makes the dialog visible and returns immediately. If it returns True, as it does in wxMSW and under the other platforms, then the dialog is shown modally, i.e. Show blocks until the user dismisses it.

Notice that it isn’t necessary to test the return value of this method to use this class normally, its interface is designed to work in both cases. However it can sometimes be necessary to call it if the program needs to handle modal dialogs specially, e.g. perhaps to block some periodic background update operation while a modal dialog is shown.

Return type

bool