Class: QgsDetailedItemData

class qgis.gui.QgsDetailedItemData

Bases: sip.wrapper

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

QgsDetailedItemData() Constructor for QgsDetailedItemData.

QgsDetailedItemData(QgsDetailedItemData)

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.

category(self)str

Returns the item’s category.

See also

setCategory()

Return type

str

detail(self)str

Returns the detailed description for the item.

See also

setDetail()

Return type

str

icon(self)QPixmap

Returns the item’s icon.

See also

setIcon()

Return type

QPixmap

isCheckable(self)bool

Returns True if the item is checkable.

See also

setCheckable()

Return type

bool

isChecked(self)bool

Returns True if the item is checked.

See also

setChecked()

Return type

bool

isEnabled(self)bool

Returns True if the item is enabled.

See also

setEnabled()

Return type

bool

isRenderedAsWidget(self)bool

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

Return type

bool

setCategory(self, category: str)

Sets the item’s category.

See also

category()

Parameters

category (str) –

setCheckable(self, flag: bool)

Sets whether the item is checkable.

See also

isCheckable()

Parameters

flag (bool) –

setChecked(self, flag: bool)

Sets whether the item is checked.

See also

isChecked()

Parameters

flag (bool) –

setDetail(self, detail: str)

Sets the detailed description for the item.

See also

detail()

Parameters

detail (str) –

setEnabled(self, flag: bool)

Sets whether the item is enabled.

See also

isEnabled()

Parameters

flag (bool) –

setIcon(self, icon: QPixmap)

Sets the item’s icon.

See also

icon()

Parameters

icon (QPixmap) –

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.

Parameters

flag (bool) –

setTitle(self, title: str)

Sets the title for the item.

See also

title()

Parameters

title (str) –

title(self)str

Returns the item’s title.

See also

setTitle()

Return type

str