PrefsAPI

by 3 contributors:

The PrefsAPI adds support for preferences related functions. It gives access to the preferences system and allows to handle the preferences dialog.

Class overview

Class Name Description
preferences Class to read and write preferences.
preferencesDialog Class to handle the preferences dialog.

Method overview

openPreferencesDialog(in func_ptr callback, in func_ptr launcher);

Methods

openPreferencesDialog()

Opens the preferences dialog. As an option, a user-defined launcher can be used to open the dialog.

openPreferencesDialog(
  in func_ptr callback,
  in func_ptr launcher 
);
Parameters
callback
Callback handler to execute after the preferences dialog has been opened.
launcher
Alternative launcher for the preferences dialog. Can be used if the dialog should not be opened with the menu shortcut.

Document Tags and Contributors

Contributors to this page: Sheppy, Whimboo, jgriffin
Last updated by: Sheppy,