Subgroup: Detailed

Class: QgsDetailedItemData

class qgis.gui.QgsDetailedItemData

Bases: sip.wrapper

Constructor for QgsDetailedItemData.

QgsDetailedItemData(QgsDetailedItemData)

This class is the data only representation of a QgsDetailedItemWidget, designed to be used in custom views.

Methods

category Returns the item’s category.
detail Returns the detailed description for the item.
icon Returns the item’s icon.
isCheckable Returns true if the item is checkable.
isChecked Returns true if the item is checked.
isEnabled Returns true if the item is enabled.
isRenderedAsWidget Returns true if the item will be rendered using a widget.
setCategory Sets the item’s category.
setCheckable Sets whether the item is checkable.
setChecked Sets whether the item is checked.
setDetail Sets the detailed description for the item.
setEnabled Sets whether the item is enabled.
setIcon Sets the item’s icon.
setRenderAsWidget This is a hint to the delegate to render using a widget rather than manually painting every part of the list item.
setTitle Sets the title for the item.
title Returns the item’s title.

Signals

Attributes

category(self) → str

Returns the item’s category.

See also

setCategory()

detail(self) → str

Returns the detailed description for the item.

See also

setDetail()

icon(self) → QPixmap

Returns the item’s icon.

See also

setIcon()

isCheckable(self) → bool

Returns true if the item is checkable.

See also

setCheckable()

isChecked(self) → bool

Returns true if the item is checked.

See also

setChecked()

isEnabled(self) → bool

Returns true if the item is enabled.

See also

setEnabled()

isRenderedAsWidget(self) → bool

Returns true if the item will be rendered using a widget.

setCategory(self, category: str)

Sets the item’s category.

See also

category()

setCheckable(self, flag: bool)

Sets whether the item is checkable.

See also

isCheckable()

setChecked(self, flag: bool)

Sets whether the item is checked.

See also

isChecked()

setDetail(self, detail: str)

Sets the detailed description for the item.

See also

detail()

setEnabled(self, flag: bool)

Sets whether the item is enabled.

See also

isEnabled()

setIcon(self, icon: QPixmap)

Sets the item’s icon.

See also

icon()

setRenderAsWidget(self, flag: bool)

This is a hint to the delegate to render using a widget rather than manually painting every part of the list item.

Note

the delegate may completely ignore this depending on the delegate implementation.

setTitle(self, title: str)

Sets the title for the item.

See also

title()

title(self) → str

Returns the item’s title.

See also

setTitle()