Subgroup: Layout

Class: QgsLayoutItemComboBox¶

class qgis.gui.QgsLayoutItemComboBox¶

Bases: PyQt5.QtWidgets.QComboBox

The QgsLayoutItemComboBox class is a combo box which displays items of a matching type from a layout.

New in version 3.0: Methods

`acceptDrops`
`accessibleDescription`
`accessibleName`
`actionEvent`
`actions`
`activateWindow`
`addAction`
`addActions`
`addItem`	addItem(self, QIcon, str, userData: Any = None)
`addItems`
`adjustSize`
`autoFillBackground`
`backgroundRole`
`baseSize`
`blockSignals`
`changeEvent`
`childAt`	childAt(self, int, int) -> QWidget
`childEvent`
`children`
`childrenRect`
`childrenRegion`
`clear`
`clearEditText`
`clearFocus`
`clearMask`
`close`
`closeEvent`
`colorCount`
`completer`
`connectNotify`
`contentsMargins`
`contentsRect`
`contextMenuEvent`
`contextMenuPolicy`
`count`
`create`
`createWindowContainer`
`currentData`
`currentIndex`
`currentItem`	Returns the item currently selected in the combo box.
`currentText`
`cursor`
`customEvent`
`deleteLater`
`depth`
`destroy`
`devType`
`devicePixelRatio`
`devicePixelRatioF`
`devicePixelRatioFScale`
`disconnect`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`dumpObjectInfo`
`dumpObjectTree`
`duplicatesEnabled`
`dynamicPropertyNames`
`effectiveWinId`
`ensurePolished`
`enterEvent`
`event`
`eventFilter`
`exceptedItemList`	Returns the list of specific items excluded from the combo box.
`find`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`findData`
`findText`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPolicy`
`focusPreviousChild`
`focusProxy`
`focusWidget`
`font`
`fontInfo`
`fontMetrics`
`foregroundRole`
`frameGeometry`
`frameSize`
`geometry`
`getContentsMargins`
`grab`
`grabGesture`
`grabKeyboard`
`grabMouse`	grabMouse(self, Union[QCursor, Qt.CursorShape])
`grabShortcut`
`graphicsEffect`
`graphicsProxyWidget`
`hasFocus`
`hasFrame`
`hasHeightForWidth`
`hasMouseTracking`
`hasTabletTracking`
`height`
`heightForWidth`
`heightMM`
`hide`
`hideEvent`
`hidePopup`
`iconSize`
`inherits`
`initPainter`
`initStyleOption`
`inputMethodEvent`
`inputMethodHints`
`inputMethodQuery`	inputMethodQuery(self, Qt.InputMethodQuery, Any) -> Any
`insertAction`
`insertActions`
`insertItem`	insertItem(self, int, QIcon, str, userData: Any = None)
`insertItems`
`insertPolicy`
`insertSeparator`
`installEventFilter`
`isActiveWindow`
`isAncestorOf`
`isEditable`
`isEnabled`
`isEnabledTo`
`isFullScreen`
`isHidden`
`isLeftToRight`
`isMaximized`
`isMinimized`
`isModal`
`isRightToLeft`
`isSignalConnected`
`isVisible`
`isVisibleTo`
`isWidgetType`
`isWindow`
`isWindowModified`
`isWindowType`
`item`	Return the item currently shown at the specified `index` within the combo box.
`itemData`
`itemDelegate`
`itemIcon`
`itemText`
`itemType`	Returns the filter for the item types to show in the combo box.
`keyPressEvent`
`keyReleaseEvent`
`keyboardGrabber`
`killTimer`
`layout`
`layoutDirection`
`leaveEvent`
`lineEdit`
`locale`
`logicalDpiX`
`logicalDpiY`
`lower`
`mapFrom`
`mapFromGlobal`
`mapFromParent`
`mapTo`
`mapToGlobal`
`mapToParent`
`mask`
`maxCount`
`maxVisibleItems`
`maximumHeight`
`maximumSize`
`maximumWidth`
`metaObject`
`metric`
`minimumContentsLength`
`minimumHeight`
`minimumSize`
`minimumSizeHint`
`minimumWidth`
`model`
`modelColumn`
`mouseDoubleClickEvent`
`mouseGrabber`
`mouseMoveEvent`
`mousePressEvent`
`mouseReleaseEvent`
`move`	move(self, int, int)
`moveEvent`
`moveToThread`
`nativeEvent`
`nativeParentWidget`
`nextInFocusChain`
`normalGeometry`
`objectName`
`overrideWindowFlags`
`overrideWindowState`
`paintEngine`
`paintEvent`
`paintingActive`
`palette`
`parent`
`parentWidget`
`physicalDpiX`
`physicalDpiY`
`pos`
`previousInFocusChain`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`raise_`
`receivers`
`rect`
`releaseKeyboard`
`releaseMouse`
`releaseShortcut`
`removeAction`
`removeEventFilter`
`removeItem`
`render`	render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground\|QWidget.DrawChildren))
`repaint`	repaint(self, int, int, int, int)
`resize`	resize(self, int, int)
`resizeEvent`
`restoreGeometry`
`rootModelIndex`
`saveGeometry`
`scroll`	scroll(self, int, int, QRect)
`sender`
`senderSignalIndex`
`setAcceptDrops`
`setAccessibleDescription`
`setAccessibleName`
`setAttribute`
`setAutoFillBackground`
`setBackgroundRole`
`setBaseSize`	setBaseSize(self, QSize)
`setCompleter`
`setContentsMargins`	setContentsMargins(self, QMargins)
`setContextMenuPolicy`
`setCurrentIndex`
`setCurrentLayout`	Sets the `layout` containing the items to list in the combo box.
`setCurrentText`
`setCursor`
`setDisabled`
`setDuplicatesEnabled`
`setEditText`
`setEditable`
`setEnabled`
`setExceptedItemList`	Sets a list of specific items to exclude from the combo box.
`setFixedHeight`
`setFixedSize`	setFixedSize(self, int, int)
`setFixedWidth`
`setFocus`	setFocus(self, Qt.FocusReason)
`setFocusPolicy`
`setFocusProxy`
`setFont`
`setForegroundRole`
`setFrame`
`setGeometry`	setGeometry(self, int, int, int, int)
`setGraphicsEffect`
`setHidden`
`setIconSize`
`setInputMethodHints`
`setInsertPolicy`
`setItem`	Sets the currently selected `item` in the combo box.
`setItemData`
`setItemDelegate`
`setItemIcon`
`setItemText`
`setItemType`	Sets a filter for the item type to show in the combo box.
`setLayout`
`setLayoutDirection`
`setLineEdit`
`setLocale`
`setMask`	setMask(self, QRegion)
`setMaxCount`
`setMaxVisibleItems`
`setMaximumHeight`
`setMaximumSize`	setMaximumSize(self, QSize)
`setMaximumWidth`
`setMinimumContentsLength`
`setMinimumHeight`
`setMinimumSize`	setMinimumSize(self, QSize)
`setMinimumWidth`
`setModel`
`setModelColumn`
`setMouseTracking`
`setObjectName`
`setPalette`
`setParent`	setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
`setProperty`
`setRootModelIndex`
`setShortcutAutoRepeat`
`setShortcutEnabled`
`setSizeAdjustPolicy`
`setSizeIncrement`	setSizeIncrement(self, QSize)
`setSizePolicy`	setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
`setStatusTip`
`setStyle`
`setStyleSheet`
`setTabOrder`
`setTabletTracking`
`setToolTip`
`setToolTipDuration`
`setUpdatesEnabled`
`setValidator`
`setView`
`setVisible`
`setWhatsThis`
`setWindowFilePath`
`setWindowFlag`
`setWindowFlags`
`setWindowIcon`
`setWindowIconText`
`setWindowModality`
`setWindowModified`
`setWindowOpacity`
`setWindowRole`
`setWindowState`
`setWindowTitle`
`sharedPainter`
`show`
`showEvent`
`showFullScreen`
`showMaximized`
`showMinimized`
`showNormal`
`showPopup`
`signalsBlocked`
`size`
`sizeAdjustPolicy`
`sizeHint`
`sizeIncrement`
`sizePolicy`
`stackUnder`
`startTimer`
`statusTip`
`style`
`styleSheet`
`tabletEvent`
`testAttribute`
`thread`
`timerEvent`
`toolTip`
`toolTipDuration`
`tr`
`underMouse`
`ungrabGesture`
`unsetCursor`
`unsetLayoutDirection`
`unsetLocale`
`update`	update(self, QRect)
`updateGeometry`
`updateMicroFocus`
`updatesEnabled`
`validator`
`view`
`visibleRegion`
`whatsThis`
`wheelEvent`
`width`
`widthMM`
`winId`
`window`
`windowFilePath`
`windowFlags`
`windowHandle`
`windowIcon`
`windowIconText`
`windowModality`
`windowOpacity`
`windowRole`
`windowState`
`windowTitle`
`windowType`
`x`
`y`

Attributes

`AdjustToContents`
`AdjustToContentsOnFirstShow`
`AdjustToMinimumContentsLength`
`AdjustToMinimumContentsLengthWithIcon`
`DrawChildren`
`DrawWindowBackground`
`IgnoreMask`
`InsertAfterCurrent`
`InsertAlphabetically`
`InsertAtBottom`
`InsertAtCurrent`
`InsertAtTop`
`InsertBeforeCurrent`
`NoInsert`
`PdmDepth`
`PdmDevicePixelRatio`
`PdmDevicePixelRatioScaled`
`PdmDpiX`
`PdmDpiY`
`PdmHeight`
`PdmHeightMM`
`PdmNumColors`
`PdmPhysicalDpiX`
`PdmPhysicalDpiY`
`PdmWidth`
`PdmWidthMM`
`activated`	activated(self, int) [signal]
`currentIndexChanged`	currentIndexChanged(self, int) [signal]
`currentTextChanged`	currentTextChanged(self, str) [signal]
`customContextMenuRequested`	customContextMenuRequested(self, QPoint) [signal]
`destroyed`	destroyed(self, QObject = None) [signal]
`editTextChanged`	editTextChanged(self, str) [signal]
`highlighted`	highlighted(self, int) [signal]
`itemChanged`	Emitted whenever the currently selected item changes [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`staticMetaObject`
`windowIconChanged`	windowIconChanged(self, QIcon) [signal]
`windowIconTextChanged`	windowIconTextChanged(self, str) [signal]
`windowTitleChanged`	windowTitleChanged(self, str) [signal]

actionEvent()¶

changeEvent()¶

childEvent()¶

closeEvent()¶

connectNotify()¶

contextMenuEvent()¶

create()¶

currentItem(self) → QgsLayoutItem¶: Returns the item currently selected in the combo box.

customEvent()¶

destroy()¶

disconnectNotify()¶

dragEnterEvent()¶

dragLeaveEvent()¶

dragMoveEvent()¶

dropEvent()¶

enterEvent()¶

exceptedItemList(self) → List[QgsLayoutItem]¶: Returns the list of specific items excluded from the combo box.

See also

setExceptedItemList()

focusInEvent()¶

focusNextChild()¶

focusNextPrevChild()¶

focusOutEvent()¶

focusPreviousChild()¶

hideEvent()¶

initPainter()¶

initStyleOption()¶

inputMethodEvent()¶

isSignalConnected()¶

item(self, index: int) → QgsLayoutItem¶: Return the item currently shown at the specified index within the combo box.

See also

currentItem()

itemChanged¶: Emitted whenever the currently selected item changes [signal]

itemType(self) → QgsLayoutItemRegistry.ItemType¶: Returns the filter for the item types to show in the combo box.

See also

setItemType()

keyPressEvent()¶

keyReleaseEvent()¶

leaveEvent()¶

metric()¶

mouseDoubleClickEvent()¶

mouseMoveEvent()¶

mousePressEvent()¶

mouseReleaseEvent()¶

moveEvent()¶

nativeEvent()¶

paintEvent()¶

receivers()¶

resizeEvent()¶

sender()¶

senderSignalIndex()¶

setCurrentLayout(self, layout: QgsLayout)¶: Sets the layout containing the items to list in the combo box.

setExceptedItemList(self, exceptList: Iterable[QgsLayoutItem])¶: Sets a list of specific items to exclude from the combo box.

See also

exceptedItemList()

setItem(self, item: QgsLayoutItem)¶: Sets the currently selected item in the combo box.

setItemType(self, itemType: QgsLayoutItemRegistry.ItemType)¶

Sets a filter for the item type to show in the combo box.

Parameters:	itemType – type of items to show. Set to QgsLayoutItemRegistry.LayoutItem to

show all items.