A Collection: logical collection of layers or subcollections, e.g. More...

#include <qgsdatacollectionitem.h>

Inheritance diagram for QgsDataCollectionItem:

Public Member Functions
	QgsDataCollectionItem (QgsDataItem *parent, const QString &name, const QString &path=QString(), const QString &providerKey=QString())
	Constructor for QgsDataCollectionItem, with the specified parent item.

	~QgsDataCollectionItem () override

void	addChild (QgsDataItem *item)

QgsAbstractDatabaseProviderConnection *	databaseConnection () const override
	For data items that represent a DB connection or one of its children, this method returns a connection.

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.

	~QgsDataItem () override

virtual Q_DECL_DEPRECATED bool	acceptDrop ()
	Returns whether the item accepts drag and dropped layers - e.g.

virtual QList< QAction * >	actions (QWidget *parent)
	Returns the list of actions available for this item.

virtual void	addChildItem (QgsDataItem *child, bool refresh=false)
	Inserts a new child item.

virtual Qgis::BrowserItemCapabilities	capabilities2 () const
	Returns the capabilities for the data item.

QVector< QgsDataItem * >	children () const

virtual QVector< QgsDataItem * >	createChildren ()
	Create children.

virtual void	deleteChildItem (QgsDataItem *child)
	Removes and deletes a child item, emitting relevant signals to the model.

virtual bool	equal (const QgsDataItem *other)
	Returns `true` if this item is equal to another item (by testing item type and path).

virtual bool	handleDoubleClick ()
	Called when a user double clicks on the item.

virtual Q_DECL_DEPRECATED bool	handleDrop (const QMimeData *, Qt::DropAction)
	Attempts to process the mime data dropped on this item.

bool	hasChildren ()

virtual bool	hasDragEnabled () const
	Returns `true` if the item may be dragged.

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.

virtual QList< QMenu * >	menus (QWidget *parent)
	Returns the list of menus available for this item.

virtual Q_DECL_DEPRECATED QgsMimeDataUtils::Uri	mimeUri () const
	Returns mime URI for the data item.

virtual QgsMimeDataUtils::UriList	mimeUris () const
	Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g.

void	moveToThread (QThread *targetThread)
	Move object and all its descendants to thread.

QString	name () const
	Returns the name of the item (the displayed text for the item).

virtual Q_DECL_DEPRECATED QWidget *	paramWidget ()
	Returns source widget from data item for QgsBrowserPropertiesWidget.

QgsDataItem *	parent () const
	Gets item parent.

QString	path () const

QString	providerKey () const
	Returns the provider key that created this item (e.g.

virtual QgsDataItem *	removeChildItem (QgsDataItem *child)
	Removes a child item and returns it without deleting it.

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.

int	rowCount ()

Q_DECL_DEPRECATED void	setCapabilities (int capabilities)

virtual void	setCapabilities (Qgis::BrowserItemCapabilities capabilities)
	Sets the capabilities for the data item.

virtual Q_DECL_DEPRECATED bool	setCrs (const QgsCoordinateReferenceSystem &crs)
	Writes the selected crs into data source.

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).

void	setParent (QgsDataItem *parent)
	Set item parent and connect / disconnect parent to / from item signals.

void	setPath (const QString &path)

void	setProviderKey (const QString &value)
	Sets the provider key that created this item (e.g.

void	setSortKey (const QVariant &key)
	Sets a custom sorting key for the item.

virtual void	setState (Qgis::BrowserItemState state)
	Set item state.

void	setToolTip (const QString &msg)

virtual QVariant	sortKey () const
	Returns the sorting key for the item.

Qgis::BrowserItemState	state () const

QString	toolTip () const

Qgis::BrowserItemType	type () const

Static Public Member Functions
static QIcon	iconDataCollection ()
	Returns the standard browser data collection icon.

static QIcon	iconDir (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
	Returns the standard browser directory icon.

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.

Static Protected Member Functions
static QIcon	homeDirIcon (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
	Shared home directory icon.

static QIcon	openDirIcon (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
	Shared open directory icon.

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. This is used when refreshing collapsed items.

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.

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.

void	dataChanged (QgsDataItem *item)

void	endInsertItems ()

void	endRemoveItems ()

void	stateChanged (QgsDataItem *item, Qgis::BrowserItemState oldState)
	Emitted when an item's state is changed.

Protected Slots inherited from QgsDataItem
void	updateIcon ()
	Will request a repaint of this icon.

Protected Member Functions inherited from QgsDataItem
bool	deferredDelete ()
	The item is scheduled to be deleted.

virtual void	populate (const QVector< QgsDataItem * > &children)

virtual void	refresh (const QVector< QgsDataItem * > &children)
	Refresh the items from a specified list of child items.

Protected Attributes inherited from QgsDataItem
Qgis::BrowserItemCapabilities	mCapabilities = Qgis::BrowserItemCapability::NoCapabilities

QVector< QgsDataItem * >	mChildren

QIcon	mIcon

QMap< QString, QIcon >	mIconMap

QString	mIconName

QString	mName

QgsDataItem *	mParent = nullptr

QString	mPath

QString	mProviderKey

QVariant	mSortKey
	Custom sort key. If invalid, name() will be used for sorting instead.

Qgis::BrowserItemState	mState = Qgis::BrowserItemState::NotPopulated

QString	mToolTip

Qgis::BrowserItemType	mType

Detailed Description

A Collection: logical collection of layers or subcollections, e.g.

GRASS location/mapset, database? wms source?

Definition at line 28 of file qgsdatacollectionitem.h.

Constructor & Destructor Documentation

◆ QgsDataCollectionItem()

QgsDataCollectionItem::QgsDataCollectionItem	(	QgsDataItem *	parent,
		const QString &	name,
		const QString &	path = `QString()`,
		const QString &	providerKey = `QString()`
	)

Constructor for QgsDataCollectionItem, with the specified parent item.

The name argument specifies the text to show in the model for the item. A translated string should be used wherever appropriate.

The path argument gives the item path in the browser tree. The path string can take any form, but QgsDataCollectionItem items pointing to different logical locations should always use a different item path.

The optional providerKey string can be used to specify the key for the QgsDataItemProvider that created this item.

Definition at line 28 of file qgsdatacollectionitem.cpp.

◆ ~QgsDataCollectionItem()

QgsDataCollectionItem::~QgsDataCollectionItem ( )

override

Definition at line 38 of file qgsdatacollectionitem.cpp.

Member Function Documentation

◆ addChild()

void QgsDataCollectionItem::addChild ( QgsDataItem * item )

inline

Definition at line 56 of file qgsdatacollectionitem.h.

◆ databaseConnection()

QgsAbstractDatabaseProviderConnection * QgsDataCollectionItem::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.

Reimplemented in QgsFileDataCollectionItem.

Definition at line 72 of file qgsdatacollectionitem.cpp.

◆ homeDirIcon()

QIcon QgsDataCollectionItem::homeDirIcon	(	const QColor &	fillColor = `QColor()`,
		const QColor &	strokeColor = `QColor()`
	)

staticprotected

Shared home directory icon.

Since QGIS 3.20 the optional fillColor and strokeColor arguments can be used to specify a fill and stroke color for the icon.

Since: QGIS 3.4

Definition at line 65 of file qgsdatacollectionitem.cpp.

◆ iconDataCollection()

QIcon QgsDataCollectionItem::iconDataCollection ( )

static

Returns the standard browser data collection icon.

See also: iconDir()

Definition at line 53 of file qgsdatacollectionitem.cpp.

◆ iconDir()

QIcon QgsDataCollectionItem::iconDir	(	const QColor &	fillColor = `QColor()`,
		const QColor &	strokeColor = `QColor()`
	)

static

Returns the standard browser directory icon.

Since QGIS 3.20 the optional fillColor and strokeColor arguments can be used to specify a fill and stroke color for the icon.

See also: iconDataCollection()

Definition at line 110 of file qgsdatacollectionitem.cpp.

◆ openDirIcon()

QIcon QgsDataCollectionItem::openDirIcon	(	const QColor &	fillColor = `QColor()`,
		const QColor &	strokeColor = `QColor()`
	)

staticprotected

Shared open directory icon.

Since QGIS 3.20 the optional fillColor and strokeColor arguments can be used to specify a fill and stroke color for the icon.

Since: QGIS 3.4

Definition at line 58 of file qgsdatacollectionitem.cpp.

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

/build/qgis-3.34.0+99sid/src/core/browser/qgsdatacollectionitem.h
/build/qgis-3.34.0+99sid/src/core/browser/qgsdatacollectionitem.cpp

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsDataCollectionItem()

◆ ~QgsDataCollectionItem()

Member Function Documentation

◆ addChild()

◆ databaseConnection()

◆ homeDirIcon()

◆ iconDataCollection()

◆ iconDir()

◆ openDirIcon()