QGIS API Documentation 3.99.0-Master (752b475928d)
Loading...
Searching...
No Matches
QgsCptCityCollectionItem Class Reference

A logical collection of subcollections and color ramps for use in QgsCptCityBrowserModel. More...

#include <qgscptcityarchive.h>

Inheritance diagram for QgsCptCityCollectionItem:

Public Member Functions

 QgsCptCityCollectionItem (QgsCptCityDataItem *parent, const QString &name, const QString &path)
 ~QgsCptCityCollectionItem () override
void addChild (QgsCptCityDataItem *item)
QVector< QgsCptCityDataItem * > childrenRamps (bool recursive)
void setPopulated ()
Public Member Functions inherited from QgsCptCityDataItem
 QgsCptCityDataItem (QgsCptCityDataItem::Type type, QgsCptCityDataItem *parent, const QString &name, const QString &path)
virtual Q_DECL_DEPRECATED bool acceptDrop ()
 Returns true if the item accepts drag & dropped layers - e.g.
virtual void addChildItem (QgsCptCityDataItem *child, bool refresh=false)
 Inserts a new child using alphabetical order based on mName, emits necessary signal to model before and after, sets parent and connects signals.
QVector< QgsCptCityDataItem * > children () const
virtual QVector< QgsCptCityDataItem * > createChildren ()
 Returns a vector of children items.
virtual void deleteChildItem (QgsCptCityDataItem *child)
 Removes and deletes a child item, signals to browser are emitted.
virtual bool equal (const QgsCptCityDataItem *other)
 Returns true if this item is equal to an other item.
virtual Q_DECL_DEPRECATED bool handleDrop (const QMimeData *data, Qt::DropAction action)
 Tries to process the data dropped on this item.
bool hasChildren ()
virtual QIcon icon ()
virtual QIcon icon (QSize size)
QString info () const
bool isPopulated ()
 Returns true if the item is already populated.
bool isValid ()
virtual int leafCount () const
 Returns the total count of "leaf" items (all children which are end nodes).
QString name () const
virtual Q_DECL_DEPRECATED QWidget * paramWidget ()
QgsCptCityDataItemparent () const
QString path () const
virtual void populate ()
 Populates children using children vector created by createChildren().
virtual void refresh ()
virtual QgsCptCityDataItemremoveChildItem (QgsCptCityDataItem *child)
 Removes a child item but doesn't delete it, signals to browser are emitted.
int rowCount ()
void setIcon (const QIcon &icon)
void setParent (QgsCptCityDataItem *parent)
void setToolTip (const QString &msg)
QString shortInfo () const
QString toolTip () const
Type type () const

Protected Attributes

bool mPopulatedRamps = false
Protected Attributes inherited from QgsCptCityDataItem
QVector< QgsCptCityDataItem * > mChildren
QIcon mIcon
QString mInfo
QString mName
QgsCptCityDataItemmParent = nullptr
QString mPath
bool mPopulated = false
QString mShortInfo
QString mToolTip
Type mType
bool mValid = true

Additional Inherited Members

Public Types inherited from QgsCptCityDataItem
enum  Type {
  ColorRamp , Collection , Directory , Selection ,
  AllRamps
}
Signals inherited from QgsCptCityDataItem
void beginInsertItems (QgsCptCityDataItem *parent, int first, int last)
 Emitted before child items are added to this item.
void beginRemoveItems (QgsCptCityDataItem *parent, int first, int last)
 Emitted before child items are removed from this data item.
void endInsertItems ()
 Emitted after child items have been added to this data item.
void endRemoveItems ()
 Emitted after child items have been removed from this data item.
Static Public Member Functions inherited from QgsCptCityDataItem
static int findItem (QVector< QgsCptCityDataItem * > items, QgsCptCityDataItem *item)
 Finds a child index in vector of items using '==' operator.

Detailed Description

A logical collection of subcollections and color ramps for use in QgsCptCityBrowserModel.

Definition at line 314 of file qgscptcityarchive.h.

Constructor & Destructor Documentation

◆ QgsCptCityCollectionItem()

QgsCptCityCollectionItem::QgsCptCityCollectionItem ( QgsCptCityDataItem * parent,
const QString & name,
const QString & path )

Definition at line 834 of file qgscptcityarchive.cpp.

◆ ~QgsCptCityCollectionItem()

QgsCptCityCollectionItem::~QgsCptCityCollectionItem ( )
override

Definition at line 840 of file qgscptcityarchive.cpp.

Member Function Documentation

◆ addChild()

void QgsCptCityCollectionItem::addChild ( QgsCptCityDataItem * item)
inline

Definition at line 323 of file qgscptcityarchive.h.

◆ childrenRamps()

QVector< QgsCptCityDataItem * > QgsCptCityCollectionItem::childrenRamps ( bool recursive)

Definition at line 845 of file qgscptcityarchive.cpp.

◆ setPopulated()

void QgsCptCityCollectionItem::setPopulated ( )
inline

Definition at line 322 of file qgscptcityarchive.h.

Member Data Documentation

◆ mPopulatedRamps

bool QgsCptCityCollectionItem::mPopulatedRamps = false
protected

Definition at line 327 of file qgscptcityarchive.h.


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