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
Returns the item's category.
Returns the detailed description for the item.
Returns the item's icon.
Returns
True
if the item is checkable.Returns
True
if the item is checked.Returns
True
if the item is enabled.Returns
True
if the item will be rendered using a widget.Sets the item's
category
.Sets whether the item is checkable.
Sets whether the item is checked.
Sets the detailed description for the item.
Sets whether the item is enabled.
Sets the item's
icon
.This is a hint to the delegate to render using a widget rather than manually painting every part of the list item.
Sets the
title
for the item.Returns the item's title.
- category(self) str ¶
Returns the item’s category.
See also
- Return type:
str
- detail(self) str ¶
Returns the detailed description for the item.
See also
- Return type:
str
- isCheckable(self) bool ¶
Returns
True
if the item is checkable.See also
- Return type:
bool
- isChecked(self) bool ¶
Returns
True
if the item is checked.See also
- Return type:
bool
- isEnabled(self) bool ¶
Returns
True
if the item is enabled.See also
- Return type:
bool
- isRenderedAsWidget(self) bool ¶
Returns
True
if the item will be rendered using a widget.See also
- Return type:
bool
- setCategory(self, category: str)¶
Sets the item’s
category
.See also
- Parameters:
category (str) –
- setCheckable(self, flag: bool)¶
Sets whether the item is checkable.
See also
- Parameters:
flag (bool) –
- setChecked(self, flag: bool)¶
Sets whether the item is checked.
See also
- Parameters:
flag (bool) –
- setDetail(self, detail: str)¶
Sets the detailed description for the item.
See also
- Parameters:
detail (str) –
- setEnabled(self, flag: bool)¶
Sets whether the item is enabled.
See also
- Parameters:
flag (bool) –
- 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.
See also
- Parameters:
flag (bool) –
- title(self) str ¶
Returns the item’s title.
See also
- Return type:
str