QGIS API Documentation  2.8.2-Wien
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsLayerItem Class Reference

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

#include <qgsdataitem.h>

Inheritance diagram for QgsLayerItem:
Inheritance graph

Public Types

enum  LayerType {
  NoType, Vector, Raster, Point,
  Line, Polygon, TableLayer, Database,
- Public Types inherited from QgsDataItem
enum  Capability { NoCapabilities = 0, SetCrs = 1 << 0, Fertile = 1 << 1, Fast = 1 << 2 }
enum  State { NotPopulated, Populating, Populated }
enum  Type {
  Collection, Directory, Layer, Error,

Public Member Functions

 QgsLayerItem (QgsDataItem *parent, QString name, QString path, QString uri, LayerType layerType, QString providerKey)
virtual bool equal (const QgsDataItem *other) override
virtual QString layerName () const
QgsMapLayer::LayerType mapLayerType ()
QString providerKey ()
QStringList supportedCRS ()
 Returns the supported CRS.
QStringList supportedFormats ()
 Returns the supported formats.
QString uri ()
- Public Member Functions inherited from QgsDataItem
 QgsDataItem (QgsDataItem::Type type, QgsDataItem *parent, QString name, QString path)
 Create new data item.
virtual ~QgsDataItem ()
virtual bool acceptDrop ()
virtual QList< QAction * > actions ()
virtual void addChildItem (QgsDataItem *child, bool refresh=false)
capabilities ()
virtual Capabilities capabilities2 () const
QVector< QgsDataItem * > children () const
virtual QVector< QgsDataItem * > createChildren ()
 Create children.
virtual void deleteChildItem (QgsDataItem *child)
virtual bool handleDrop (const QMimeData *, Qt::DropAction)
bool hasChildren ()
virtual QIcon icon ()
bool isPopulated ()
void moveToThread (QThread *targetThread)
 Move object and all its descendants to thread.
QString name () const
virtual QWidget * paramWidget ()
QgsDataItemparent () const
 Get item parent.
QString path () const
virtual QgsDataItemremoveChildItem (QgsDataItem *child)
int rowCount ()
virtual void setCapabilities (Capabilities capabilities)
virtual bool setCrs (QgsCoordinateReferenceSystem crs)
void setIcon (QIcon icon)
void setIconName (const QString &iconName)
void setName (const QString &name)
void setParent (QgsDataItem *parent)
 Set item parent and connect / disconnect parent to / from item signals.
void setPath (const QString &path)
virtual void setState (State state)
 Set item state.
void setToolTip (QString msg)
State state () const
QString toolTip () const
Type type () const

Static Public Member Functions

static const QIcon & iconDefault ()
static const QIcon & iconLine ()
static const QIcon & iconPoint ()
static const QIcon & iconPolygon ()
static const QIcon & iconRaster ()
static const QIcon & iconTable ()
- Static Public Member Functions inherited from QgsDataItem
static void deleteLater (QVector< QgsDataItem * > &items)
static int findItem (QVector< QgsDataItem * > items, QgsDataItem *item)
static QString pathComponent (const QString &component)
 Create path component replacing path separators.

Protected Attributes

LayerType mLayerType
QString mProviderKey
QStringList mSupportedCRS
QStringList mSupportFormats
QString mUri
- Protected Attributes inherited from QgsDataItem
Capabilities mCapabilities
QVector< QgsDataItem * > mChildren
QIcon mIcon
QString mIconName
QString mName
QString mPath
bool mPopulated
State mState
QString mToolTip
Type mType

Additional Inherited Members

- Public Slots inherited from QgsDataItem
virtual void childrenCreated ()
virtual void deleteLater ()
 Safely delete the item:
virtual void depopulate ()
 Remove children recursively and set as not populated.
void emitBeginInsertItems (QgsDataItem *parent, int first, int last)
void emitBeginRemoveItems (QgsDataItem *parent, int first, int last)
void emitDataChanged (QgsDataItem *item)
void emitDataChanged ()
void emitEndInsertItems ()
void emitEndRemoveItems ()
void emitStateChanged (QgsDataItem *item, QgsDataItem::State oldState)
virtual void populate ()
virtual void refresh ()
void setPopulatingIcon ()
- Signals inherited from QgsDataItem
void beginInsertItems (QgsDataItem *parent, int first, int last)
void beginRemoveItems (QgsDataItem *parent, int first, int last)
void dataChanged (QgsDataItem *item)
void endInsertItems ()
void endRemoveItems ()
void stateChanged (QgsDataItem *item, QgsDataItem::State oldState)
- Protected Member Functions inherited from QgsDataItem
bool deferredDelete ()
 The item is scheduled to be deleted.
virtual void populate (QVector< QgsDataItem * > children)
QIcon populatingIcon ()
virtual void refresh (QVector< QgsDataItem * > children)
- Static Protected Attributes inherited from QgsDataItem
static QMap< QString, QIcon > mIconMap = QMap<QString, QIcon>()

Detailed Description

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

Definition at line 250 of file qgsdataitem.h.

Member Enumeration Documentation


Definition at line 254 of file qgsdataitem.h.

Constructor & Destructor Documentation

QgsLayerItem::QgsLayerItem ( QgsDataItem parent,
QString  name,
QString  path,
QString  uri,
LayerType  layerType,
QString  providerKey 

Definition at line 629 of file qgsdataitem.cpp.

Member Function Documentation

bool QgsLayerItem::equal ( const QgsDataItem other)

Reimplemented from QgsDataItem.

Definition at line 655 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconDefault ( )

Definition at line 95 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconLine ( )

Definition at line 55 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconPoint ( )

Definition at line 45 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconPolygon ( )

Definition at line 65 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconRaster ( )

Definition at line 85 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconTable ( )

Definition at line 75 of file qgsdataitem.cpp.

virtual QString QgsLayerItem::layerName ( ) const

Definition at line 310 of file qgsdataitem.h.

QgsMapLayer::LayerType QgsLayerItem::mapLayerType ( )

Definition at line 648 of file qgsdataitem.cpp.

QString QgsLayerItem::providerKey ( )

Definition at line 282 of file qgsdataitem.h.

QStringList QgsLayerItem::supportedCRS ( )

Returns the supported CRS.

Added in 2.8

Definition at line 287 of file qgsdataitem.h.

QStringList QgsLayerItem::supportedFormats ( )

Returns the supported formats.

Added in 2.8

Definition at line 292 of file qgsdataitem.h.

QString QgsLayerItem::uri ( )

Definition at line 279 of file qgsdataitem.h.

Member Data Documentation

LayerType QgsLayerItem::mLayerType

Definition at line 298 of file qgsdataitem.h.

QString QgsLayerItem::mProviderKey

Definition at line 296 of file qgsdataitem.h.

QStringList QgsLayerItem::mSupportedCRS

Definition at line 299 of file qgsdataitem.h.

QStringList QgsLayerItem::mSupportFormats

Definition at line 300 of file qgsdataitem.h.

QString QgsLayerItem::mUri

Definition at line 297 of file qgsdataitem.h.

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