QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
QgsDevToolsModelGroup Class Reference

Base class for dev tools model "group" nodes, which contain children of their own. More...

#include <qgsdevtoolsmodelnode.h>

Inheritance diagram for QgsDevToolsModelGroup:

Public Member Functions

 QgsDevToolsModelGroup (QgsDevToolsModelGroup &&other) noexcept=default
 Constructor for a QgsDevToolsModelGroup.
 ~QgsDevToolsModelGroup () override
QgsDevToolsModelNodeaddChild (std::unique_ptr< QgsDevToolsModelNode > child)
 Adds a child node to this node.
QgsDevToolsModelNodechildAt (int index)
 Returns the child at the specified index.
int childCount () const final
 Returns the number of child nodes owned by this node.
void clear ()
 Clears the group, removing all its children.
QVariant data (int role=Qt::DisplayRole) const override
 Returns the node's data for the specified model role.
int indexOf (QgsDevToolsModelNode *child) const
 Returns the index of the specified child node.
QgsDevToolsModelGroupoperator= (QgsDevToolsModelGroup &&other) noexcept=default
 Assignment operator for QgsDevToolsModelGroup.
QVariant toVariant () const override
 Converts the node's contents to a variant.
Public Member Functions inherited from QgsDevToolsModelNode
virtual ~QgsDevToolsModelNode ()
virtual QList< QAction * > actions (QObject *parent)
 Returns a list of actions relating to the node.
QgsDevToolsModelGroupparent ()
 Returns the node's parent node.

Protected Member Functions

 QgsDevToolsModelGroup (const QString &title)
 Constructor for a QgsDevToolsModelGroup, with the specified title.
void addKeyValueNode (const QString &key, const QString &value, const QColor &color=QColor())
 Adds a simple key: value node to the group.
Protected Member Functions inherited from QgsDevToolsModelNode
 QgsDevToolsModelNode ()

Protected Attributes

std::deque< std::unique_ptr< QgsDevToolsModelNode > > mChildren

Detailed Description

Base class for dev tools model "group" nodes, which contain children of their own.

Since
QGIS 4.0

Definition at line 87 of file qgsdevtoolsmodelnode.h.

Constructor & Destructor Documentation

◆ ~QgsDevToolsModelGroup()

QgsDevToolsModelGroup::~QgsDevToolsModelGroup ( )
overridedefault

◆ QgsDevToolsModelGroup() [1/2]

QgsDevToolsModelGroup::QgsDevToolsModelGroup ( QgsDevToolsModelGroup && other)
defaultnoexcept

Constructor for a QgsDevToolsModelGroup.

Copy constructor is disabled

◆ QgsDevToolsModelGroup() [2/2]

QgsDevToolsModelGroup::QgsDevToolsModelGroup ( const QString & title)
protected

Constructor for a QgsDevToolsModelGroup, with the specified title.

Definition at line 53 of file qgsdevtoolsmodelnode.cpp.

Member Function Documentation

◆ addChild()

QgsDevToolsModelNode * QgsDevToolsModelGroup::addChild ( std::unique_ptr< QgsDevToolsModelNode > child)

Adds a child node to this node.

Returns a pointer to the newly added node.

Definition at line 60 of file qgsdevtoolsmodelnode.cpp.

◆ addKeyValueNode()

void QgsDevToolsModelGroup::addKeyValueNode ( const QString & key,
const QString & value,
const QColor & color = QColor() )
protected

Adds a simple key: value node to the group.

Definition at line 170 of file qgsdevtoolsmodelnode.cpp.

◆ childAt()

QgsDevToolsModelNode * QgsDevToolsModelGroup::childAt ( int index)

Returns the child at the specified index.

Definition at line 82 of file qgsdevtoolsmodelnode.cpp.

◆ childCount()

int QgsDevToolsModelGroup::childCount ( ) const
inlinefinalvirtual

Returns the number of child nodes owned by this node.

Implements QgsDevToolsModelNode.

Definition at line 128 of file qgsdevtoolsmodelnode.h.

◆ clear()

void QgsDevToolsModelGroup::clear ( )

Clears the group, removing all its children.

Definition at line 88 of file qgsdevtoolsmodelnode.cpp.

◆ data()

QVariant QgsDevToolsModelGroup::data ( int role = Qt::DisplayRole) const
overridevirtual

Returns the node's data for the specified model role.

Implements QgsDevToolsModelNode.

Definition at line 93 of file qgsdevtoolsmodelnode.cpp.

◆ indexOf()

int QgsDevToolsModelGroup::indexOf ( QgsDevToolsModelNode * child) const

Returns the index of the specified child node.

Warning
child must be a valid child of this node.

Definition at line 71 of file qgsdevtoolsmodelnode.cpp.

◆ operator=()

QgsDevToolsModelGroup & QgsDevToolsModelGroup::operator= ( QgsDevToolsModelGroup && other)
defaultnoexcept

Assignment operator for QgsDevToolsModelGroup.

Copy assignment is disabled

◆ toVariant()

QVariant QgsDevToolsModelGroup::toVariant ( ) const
overridevirtual

Converts the node's contents to a variant.

Reimplemented from QgsDevToolsModelNode.

Definition at line 106 of file qgsdevtoolsmodelnode.cpp.

Member Data Documentation

◆ mChildren

std::deque<std::unique_ptr<QgsDevToolsModelNode> > QgsDevToolsModelGroup::mChildren
protected

Definition at line 145 of file qgsdevtoolsmodelnode.h.


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