QGIS API Documentation 3.99.0-Master (21b3aa880ba)
Loading...
Searching...
No Matches
Public Slots | Public Member Functions | Protected Slots | Protected Attributes | List of all members
QgsAttributesFormTreeViewIndicatorProvider Class Referenceabstract
gui library

Provides an interface for attributes form tree indicator providers. More...

#include <qgsattributesformtreeviewindicatorprovider.h>

Inheritance diagram for QgsAttributesFormTreeViewIndicatorProvider:
Inheritance graph
[legend]

Public Slots

void updateItemIndicator (QgsAttributesFormItem *item)
 Updates the state of a the indicator for the given item.

Public Member Functions

 QgsAttributesFormTreeViewIndicatorProvider (QgsAttributesFormBaseView *view)
 Constructor for QgsAttributesFormTreeViewIndicatorProvider.
bool isEnabled () const
 Returns whether the provider is enabled or not.
void setEnabled (bool enabled)
 Enables or disables the provider.

Protected Slots

void onAddedChildren (QgsAttributesFormItem *item, int indexFrom, int indexTo)
 Connects to signals of new items added to the tree.

Protected Attributes

QgsAttributesFormBaseView * mAttributesFormTreeView = nullptr
bool mEnabled = false
QSet< QgsAttributesFormTreeViewIndicator * > mIndicators

Detailed Description

Provides an interface for attributes form tree indicator providers.

Subclasses must override:

  • acceptsItem()
  • iconName()
  • tooltipText()
Since
QGIS 4.0

Definition at line 39 of file qgsattributesformtreeviewindicatorprovider.h.

Constructor & Destructor Documentation

◆ QgsAttributesFormTreeViewIndicatorProvider()

QgsAttributesFormTreeViewIndicatorProvider::QgsAttributesFormTreeViewIndicatorProvider ( QgsAttributesFormBaseView * view)
explicit

Constructor for QgsAttributesFormTreeViewIndicatorProvider.

The provider gets parented to the view.

Definition at line 23 of file qgsattributesformtreeviewindicatorprovider.cpp.

Member Function Documentation

◆ isEnabled()

bool QgsAttributesFormTreeViewIndicatorProvider::isEnabled ( ) const

Returns whether the provider is enabled or not.

Definition at line 103 of file qgsattributesformtreeviewindicatorprovider.cpp.

◆ onAddedChildren

void QgsAttributesFormTreeViewIndicatorProvider::onAddedChildren ( QgsAttributesFormItem * item,
int indexFrom,
int indexTo )
protectedslot

Connects to signals of new items added to the tree.

Definition at line 29 of file qgsattributesformtreeviewindicatorprovider.cpp.

◆ setEnabled()

void QgsAttributesFormTreeViewIndicatorProvider::setEnabled ( bool enabled)

Enables or disables the provider.

Parameters
enabledBoolead value which specifies whether to enable (true) or disable (false) the provider.

Definition at line 108 of file qgsattributesformtreeviewindicatorprovider.cpp.

◆ updateItemIndicator

void QgsAttributesFormTreeViewIndicatorProvider::updateItemIndicator ( QgsAttributesFormItem * item)
slot

Updates the state of a the indicator for the given item.

If the indicator does not exist, it will be created. If the indicator exists, but is no longer accepted, it will be removed.

Definition at line 60 of file qgsattributesformtreeviewindicatorprovider.cpp.

Member Data Documentation

◆ mAttributesFormTreeView

QgsAttributesFormBaseView* QgsAttributesFormTreeViewIndicatorProvider::mAttributesFormTreeView = nullptr
protected

Definition at line 92 of file qgsattributesformtreeviewindicatorprovider.h.

◆ mEnabled

bool QgsAttributesFormTreeViewIndicatorProvider::mEnabled = false
protected

Definition at line 94 of file qgsattributesformtreeviewindicatorprovider.h.

◆ mIndicators

QSet<QgsAttributesFormTreeViewIndicator *> QgsAttributesFormTreeViewIndicatorProvider::mIndicators
protected

Definition at line 93 of file qgsattributesformtreeviewindicatorprovider.h.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0