Class: QgsCheckableComboBox

QComboBox subclass which allows selecting multiple items.

Class Hierarchy

Base classes

QComboBox
QWidget
QObject
QPaintDevice

class qgis.gui.QgsCheckableComboBox

Bases: QComboBox

__init__(parent: QWidget | None = None)

Constructor for QgsCheckableComboBox.

Parameters:

parent (Optional[QWidget] = None)

addItemWithCheckState(self, text: str | None, state: Qt.CheckState, userData: Any = None)

Adds an item to the combobox with the given text, check state (stored in the Qt.CheckStateRole) and containing the specified userData (stored in the Qt.UserRole). The item is appended to the list of existing items.

Added in version 3.16.

Parameters:

• text (Optional[str])

• state (Qt.CheckState)

• userData (Any = None)

checkedItems(self) → List[str]

Returns currently checked items.

See also

setCheckedItems()

Return type:

List[str]

signal checkedItemsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

checkedItemsData(self) → List[Any]

Returns userData (stored in the Qt.UserRole) associated with currently checked items.

See also

checkedItems()

Return type:

List[Any]

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.

virtual eventFilter(self, object: QObject | None, event: QEvent | None) → bool

Filters events to enable context menu

Parameters:

• object (Optional[QObject])

• event (Optional[QEvent])

Return type:

bool

virtual hidePopup(self)

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

itemCheckState(self, index: int) → Qt.CheckState

Returns the checked state of the item identified by index

Parameters:

index (int) – item index

See also

setItemCheckState()

See also

toggleItemCheckState()

Return type:

Qt.CheckState

virtual resizeEvent(self, event: QResizeEvent | None)

Handler for widget resizing

Parameters:

event (Optional[QResizeEvent])

selectAllOptions(self)

Selects all items.

separator(self) → str

Returns separator used to separate items in the display text.

See also

setSeparator()

Return type:

str

setCheckedItems(self, items: Iterable[str | None])

Set items which should be checked/selected.

Parameters:

items (Iterable[Optional[str]]) – items to select

See also

checkedItems()

setDefaultText(self, text: str | None)

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

Parameters:

text (Optional[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()

See also

toggleItemCheckState()

setSeparator(self, separator: str | None)

Set separator used to separate items in the display text.

Parameters:

separator (Optional[str]) – separator to use

See also

separator()

showContextMenu(self, pos: QPoint)

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

Parameters:

pos (QPoint)

toggleItemCheckState(self, index: int)

Toggles the item check state

Parameters:

index (int) – item index

See also

itemCheckState()

See also

setItemCheckState()