QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Types | Signals | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsCptCityDataItem Class Reference

Base class for all items in the model. More...

#include <qgscptcityarchive.h>

Inheritance diagram for QgsCptCityDataItem:
Inheritance graph
[legend]

Public Types

enum  Type {
  ColorRamp , Collection , Directory , Selection ,
  AllRamps
}
 

Signals

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.
 

Public Member Functions

 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
 

Static Public Member Functions

static int findItem (QVector< QgsCptCityDataItem * > items, QgsCptCityDataItem *item)
 Finds a child index in vector of items using '==' operator.
 

Protected Attributes

QVector< QgsCptCityDataItem * > mChildren
 
QIcon mIcon
 
QString mInfo
 
QString mName
 
QgsCptCityDataItemmParent = nullptr
 
QString mPath
 
bool mPopulated
 
QString mShortInfo
 
QString mToolTip
 
Type mType
 
bool mValid
 

Detailed Description

Base class for all items in the model.

Definition at line 99 of file qgscptcityarchive.h.

Member Enumeration Documentation

◆ Type

Enumerator
ColorRamp 
Collection 
Directory 
Selection 
AllRamps 

Definition at line 103 of file qgscptcityarchive.h.

Constructor & Destructor Documentation

◆ QgsCptCityDataItem()

QgsCptCityDataItem::QgsCptCityDataItem ( QgsCptCityDataItem::Type  type,
QgsCptCityDataItem parent,
const QString &  name,
const QString &  path 
)

Definition at line 514 of file qgscptcityarchive.cpp.

Member Function Documentation

◆ acceptDrop()

virtual Q_DECL_DEPRECATED bool QgsCptCityDataItem::acceptDrop ( )
inlinevirtual

Returns true if the item accepts drag & dropped layers - e.g.

for import.

Deprecated:
QGIS 3.40. Is unused and will be removed in QGIS 4.0.

Definition at line 177 of file qgscptcityarchive.h.

◆ addChildItem()

void QgsCptCityDataItem::addChildItem ( QgsCptCityDataItem child,
bool  refresh = false 
)
virtual

Inserts a new child using alphabetical order based on mName, emits necessary signal to model before and after, sets parent and connects signals.

The refresh argument will refresh the populated item by emitting signals to the model.

Definition at line 581 of file qgscptcityarchive.cpp.

◆ beginInsertItems

void QgsCptCityDataItem::beginInsertItems ( QgsCptCityDataItem parent,
int  first,
int  last 
)
signal

Emitted before child items are added to this item.

This signal must be followed by endInsertItems().

Parameters
parentthe parent item having children added
firstindex of first child item to be added
lastindex last child item, after the addition has occurred
See also
endInsertItems()

◆ beginRemoveItems

void QgsCptCityDataItem::beginRemoveItems ( QgsCptCityDataItem parent,
int  first,
int  last 
)
signal

Emitted before child items are removed from this data item.

This signal must be followed by endRemoveItems().

Parameters
parentthe parent item having children removed
firstindex of first child item to be removed
lastindex of the last child item to be removed
See also
endRemoveItems()

◆ children()

QVector< QgsCptCityDataItem * > QgsCptCityDataItem::children ( ) const
inline

Definition at line 198 of file qgscptcityarchive.h.

◆ createChildren()

QVector< QgsCptCityDataItem * > QgsCptCityDataItem::createChildren ( )
virtual

Returns a vector of children items.

Reimplemented in QgsCptCityDirectoryItem, QgsCptCitySelectionItem, and QgsCptCityAllRampsItem.

Definition at line 526 of file qgscptcityarchive.cpp.

◆ deleteChildItem()

void QgsCptCityDataItem::deleteChildItem ( QgsCptCityDataItem child)
virtual

Removes and deletes a child item, signals to browser are emitted.

Definition at line 618 of file qgscptcityarchive.cpp.

◆ endInsertItems

void QgsCptCityDataItem::endInsertItems ( )
signal

Emitted after child items have been added to this data item.

This signal will always be preceded by beginInsertItems().

See also
beginInsertItems()

◆ endRemoveItems

void QgsCptCityDataItem::endRemoveItems ( )
signal

Emitted after child items have been removed from this data item.

This signal will always be preceded by beginRemoveItems().

See also
beginRemoveItems()

◆ equal()

bool QgsCptCityDataItem::equal ( const QgsCptCityDataItem other)
virtual

Returns true if this item is equal to an other item.

Reimplemented in QgsCptCityColorRampItem, QgsCptCityDirectoryItem, and QgsCptCitySelectionItem.

Definition at line 695 of file qgscptcityarchive.cpp.

◆ findItem()

int QgsCptCityDataItem::findItem ( QVector< QgsCptCityDataItem * >  items,
QgsCptCityDataItem item 
)
static

Finds a child index in vector of items using '==' operator.

Definition at line 645 of file qgscptcityarchive.cpp.

◆ handleDrop()

virtual Q_DECL_DEPRECATED bool QgsCptCityDataItem::handleDrop ( const QMimeData *  data,
Qt::DropAction  action 
)
inlinevirtual

Tries to process the data dropped on this item.

Deprecated:
QGIS 3.40. Is unused and will be removed in QGIS 4.0.

Definition at line 184 of file qgscptcityarchive.h.

◆ hasChildren()

bool QgsCptCityDataItem::hasChildren ( )

Definition at line 576 of file qgscptcityarchive.cpp.

◆ icon() [1/2]

virtual QIcon QgsCptCityDataItem::icon ( )
inlinevirtual

Reimplemented in QgsCptCityColorRampItem.

Definition at line 199 of file qgscptcityarchive.h.

◆ icon() [2/2]

virtual QIcon QgsCptCityDataItem::icon ( QSize  size)
inlinevirtual

Reimplemented in QgsCptCityColorRampItem.

Definition at line 200 of file qgscptcityarchive.h.

◆ info()

QString QgsCptCityDataItem::info ( ) const
inline

Definition at line 203 of file qgscptcityarchive.h.

◆ isPopulated()

bool QgsCptCityDataItem::isPopulated ( )
inline

Returns true if the item is already populated.

Definition at line 141 of file qgscptcityarchive.h.

◆ isValid()

bool QgsCptCityDataItem::isValid ( )
inline

Definition at line 211 of file qgscptcityarchive.h.

◆ leafCount()

int QgsCptCityDataItem::leafCount ( ) const
virtual

Returns the total count of "leaf" items (all children which are end nodes).

Reimplemented in QgsCptCityColorRampItem.

Definition at line 560 of file qgscptcityarchive.cpp.

◆ name()

QString QgsCptCityDataItem::name ( ) const
inline

Definition at line 201 of file qgscptcityarchive.h.

◆ paramWidget()

virtual Q_DECL_DEPRECATED QWidget * QgsCptCityDataItem::paramWidget ( )
inlinevirtual
Deprecated:
QGIS 3.40. Is unused and will be removed in QGIS 4.0.

Definition at line 170 of file qgscptcityarchive.h.

◆ parent()

QgsCptCityDataItem * QgsCptCityDataItem::parent ( ) const
inline

Definition at line 196 of file qgscptcityarchive.h.

◆ path()

QString QgsCptCityDataItem::path ( ) const
inline

Definition at line 202 of file qgscptcityarchive.h.

◆ populate()

void QgsCptCityDataItem::populate ( )
virtual

Populates children using children vector created by createChildren().

Definition at line 532 of file qgscptcityarchive.cpp.

◆ refresh()

void QgsCptCityDataItem::refresh ( )
virtual

Definition at line 656 of file qgscptcityarchive.cpp.

◆ removeChildItem()

QgsCptCityDataItem * QgsCptCityDataItem::removeChildItem ( QgsCptCityDataItem child)
virtual

Removes a child item but doesn't delete it, signals to browser are emitted.

Returns
pointer to the removed item or nullptr if no such item was found

Definition at line 629 of file qgscptcityarchive.cpp.

◆ rowCount()

int QgsCptCityDataItem::rowCount ( )

Definition at line 553 of file qgscptcityarchive.cpp.

◆ setIcon()

void QgsCptCityDataItem::setIcon ( const QIcon &  icon)
inline

Definition at line 206 of file qgscptcityarchive.h.

◆ setParent()

void QgsCptCityDataItem::setParent ( QgsCptCityDataItem parent)
inline

Definition at line 197 of file qgscptcityarchive.h.

◆ setToolTip()

void QgsCptCityDataItem::setToolTip ( const QString &  msg)
inline

Definition at line 208 of file qgscptcityarchive.h.

◆ shortInfo()

QString QgsCptCityDataItem::shortInfo ( ) const
inline

Definition at line 204 of file qgscptcityarchive.h.

◆ toolTip()

QString QgsCptCityDataItem::toolTip ( ) const
inline

Definition at line 209 of file qgscptcityarchive.h.

◆ type()

Type QgsCptCityDataItem::type ( ) const
inline

Definition at line 195 of file qgscptcityarchive.h.

Member Data Documentation

◆ mChildren

QVector<QgsCptCityDataItem *> QgsCptCityDataItem::mChildren
protected

Definition at line 217 of file qgscptcityarchive.h.

◆ mIcon

QIcon QgsCptCityDataItem::mIcon
protected

Definition at line 224 of file qgscptcityarchive.h.

◆ mInfo

QString QgsCptCityDataItem::mInfo
protected

Definition at line 221 of file qgscptcityarchive.h.

◆ mName

QString QgsCptCityDataItem::mName
protected

Definition at line 219 of file qgscptcityarchive.h.

◆ mParent

QgsCptCityDataItem* QgsCptCityDataItem::mParent = nullptr
protected

Definition at line 216 of file qgscptcityarchive.h.

◆ mPath

QString QgsCptCityDataItem::mPath
protected

Definition at line 220 of file qgscptcityarchive.h.

◆ mPopulated

bool QgsCptCityDataItem::mPopulated
protected

Definition at line 218 of file qgscptcityarchive.h.

◆ mShortInfo

QString QgsCptCityDataItem::mShortInfo
protected

Definition at line 222 of file qgscptcityarchive.h.

◆ mToolTip

QString QgsCptCityDataItem::mToolTip
protected

Definition at line 223 of file qgscptcityarchive.h.

◆ mType

Type QgsCptCityDataItem::mType
protected

Definition at line 215 of file qgscptcityarchive.h.

◆ mValid

bool QgsCptCityDataItem::mValid
protected

Definition at line 225 of file qgscptcityarchive.h.


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