QGIS API Documentation  3.21.0-Master (5b68dc587e)
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 <qgslayeritem.h>

Inheritance diagram for QgsLayerItem:
Inheritance graph
[legend]

Public Member Functions

 QgsLayerItem (QgsDataItem *parent, const QString &name, const QString &path, const QString &uri, Qgis::BrowserLayerType layerType, const QString &providerKey)
 Constructor for QgsLayerItem. More...
 
virtual QString comments () const
 Returns comments of the layer. More...
 
QgsAbstractDatabaseProviderConnectiondatabaseConnection () const override
 For data items that represent a DB connection or one of its children, this method returns a connection. More...
 
virtual Q_DECL_DEPRECATED bool deleteLayer ()
 Delete this layer item Use QgsDataItemGuiProvider::deleteLayer instead. More...
 
bool equal (const QgsDataItem *other) override
 Returns true if this item is equal to another item (by testing item type and path). More...
 
bool hasDragEnabled () const override
 Returns true if the item may be dragged. More...
 
virtual QString layerName () const
 
QgsMapLayerType mapLayerType () const
 Returns QgsMapLayerType. More...
 
QgsMimeDataUtils::UriList mimeUris () const override
 Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g. More...
 
QString providerKey () const
 Returns provider key. More...
 
QStringList supportedCrs () const
 Returns the supported CRS. More...
 
QStringList supportedFormats () const
 Returns the supported formats. More...
 
QString uri () const
 Returns layer uri or empty string if layer cannot be created. More...
 
- Public Member Functions inherited from QgsDataItem
 QgsDataItem (Qgis::BrowserItemType type, QgsDataItem *parent, const QString &name, const QString &path, const QString &providerKey=QString())
 Constructor for QgsDataItem, with the specified parent item. More...
 
 ~QgsDataItem () override
 
virtual Q_DECL_DEPRECATED bool acceptDrop ()
 Returns whether the item accepts drag and dropped layers - e.g. More...
 
virtual QList< QAction * > actions (QWidget *parent)
 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 Qgis::BrowserItemCapabilities capabilities2 () const
 Returns the capabilities for the data item. More...
 
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 handleDoubleClick ()
 Called when a user double clicks on the item. More...
 
virtual Q_DECL_DEPRECATED bool handleDrop (const QMimeData *, Qt::DropAction)
 Attempts to process the mime data dropped on this item. More...
 
bool hasChildren ()
 
virtual QIcon icon ()
 
virtual bool layerCollection () const
 Returns true if the data item is a collection of layers The default implementation returns false, subclasses must implement this method if their children are layers. More...
 
virtual QList< QMenu * > menus (QWidget *parent)
 Returns the list of menus available for this item. More...
 
virtual Q_DECL_DEPRECATED QgsMimeDataUtils::Uri mimeUri () const
 Returns mime URI for the data item. More...
 
void moveToThread (QThread *targetThread)
 Move object and all its descendants to thread. More...
 
QString name () const
 Returns the name of the item (the displayed text for the item). More...
 
virtual Q_DECL_DEPRECATED QWidget * paramWidget ()
 Returns source widget from data item for QgsBrowserPropertiesWidget. More...
 
QgsDataItemparent () const
 Gets item parent. More...
 
QString path () const
 
QString providerKey () const
 Returns the provider key that created this item (e.g. More...
 
virtual QgsDataItemremoveChildItem (QgsDataItem *child)
 Removes a child item and returns it without deleting it. More...
 
virtual Q_DECL_DEPRECATED bool rename (const QString &name)
 Sets a new name for the item, and returns true if the item was successfully renamed. More...
 
int rowCount ()
 
Q_DECL_DEPRECATED void setCapabilities (int capabilities)
 
virtual void setCapabilities (Qgis::BrowserItemCapabilities capabilities)
 Sets the capabilities for the data item. More...
 
virtual Q_DECL_DEPRECATED bool setCrs (const QgsCoordinateReferenceSystem &crs)
 Writes the selected crs into data source. More...
 
void setIcon (const QIcon &icon)
 
void setIconName (const QString &iconName)
 
void setName (const QString &name)
 Sets the name of the item (the displayed text for the item). More...
 
void setParent (QgsDataItem *parent)
 Set item parent and connect / disconnect parent to / from item signals. More...
 
void setPath (const QString &path)
 
void setProviderKey (const QString &value)
 Sets the provider key that created this item (e.g. More...
 
void setSortKey (const QVariant &key)
 Sets a custom sorting key for the item. More...
 
virtual void setState (Qgis::BrowserItemState state)
 Set item state. More...
 
void setToolTip (const QString &msg)
 
virtual QVariant sortKey () const
 Returns the sorting key for the item. More...
 
Qgis::BrowserItemState state () const
 
QString toolTip () const
 
Qgis::BrowserItemType type () const
 

Static Public Member Functions

static QIcon iconDefault ()
 
static QIcon iconForWkbType (QgsWkbTypes::Type type)
 Returns the icon for a vector layer whose geometry type is provided. More...
 
static QIcon iconLine ()
 
static QIcon iconMesh ()
 Returns icon for mesh layer type. More...
 
static QString iconName (Qgis::BrowserLayerType layerType)
 Returns the icon name of the given layerType. More...
 
static QIcon iconPoint ()
 
static QIcon iconPointCloud ()
 Returns icon for point cloud layer. More...
 
static QIcon iconPolygon ()
 
static QIcon iconRaster ()
 
static QIcon iconTable ()
 
static QIcon iconVectorTile ()
 Returns icon for vector tile layer. More...
 
static QString layerTypeAsString (Qgis::BrowserLayerType layerType)
 Returns the string representation of the given layerType. More...
 
static Qgis::BrowserLayerType typeFromMapLayer (QgsMapLayer *layer)
 Returns the layer item type corresponding to a QgsMapLayer layer. More...
 
- 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...
 

Protected Attributes

Qgis::BrowserLayerType mLayerType
 The layer type. 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
Qgis::BrowserItemCapabilities mCapabilities = Qgis::BrowserItemCapability::NoCapabilities
 
QVector< QgsDataItem * > mChildren
 
QIcon mIcon
 
QMap< QString, QIcon > mIconMap
 
QString mIconName
 
QString mName
 
QgsDataItemmParent = nullptr
 
QString mPath
 
QString mProviderKey
 
QVariant mSortKey
 Custom sort key. If invalid, name() will be used for sorting instead. More...
 
Qgis::BrowserItemState mState = Qgis::BrowserItemState::NotPopulated
 
QString mToolTip
 
Qgis::BrowserItemType 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. This is used when refreshing collapsed items. More...
 
virtual void populate (bool foreground=false)
 
virtual void refresh ()
 
virtual void refreshConnections (const QString &providerKey=QString())
 Causes a data item provider to refresh all registered connections. More...
 
- Signals inherited from QgsDataItem
void beginInsertItems (QgsDataItem *parent, int first, int last)
 
void beginRemoveItems (QgsDataItem *parent, int first, int last)
 
void connectionsChanged (const QString &providerKey=QString())
 Emitted when the connections of the provider with the specified providerKey have changed. More...
 
void dataChanged (QgsDataItem *item)
 
void endInsertItems ()
 
void endRemoveItems ()
 
void stateChanged (QgsDataItem *item, Qgis::BrowserItemState oldState)
 Emitted when an item's state is changed. More...
 
- Protected Slots inherited from QgsDataItem
void updateIcon ()
 Will request a repaint of this icon. More...
 
- 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 (const QVector< QgsDataItem * > &children)
 Refresh the items from a specified list of child items. More...
 

Detailed Description

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

Definition at line 29 of file qgslayeritem.h.

Constructor & Destructor Documentation

◆ QgsLayerItem()

QgsLayerItem::QgsLayerItem ( QgsDataItem parent,
const QString &  name,
const QString &  path,
const QString &  uri,
Qgis::BrowserLayerType  layerType,
const QString &  providerKey 
)

Constructor for QgsLayerItem.

Definition at line 83 of file qgslayeritem.cpp.

Member Function Documentation

◆ comments()

virtual QString QgsLayerItem::comments ( ) const
inlinevirtual

Returns comments of the layer.

Since
QGIS 2.12

Definition at line 89 of file qgslayeritem.h.

◆ databaseConnection()

QgsAbstractDatabaseProviderConnection * QgsLayerItem::databaseConnection ( ) const
overridevirtual

For data items that represent a DB connection or one of its children, this method returns a connection.

All other data items will return NULL.

Ownership of the returned objects is transferred to the caller.

Since
QGIS 3.16

Reimplemented from QgsDataItem.

Definition at line 69 of file qgslayeritem.cpp.

◆ deleteLayer()

bool QgsLayerItem::deleteLayer ( )
virtual

Delete this layer item Use QgsDataItemGuiProvider::deleteLayer instead.

Deprecated:
QGIS 3.10

Definition at line 199 of file qgslayeritem.cpp.

◆ equal()

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 204 of file qgslayeritem.cpp.

◆ hasDragEnabled()

bool QgsLayerItem::hasDragEnabled ( ) const
inlineoverridevirtual

Returns true if the item may be dragged.

Default implementation returns false. A draggable item has to implement mimeUris() that will be used to pass data.

See also
mimeUris()
Since
QGIS 3.0

Reimplemented from QgsDataItem.

Definition at line 52 of file qgslayeritem.h.

◆ iconDefault()

QIcon QgsLayerItem::iconDefault ( )
static

Definition at line 78 of file qgslayeritem.cpp.

◆ iconForWkbType()

QIcon QgsLayerItem::iconForWkbType ( QgsWkbTypes::Type  type)
static

Returns the icon for a vector layer whose geometry type is provided.

Since
QGIS 3.18

Definition at line 24 of file qgslayeritem.cpp.

◆ iconLine()

QIcon QgsLayerItem::iconLine ( )
static

Definition at line 34 of file qgslayeritem.cpp.

◆ iconMesh()

QIcon QgsLayerItem::iconMesh ( )
static

Returns icon for mesh layer type.

Definition at line 54 of file qgslayeritem.cpp.

◆ iconName()

QString QgsLayerItem::iconName ( Qgis::BrowserLayerType  layerType)
static

Returns the icon name of the given layerType.

Since
QGIS 3

Definition at line 173 of file qgslayeritem.cpp.

◆ iconPoint()

QIcon QgsLayerItem::iconPoint ( )
static

Definition at line 29 of file qgslayeritem.cpp.

◆ iconPointCloud()

QIcon QgsLayerItem::iconPointCloud ( )
static

Returns icon for point cloud layer.

Definition at line 64 of file qgslayeritem.cpp.

◆ iconPolygon()

QIcon QgsLayerItem::iconPolygon ( )
static

Definition at line 39 of file qgslayeritem.cpp.

◆ iconRaster()

QIcon QgsLayerItem::iconRaster ( )
static

Definition at line 49 of file qgslayeritem.cpp.

◆ iconTable()

QIcon QgsLayerItem::iconTable ( )
static

Definition at line 44 of file qgslayeritem.cpp.

◆ iconVectorTile()

QIcon QgsLayerItem::iconVectorTile ( )
static

Returns icon for vector tile layer.

Definition at line 59 of file qgslayeritem.cpp.

◆ layerName()

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

Reimplemented in QgsProviderSublayerItem.

Definition at line 142 of file qgslayeritem.h.

◆ layerTypeAsString()

QString QgsLayerItem::layerTypeAsString ( Qgis::BrowserLayerType  layerType)
static

Returns the string representation of the given layerType.

Since
QGIS 3

Definition at line 168 of file qgslayeritem.cpp.

◆ mapLayerType()

QgsMapLayerType QgsLayerItem::mapLayerType ( ) const

Returns QgsMapLayerType.

Definition at line 92 of file qgslayeritem.cpp.

◆ mimeUris()

QgsMimeDataUtils::UriList QgsLayerItem::mimeUris ( ) const
overridevirtual

Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g.

GPKG, OGR) may report multiple URIs (e.g. for vector and raster layer types).

Items that return valid URI will be returned in mime data when dragging a selection from browser model.

Since
QGIS 3.18

Reimplemented from QgsDataItem.

Definition at line 219 of file qgslayeritem.cpp.

◆ providerKey()

QString QgsLayerItem::providerKey ( ) const
inline

Returns provider key.

Definition at line 71 of file qgslayeritem.h.

◆ supportedCrs()

QStringList QgsLayerItem::supportedCrs ( ) const
inline

Returns the supported CRS.

Since
QGIS 2.8

Definition at line 77 of file qgslayeritem.h.

◆ supportedFormats()

QStringList QgsLayerItem::supportedFormats ( ) const
inline

Returns the supported formats.

Since
QGIS 2.8

Definition at line 83 of file qgslayeritem.h.

◆ typeFromMapLayer()

Qgis::BrowserLayerType QgsLayerItem::typeFromMapLayer ( QgsMapLayer layer)
static

Returns the layer item type corresponding to a QgsMapLayer layer.

Since
QGIS 3.6

Definition at line 125 of file qgslayeritem.cpp.

◆ uri()

QString QgsLayerItem::uri ( ) const
inline

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

Definition at line 68 of file qgslayeritem.h.

Member Data Documentation

◆ mLayerType

Qgis::BrowserLayerType QgsLayerItem::mLayerType
protected

The layer type.

Definition at line 115 of file qgslayeritem.h.

◆ mSupportedCRS

QStringList QgsLayerItem::mSupportedCRS
protected

The list of supported CRS.

Definition at line 117 of file qgslayeritem.h.

◆ mSupportFormats

QStringList QgsLayerItem::mSupportFormats
protected

The list of supported formats.

Definition at line 119 of file qgslayeritem.h.

◆ mUri

QString QgsLayerItem::mUri
protected

The URI.

Definition at line 113 of file qgslayeritem.h.


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