QGIS API Documentation  2.17.0-Master (872e6d2)
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
[legend]

Public Types

enum  LayerType {
  NoType, Vector, Raster, Point,
  Line, Polygon, TableLayer, Database,
  Table, Plugin
}
 
- 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,
  Favourites, Project
}
 

Public Member Functions

 QgsLayerItem (QgsDataItem *parent, const QString &name, const QString &path, const QString &uri, LayerType layerType, const QString &providerKey)
 
virtual QString comments () const
 Returns comments of the layer. More...
 
virtual bool equal (const QgsDataItem *other) override
 Returns true if this item is equal to another item (by testing item type and path). More...
 
virtual QString layerName () const
 
QgsMapLayer::LayerType mapLayerType ()
 Returns QgsMapLayer::LayerType. More...
 
QString providerKey ()
 Returns provider key. More...
 
QStringList supportedCRS ()
 Returns the supported CRS. More...
 
QStringList supportedFormats ()
 Returns the supported formats. More...
 
QString uri ()
 Returns layer uri or empty string if layer cannot be created. More...
 
- Public Member Functions inherited from QgsDataItem
 QgsDataItem (QgsDataItem::Type type, QgsDataItem *parent, const QString &name, const QString &path)
 Create new data item. More...
 
virtual ~QgsDataItem ()
 
virtual bool acceptDrop ()
 Returns whether the item accepts drag and dropped layers - e.g. More...
 
virtual QList< QAction * > actions ()
 Returns the list of actions available for this item. More...
 
virtual void addChildItem (QgsDataItem *child, bool refresh=false)
 Inserts a new child item. More...
 
virtual Q_DECL_DEPRECATED Capability capabilities ()
 
virtual Capabilities capabilities2 () const
 
QVector< QgsDataItem * > children () const
 
virtual QVector< QgsDataItem * > createChildren ()
 Create children. More...
 
virtual void deleteChildItem (QgsDataItem *child)
 Removes and deletes a child item, emitting relevant signals to the model. More...
 
virtual bool handleDrop (const QMimeData *, Qt::DropAction)
 Attempts to process the mime data dropped on this item. More...
 
bool hasChildren ()
 
virtual QIcon icon ()
 
Q_DECL_DEPRECATED bool isPopulated ()
 
void moveToThread (QThread *targetThread)
 Move object and all its descendants to thread. More...
 
QString name () const
 
virtual QWidgetparamWidget ()
 
QgsDataItemparent () const
 Get item parent. More...
 
QString path () const
 
virtual QgsDataItemremoveChildItem (QgsDataItem *child)
 Removes a child item and returns it without deleting it. More...
 
int rowCount ()
 
virtual void setCapabilities (const Capabilities &capabilities)
 
virtual bool setCrs (QgsCoordinateReferenceSystem crs)
 
void setIcon (const 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. More...
 
void setPath (const QString &path)
 
virtual void setState (State state)
 Set item state. More...
 
void setToolTip (const QString &msg)
 
State state () const
 
QString toolTip () const
 
Type type () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Static Public Member Functions

static const QIconiconDefault ()
 
static const QIconiconLine ()
 
static const QIconiconPoint ()
 
static const QIconiconPolygon ()
 
static const QIconiconRaster ()
 
static const QIconiconTable ()
 
- 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. More...
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Protected Attributes

LayerType mLayerType
 The layer type. More...
 
QString mProviderKey
 The provider key. More...
 
QStringList mSupportedCRS
 The list of supported CRS. More...
 
QStringList mSupportFormats
 The list of supported formats. More...
 
QString mUri
 The URI. More...
 
- Protected Attributes inherited from QgsDataItem
Capabilities mCapabilities
 
QVector< QgsDataItem * > mChildren
 
QIcon mIcon
 
QMap< QString, QIconmIconMap
 
QString mIconName
 
QString mName
 
QgsDataItemmParent
 
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: More...
 
virtual void depopulate ()
 Remove children recursively and set as not populated. More...
 
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 (bool foreground=false)
 
virtual void refresh ()
 
- 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. More...
 
virtual void populate (const QVector< QgsDataItem * > &children)
 
virtual void refresh (QVector< QgsDataItem * > children)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

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

Definition at line 307 of file qgsdataitem.h.

Member Enumeration Documentation

Enumerator
NoType 
Vector 
Raster 
Point 
Line 
Polygon 
TableLayer 
Database 
Table 
Plugin 

added in 2.10

Definition at line 311 of file qgsdataitem.h.

Constructor & Destructor Documentation

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

Definition at line 677 of file qgsdataitem.cpp.

Member Function Documentation

virtual QString QgsLayerItem::comments ( ) const
inlinevirtual

Returns comments of the layer.

Note
added in 2.12

Definition at line 355 of file qgsdataitem.h.

bool QgsLayerItem::equal ( const QgsDataItem other)
overridevirtual

Returns true if this item is equal to another item (by testing item type and path).

Reimplemented from QgsDataItem.

Definition at line 719 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconDefault ( )
static

Definition at line 148 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconLine ( )
static

Definition at line 108 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconPoint ( )
static

Definition at line 98 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconPolygon ( )
static

Definition at line 118 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconRaster ( )
static

Definition at line 138 of file qgsdataitem.cpp.

const QIcon & QgsLayerItem::iconTable ( )
static

Definition at line 128 of file qgsdataitem.cpp.

virtual QString QgsLayerItem::layerName ( ) const
inlinevirtual
Returns
the layer name

Definition at line 379 of file qgsdataitem.h.

QgsMapLayer::LayerType QgsLayerItem::mapLayerType ( )

Returns QgsMapLayer::LayerType.

Definition at line 710 of file qgsdataitem.cpp.

QString QgsLayerItem::providerKey ( )
inline

Returns provider key.

Definition at line 340 of file qgsdataitem.h.

QStringList QgsLayerItem::supportedCRS ( )
inline

Returns the supported CRS.

Note
Added in 2.8

Definition at line 345 of file qgsdataitem.h.

QStringList QgsLayerItem::supportedFormats ( )
inline

Returns the supported formats.

Note
Added in 2.8

Definition at line 350 of file qgsdataitem.h.

QString QgsLayerItem::uri ( )
inline

Returns layer uri or empty string if layer cannot be created.

Definition at line 337 of file qgsdataitem.h.

Member Data Documentation

LayerType QgsLayerItem::mLayerType
protected

The layer type.

Definition at line 364 of file qgsdataitem.h.

QString QgsLayerItem::mProviderKey
protected

The provider key.

Definition at line 360 of file qgsdataitem.h.

QStringList QgsLayerItem::mSupportedCRS
protected

The list of supported CRS.

Definition at line 366 of file qgsdataitem.h.

QStringList QgsLayerItem::mSupportFormats
protected

The list of supported formats.

Definition at line 368 of file qgsdataitem.h.

QString QgsLayerItem::mUri
protected

The URI.

Definition at line 362 of file qgsdataitem.h.


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