stratified_packager.gui.wdg_plugin_options_page

Plugin settings form integrated into QGIS ‘Options’ menu.

Classes

`PluginOptionsPageWidget`([parent])	Settings form embedded into QGIS 'options' menu.
`PluginOptionsPageWidgetFactory`(args, *kwargs)	Factory for options widget.

class stratified_packager.gui.wdg_plugin_options_page.PluginOptionsPageWidget(parent=None)[source]

Settings form embedded into QGIS ‘options’ menu.

Parameters:: parent (QWidget | None)

static _coerce_for_setting(spec, raw)[source]

Coerce an editor’s string token to the type its setting descriptor stores.

Parameters:

spec (FieldSpec) – The field being written.
raw (str) – The editor’s value as a string token.

Return type:

bool | int | str

Returns:

The value typed for the setting (bool / int / str).

__init__(parent=None)[source]

Initialize settings dialog.

Parameters:: parent (QWidget | None) – base class for widgets for pages included in the options dialog.

_build_defaults_editors()[source]

Build a concrete editor and an override-note label for each default field.

Return type:: None

_refresh_override_notes()[source]

Show, per field, whether the active project shadows the setting (SPEC §19).

Return type:: None

apply()[source]

Permanently apply settings shown in options page (e.g. save them to QgsSettings objects).

This is usually called when the options dialog is accepted. A rejected write is contained and reported here, as this is a QGIS-invoked boundary and the failure must not escape into the options dialog.

Return type:: None

initGui()[source]

Set up UI elements.

Return type:: None

load_settings()[source]

Load options from QgsSettings into UI form.

Return type:: None

on_reset_settings()[source]

Reset settings to default values (set in the settings module).

Return type:: None

btn_help: qgis.PyQt.QtWidgets.QPushButton

btn_report: qgis.PyQt.QtWidgets.QPushButton

btn_reset: qgis.PyQt.QtWidgets.QPushButton

defaults_host: qgis.PyQt.QtWidgets.QWidget

gridLayout: qgis.PyQt.QtWidgets.QGridLayout

grp_defaults: qgis.PyQt.QtWidgets.QGroupBox

grp_misc: qgis.PyQt.QtWidgets.QGroupBox

lbl_title: qgis.PyQt.QtWidgets.QLabel

lbl_version_saved: qgis.PyQt.QtWidgets.QLabel

lbl_version_saved_value: qgis.PyQt.QtWidgets.QLabel

opt_debug: qgis.PyQt.QtWidgets.QCheckBox

verticalLayout: qgis.PyQt.QtWidgets.QVBoxLayout

class stratified_packager.gui.wdg_plugin_options_page.PluginOptionsPageWidgetFactory(*args, **kwargs)[source]

Factory for options widget.

Parameters:

args (Any)
kwargs (Any)

createWidget(parent=None)[source]

Create settings widget.

Parameters:: parent (QWidget | None) – Qt parent where to include the options page.
Return type:: PluginOptionsPageWidget | None
Returns:: options page for tab widget

icon()[source]

Return plugin icon, used as tab icon in QGIS options tab widget.

Return type:: QIcon
Returns:: plugin’s icon

title()[source]

Return plugin title, used to name the tab in QGIS options tab widget.

Return type:: str
Returns:: plugin title from about module