Class: QgsProcessingMultipleSelectionDialog

A dialog for selection of multiple options from a fixed list of options.

Note

Not stable API

Added in version 3.6.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsProcessingMultipleSelectionDialog

Base classes

QDialog

QWidget

QObject

QPaintDevice

Methods

selectedOptions

Returns the ordered list of selected options.

setValueFormatter

Sets a callback function to use when encountering an invalid geometry and
class qgis.gui.QgsProcessingMultipleSelectionDialog[source]

Bases: QDialog

__init__(availableOptions: Iterable[Any] = [], selectedOptions: Iterable[Any] = [], parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = Qt.WindowFlags())

Constructor for QgsProcessingMultipleSelectionPanelWidget.

The availableOptions list specifies the list of standard known options for the parameter, whilst the selectedOptions list specifies which options should be initially selected.

The selectedOptions list may contain extra options which are not present in availableOptions, in which case they will be also added as existing options within the dialog.

Parameters:

  • availableOptions (Iterable[Any] = [])

  • selectedOptions (Iterable[Any] = [])

  • parent (Optional[QWidget] = None)

  • flags (Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags())

selectedOptions(self) → List[Any][source]

Returns the ordered list of selected options.

Return type:

List[Any]

setValueFormatter(self, a0: Callable[..., None])[source]

Sets a callback function to use when encountering an invalid geometry and

Parameters:

a0 (Callable[..., None])