QgsDetailedItemData class

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

Reference
- Constructors, destructors, conversion operators
- Public functions

Constructors, destructors, conversion operators

QgsDetailedItemData() defaulted: Constructor for QgsDetailedItemData.

Public functions

auto category() const -> QString: Returns the item's category.
auto detail() const -> QString: Returns the detailed description for the item.
auto icon() const -> QPixmap: Returns the item's icon.
auto isCheckable() const -> bool: Returns true if the item is checkable.
auto isChecked() const -> bool: Returns true if the item is checked.
auto isEnabled() const -> bool: Returns true if the item is enabled.
auto isRenderedAsWidget() const -> bool: Returns true if the item will be rendered using a widget.
void setCategory(const QString& category): Sets the item's category.
void setCheckable(bool flag): Sets whether the item is checkable.
void setChecked(bool flag): Sets whether the item is checked.
void setDetail(const QString& detail): Sets the detailed description for the item.
void setEnabled(bool flag): Sets whether the item is enabled.
void setIcon(const QPixmap& icon): Sets the item's icon.
void setRenderAsWidget(bool flag): This is a hint to the delegate to render using a widget rather than manually painting every part of the list item.
void setTitle(const QString& title): Sets the title for the item.
auto title() const -> QString: Returns the item's title.

Function documentation

QString QgsDetailedItemData::category() const

Returns the item's category.

QString QgsDetailedItemData::detail() const

Returns the detailed description for the item.

QPixmap QgsDetailedItemData::icon() const

Returns the item's icon.

bool QgsDetailedItemData::isCheckable() const

Returns true if the item is checkable.

bool QgsDetailedItemData::isChecked() const

Returns true if the item is checked.

bool QgsDetailedItemData::isEnabled() const

Returns true if the item is enabled.

bool QgsDetailedItemData::isRenderedAsWidget() const

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

void QgsDetailedItemData::setCategory(const QString& category)

Sets the item's category.

void QgsDetailedItemData::setCheckable(bool flag)

Sets whether the item is checkable.

void QgsDetailedItemData::setChecked(bool flag)

Sets whether the item is checked.

void QgsDetailedItemData::setDetail(const QString& detail)

Sets the detailed description for the item.

void QgsDetailedItemData::setEnabled(bool flag)

Sets whether the item is enabled.

void QgsDetailedItemData::setIcon(const QPixmap& icon)

Sets the item's icon.

void QgsDetailedItemData::setRenderAsWidget(bool flag)

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

void QgsDetailedItemData::setTitle(const QString& title)

Sets the title for the item.

QString QgsDetailedItemData::title() const

Returns the item's title.