QGIS API Documentation  3.4.15-Madeira (e83d02e274)
Public Member Functions | List of all members
QgsDetailedItemData Class Reference

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

#include <qgsdetaileditemdata.h>

Public Member Functions

 QgsDetailedItemData ()=default
 Constructor for QgsDetailedItemData. More...
 
QString category () const
 Returns the item's category. More...
 
QString detail () const
 Returns the detailed description for the item. More...
 
QPixmap icon () const
 Returns the item's icon. More...
 
bool isCheckable () const
 Returns true if the item is checkable. More...
 
bool isChecked () const
 Returns true if the item is checked. More...
 
bool isEnabled () const
 Returns true if the item is enabled. More...
 
bool isRenderedAsWidget () const
 Returns true if the item will be rendered using a widget. More...
 
void setCategory (const QString &category)
 Sets the item's category. More...
 
void setCheckable (bool flag)
 Sets whether the item is checkable. More...
 
void setChecked (bool flag)
 Sets whether the item is checked. More...
 
void setDetail (const QString &detail)
 Sets the detailed description for the item. More...
 
void setEnabled (bool flag)
 Sets whether the item is enabled. More...
 
void setIcon (const QPixmap &icon)
 Sets the item's icon. More...
 
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. More...
 
void setTitle (const QString &title)
 Sets the title for the item. More...
 
QString title () const
 Returns the item's title. More...
 

Detailed Description

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

Definition at line 31 of file qgsdetaileditemdata.h.

Constructor & Destructor Documentation

QgsDetailedItemData::QgsDetailedItemData ( )
default

Constructor for QgsDetailedItemData.

Member Function Documentation

QString QgsDetailedItemData::category ( ) const

Returns the item's category.

See also
setCategory()

Definition at line 65 of file qgsdetaileditemdata.cpp.

QString QgsDetailedItemData::detail ( ) const

Returns the detailed description for the item.

See also
setDetail()

Definition at line 60 of file qgsdetaileditemdata.cpp.

QPixmap QgsDetailedItemData::icon ( ) const

Returns the item's icon.

See also
setIcon()

Definition at line 70 of file qgsdetaileditemdata.cpp.

bool QgsDetailedItemData::isCheckable ( ) const

Returns true if the item is checkable.

See also
setCheckable()

Definition at line 75 of file qgsdetaileditemdata.cpp.

bool QgsDetailedItemData::isChecked ( ) const

Returns true if the item is checked.

See also
setChecked()

Definition at line 80 of file qgsdetaileditemdata.cpp.

bool QgsDetailedItemData::isEnabled ( ) const

Returns true if the item is enabled.

See also
setEnabled()

Definition at line 95 of file qgsdetaileditemdata.cpp.

bool QgsDetailedItemData::isRenderedAsWidget ( ) const

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

See also
setRenderAsWidget()

Definition at line 85 of file qgsdetaileditemdata.cpp.

void QgsDetailedItemData::setCategory ( const QString &  category)

Sets the item's category.

See also
category()

Definition at line 30 of file qgsdetaileditemdata.cpp.

void QgsDetailedItemData::setCheckable ( bool  flag)

Sets whether the item is checkable.

See also
isCheckable()

Definition at line 40 of file qgsdetaileditemdata.cpp.

void QgsDetailedItemData::setChecked ( bool  flag)

Sets whether the item is checked.

See also
isChecked()

Definition at line 45 of file qgsdetaileditemdata.cpp.

void QgsDetailedItemData::setDetail ( const QString &  detail)

Sets the detailed description for the item.

See also
detail()

Definition at line 25 of file qgsdetaileditemdata.cpp.

void QgsDetailedItemData::setEnabled ( bool  flag)

Sets whether the item is enabled.

See also
isEnabled()

Definition at line 90 of file qgsdetaileditemdata.cpp.

void QgsDetailedItemData::setIcon ( const QPixmap &  icon)

Sets the item's icon.

See also
icon()

Definition at line 35 of file qgsdetaileditemdata.cpp.

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.

Note
the delegate may completely ignore this depending on the delegate implementation.
See also
isRenderedAsWidget()

Definition at line 50 of file qgsdetaileditemdata.cpp.

void QgsDetailedItemData::setTitle ( const QString &  title)

Sets the title for the item.

See also
title()

Definition at line 20 of file qgsdetaileditemdata.cpp.

QString QgsDetailedItemData::title ( ) const

Returns the item's title.

See also
setTitle()

Definition at line 55 of file qgsdetaileditemdata.cpp.


The documentation for this class was generated from the following files: