QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
QgsCptCityColorRampItem Class Reference

Item that represents a layer that can be opened with one of the providers. More...

#include <qgscptcityarchive.h>

Inheritance diagram for QgsCptCityColorRampItem:
Inheritance graph
[legend]

Public Member Functions

 QgsCptCityColorRampItem (QgsCptCityDataItem *parent, const QString &name, const QString &path, const QString &variantName=QString(), bool initialize=false)
 
 QgsCptCityColorRampItem (QgsCptCityDataItem *parent, const QString &name, const QString &path, const QStringList &variantList, bool initialize=false)
 
bool equal (const QgsCptCityDataItem *other) override
 Returns true if this item is equal to an other item.
 
QIcon icon () override
 
QIcon icon (QSize size) override
 
void init ()
 
int leafCount () const override
 Returns the total count of "leaf" items (all children which are end nodes).
 
const QgsCptCityColorRampramp () const
 
- 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 Q_DECL_DEPRECATED bool handleDrop (const QMimeData *data, Qt::DropAction action)
 Tries to process the data dropped on this item.
 
bool hasChildren ()
 
QString info () const
 
bool isPopulated ()
 Returns true if the item is already populated.
 
bool isValid ()
 
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

QList< QIcon > mIcons
 
bool mInitialized
 
QgsCptCityColorRamp mRamp
 
- Protected Attributes inherited from QgsCptCityDataItem
QVector< QgsCptCityDataItem * > mChildren
 
QIcon mIcon
 
QString mInfo
 
QString mName
 
QgsCptCityDataItemmParent = nullptr
 
QString mPath
 
bool mPopulated
 
QString mShortInfo
 
QString mToolTip
 
Type mType
 
bool mValid
 

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

Item that represents a layer that can be opened with one of the providers.

Definition at line 278 of file qgscptcityarchive.h.

Constructor & Destructor Documentation

◆ QgsCptCityColorRampItem() [1/2]

QgsCptCityColorRampItem::QgsCptCityColorRampItem ( QgsCptCityDataItem parent,
const QString &  name,
const QString &  path,
const QString &  variantName = QString(),
bool  initialize = false 
)

Definition at line 704 of file qgscptcityarchive.cpp.

◆ QgsCptCityColorRampItem() [2/2]

QgsCptCityColorRampItem::QgsCptCityColorRampItem ( QgsCptCityDataItem parent,
const QString &  name,
const QString &  path,
const QStringList &  variantList,
bool  initialize = false 
)

Definition at line 716 of file qgscptcityarchive.cpp.

Member Function Documentation

◆ equal()

bool QgsCptCityColorRampItem::equal ( const QgsCptCityDataItem other)
overridevirtual

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

Reimplemented from QgsCptCityDataItem.

Definition at line 784 of file qgscptcityarchive.cpp.

◆ icon() [1/2]

QIcon QgsCptCityColorRampItem::icon ( )
overridevirtual

Reimplemented from QgsCptCityDataItem.

Definition at line 799 of file qgscptcityarchive.cpp.

◆ icon() [2/2]

QIcon QgsCptCityColorRampItem::icon ( QSize  size)
overridevirtual

Reimplemented from QgsCptCityDataItem.

Definition at line 804 of file qgscptcityarchive.cpp.

◆ init()

void QgsCptCityColorRampItem::init ( )

Definition at line 729 of file qgscptcityarchive.cpp.

◆ leafCount()

int QgsCptCityColorRampItem::leafCount ( ) const
inlineoverridevirtual

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

Reimplemented from QgsCptCityDataItem.

Definition at line 294 of file qgscptcityarchive.h.

◆ ramp()

const QgsCptCityColorRamp & QgsCptCityColorRampItem::ramp ( ) const
inline

Definition at line 297 of file qgscptcityarchive.h.

Member Data Documentation

◆ mIcons

QList< QIcon > QgsCptCityColorRampItem::mIcons
protected

Definition at line 306 of file qgscptcityarchive.h.

◆ mInitialized

bool QgsCptCityColorRampItem::mInitialized
protected

Definition at line 304 of file qgscptcityarchive.h.

◆ mRamp

QgsCptCityColorRamp QgsCptCityColorRampItem::mRamp
protected

Definition at line 305 of file qgscptcityarchive.h.


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