Class: QgsProcessingMultipleSelectionPanelWidget

class qgis.gui.QgsProcessingMultipleSelectionPanelWidget

Bases: QgsPanelWidget

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

Note

Not stable API

New in version 3.14.

QgsProcessingMultipleSelectionPanelWidget(availableOptions: Iterable[Any] = [], selectedOptions: Iterable[Any] = [], parent: QWidget = None) 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.

Methods

actionEvent

addOption

Adds a new option to the widget.

buttonBox

Returns the widget’s button box.

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

Overridden key press event to handle the esc event on the widget.

keyReleaseEvent

leaveEvent

listView

Returns pointer to the list view

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

receivers

resizeEvent

selectedOptions

Returns the ordered list of selected options.

sender

senderSignalIndex

setValueFormatter

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

sharedPainter

showEvent

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

Signals

acceptClicked

Emitted when the accept button is clicked.

selectionChanged

Emitted when the selection changes in the widget.

acceptClicked

Emitted when the accept button is clicked. [signal]

actionEvent(self, QActionEvent)
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(self, QEvent)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent)bool
focusInEvent(self, QFocusEvent)
focusNextChild(self)bool
focusNextPrevChild(self, bool)bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self)bool
hideEvent(self, QHideEvent)
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod)bool
keyPressEvent(self, event: QKeyEvent)

Overridden key press event to handle the esc event on the widget.

Parameters

event – The key event

keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
listView(self)QListView

Returns pointer to the list view

Return type

QListView

metric(self, QPaintDevice.PaintDeviceMetric)int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr)Tuple[bool, int]
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL)int
resizeEvent(self, QResizeEvent)
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(self)QObject
senderSignalIndex(self)int
setValueFormatter(self, Callable[..., None])

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

sharedPainter(self)QPainter
showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
updateMicroFocus(self)
wheelEvent(self, QWheelEvent)