Class: QgsProcessingMultipleSelectionPanelWidget

class qgis.gui.QgsProcessingMultipleSelectionPanelWidget(availableOptions: Iterable[Any] = [], selectedOptions: Iterable[Any] = [], parent: QWidget = None)

Bases: QgsPanelWidget

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.

A panel widget for selection of multiple options from a fixed list of options.

Note

Not stable API

New in version 3.14.

Parameters
  • availableOptions (Iterable[Any] = []) –

  • selectedOptions (Iterable[Any] = []) –

  • parent

acceptClicked

Emitted when the accept button is clicked. [signal]

actionEvent()
addOption(self, value: Any, title: str, selected: bool, updateExistingTitle: bool = False)

Adds a new option to the widget.

Parameters
  • value (Any) –

  • title (str) –

  • selected (bool) –

  • updateExistingTitle (bool = False) –

buttonBox(self) → QDialogButtonBox

Returns the widget’s button box.

Return type

QDialogButtonBox

changeEvent()
childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
listView(self) → QListView

Returns pointer to the list view

Return type

QListView

metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
resizeEvent()
selectedOptions(self) → List[Any]

Returns the ordered list of selected options.

Return type

List[Any]

selectionChanged

Emitted when the selection changes in the widget. [signal]

sender()
senderSignalIndex()
setValueFormatter(self, Callable[..., None])

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

sharedPainter()
showEvent()
tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()