Class: QgsCheckableComboBox

class qgis.gui.QgsCheckableComboBox(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QComboBox

Constructor for QgsCheckableComboBox.

QComboBox subclass which allows selecting multiple items.

New in version 3.0.

Parameters

parent

actionEvent()
changeEvent()
checkedItems(self) → List[str]

Returns currently checked items.

Return type

List[str]

checkedItemsChanged

Emitted whenever the checked items list changed. [signal]

Parameters

items (Iterable[str]) –

childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
defaultText(self) → str

Returns default text which will be displayed in the widget when no items selected.

See also

setDefaultText()

Return type

str

deselectAllOptions(self)

Removes selection from all items.

destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
eventFilter(self, object: QObject, event: QEvent) → bool

Filters events to enable context menu

Parameters
  • object (QObject) –

  • event (QEvent) –

Return type

bool

focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
hidePopup(self)

Hides the list of items in the combobox if it is currently visible and resets the internal state.

initPainter()
initStyleOption()
inputMethodEvent()
isSignalConnected()
itemCheckState(self, index: int) → Qt.CheckState

Returns the checked state of the item identified by index

Parameters

index (int) – item index

Return type

Qt.CheckState

keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
resizeEvent(self, event: QResizeEvent)

Handler for widget resizing

Parameters

event (QResizeEvent) –

selectAllOptions(self)

Selects all items.

sender()
senderSignalIndex()
separator(self) → str

Returns separator used to separate items in the display text.

See also

setSeparator()

Return type

str

setCheckedItems(self, items: Iterable[str])

Set items which should be checked/selected.

Parameters

items (Iterable[str]) – items to select

See also

checkedItems()

setDefaultText(self, text: str)

Set default text which will be displayed in the widget when no items selected.

Parameters

text (str) – default text

See also

defaultText()

setItemCheckState(self, index: int, state: Qt.CheckState)

Sets the item check state to state

Parameters
  • index (int) – item index

  • state (Qt.CheckState) – check state

See also

itemCheckState()

setSeparator(self, separator: str)

Set separator used to separate items in the display text.

Parameters

separator (str) – separator to use

See also

separator()

sharedPainter()
showContextMenu(self, pos: QPoint)

Display context menu which allows selecting/deselecting all items at once.

Parameters

pos (QPoint) –

showEvent()
tabletEvent()
timerEvent()
toggleItemCheckState(self, index: int)

Toggles the item check state

Parameters

index (int) – item index

See also

itemCheckState()

updateMicroFocus()
wheelEvent()