QGIS API Documentation 3.99.0-Master (21b3aa880ba)
Loading...
Searching...
No Matches
QgsAttributesFormTreeViewIndicator Class Reference

Indicator that can be used in an Attributes Form tree view to display icons next to field items. More...

#include <qgsattributesformtreeviewindicator.h>

Inheritance diagram for QgsAttributesFormTreeViewIndicator:

Signals

void changed ()
 Emitted when the indicator changes state (e.g.

Public Member Functions

 QgsAttributesFormTreeViewIndicator (QObject *parent=nullptr)
 Constructs an indicator, optionally transferring ownership to a parent QObject.
QIcon icon () const
 Indicator icon that will be displayed in the Attributes Form tree view.
void setIcon (const QIcon &icon)
 Sets indicator icon that will be displayed in the Attributes Form tree view.
void setToolTip (const QString &tip)
 Sets tool tip text for the indicator.
QString toolTip () const
 Returns tool tip text that will be shown when user hovers mouse over the indicator.

Detailed Description

Indicator that can be used in an Attributes Form tree view to display icons next to field items.

They add extra context to the field item, making it easier to get an overview of constraints and default values.

Warning
Not part of stable API and may change in future QGIS releases.
Since
QGIS 4.0

Definition at line 36 of file qgsattributesformtreeviewindicator.h.

Constructor & Destructor Documentation

◆ QgsAttributesFormTreeViewIndicator()

QgsAttributesFormTreeViewIndicator::QgsAttributesFormTreeViewIndicator ( QObject * parent = nullptr)
explicit

Constructs an indicator, optionally transferring ownership to a parent QObject.

Definition at line 20 of file qgsattributesformtreeviewindicator.cpp.

Member Function Documentation

◆ changed

void QgsAttributesFormTreeViewIndicator::changed ( )
signal

Emitted when the indicator changes state (e.g.

icon).

◆ icon()

QIcon QgsAttributesFormTreeViewIndicator::icon ( ) const

Indicator icon that will be displayed in the Attributes Form tree view.

Definition at line 25 of file qgsattributesformtreeviewindicator.cpp.

◆ setIcon()

void QgsAttributesFormTreeViewIndicator::setIcon ( const QIcon & icon)

Sets indicator icon that will be displayed in the Attributes Form tree view.

Definition at line 30 of file qgsattributesformtreeviewindicator.cpp.

◆ setToolTip()

void QgsAttributesFormTreeViewIndicator::setToolTip ( const QString & tip)

Sets tool tip text for the indicator.

Definition at line 41 of file qgsattributesformtreeviewindicator.cpp.

◆ toolTip()

QString QgsAttributesFormTreeViewIndicator::toolTip ( ) const

Returns tool tip text that will be shown when user hovers mouse over the indicator.

Definition at line 36 of file qgsattributesformtreeviewindicator.cpp.


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