Contains various Favorites directories. More...

#include <qgsdataitem.h>

Inheritance diagram for QgsFavoritesItem:

Public Member Functions
	QgsFavoritesItem (QgsDataItem *parent, const QString &name, const QString &path=QString())
	Constructor for QgsFavoritesItem. More...

void	addDirectory (const QString &directory, const QString &name=QString())
	Adds a new directory to the favorites group. More...

QVector< QgsDataItem * >	createChildren () override
	Create children. More...

void	removeDirectory (QgsDirectoryItem *item)
	Removes an existing directory from the favorites group. More...

void	renameFavorite (const QString &path, const QString &name)
	Renames the stored favorite with corresponding path a new name. More...

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

Public Member Functions inherited from QgsDataCollectionItem
	QgsDataCollectionItem (QgsDataItem *parent, const QString &name, const QString &path=QString())

	~QgsDataCollectionItem () override

void	addChild (QgsDataItem *item)

Public Member Functions inherited from QgsDataItem
	QgsDataItem (QgsDataItem::Type type, QgsDataItem *parent, const QString &name, const QString &path)
	Create new data item. More...

	~QgsDataItem () override

virtual 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 Capabilities	capabilities2 () const

QVector< QgsDataItem * >	children () const

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

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

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

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

bool	hasChildren ()

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

virtual QIcon	icon ()

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

virtual QgsMimeDataUtils::Uri	mimeUri () const
	Return 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 QWidget *	paramWidget ()

QgsDataItem *	parent () const
	Get item parent. More...

QString	path () const

	Q_ENUM (Type)

	Q_ENUM (State)

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

int	rowCount ()

virtual void	setCapabilities (Capabilities capabilities)
	Sets the capabilities for the data item. More...

virtual 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	setSortKey (const QVariant &key)
	Sets a custom sorting key for the item. More...

virtual void	setState (State state)
	Set item state. More...

void	setToolTip (const QString &msg)

State	state () const

QString	toolTip () const

Type	type () const

Static Public Member Functions
static QIcon	iconFavorites ()
	Icon for favorites group. More...

Static Public Member Functions inherited from QgsDataCollectionItem
static QIcon	iconDataCollection ()

static QIcon	iconDir ()

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

Additional Inherited Members
Public Types inherited from QgsDataItem
enum	Capability { NoCapabilities = 0, SetCrs = 1 << 0, Fertile = 1 << 1, Fast = 1 << 2, Collapse = 1 << 3 }

enum	State { NotPopulated, Populating, Populated }

enum	Type { Collection, Directory, Layer, Error, Favorites, Project, Custom }

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 ()
	Refresh connections: update GUI and emit signal. More...

Signals inherited from QgsDataItem
void	beginInsertItems (QgsDataItem *parent, int first, int last)

void	beginRemoveItems (QgsDataItem *parent, int first, int last)

void	connectionsChanged ()
	Emitted when the provider's connections of the child items have changed This signal is normally forwarded to the app in order to refresh the connection item in the provider dialogs and to refresh the connection items in the other open browsers. More...

void	dataChanged (QgsDataItem *item)

void	endInsertItems ()

void	endRemoveItems ()

void	stateChanged (QgsDataItem *item, QgsDataItem::State oldState)

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

Protected Attributes inherited from QgsDataItem
Capabilities	mCapabilities

QVector< QgsDataItem * >	mChildren

QIcon	mIcon

QMap< QString, QIcon >	mIconMap

QString	mIconName

QString	mName

QgsDataItem *	mParent = nullptr

QString	mPath

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

State	mState

QString	mToolTip

Type	mType

Detailed Description

Contains various Favorites directories.

Since: QGIS 3.0

Definition at line 642 of file qgsdataitem.h.

Constructor & Destructor Documentation

◆ QgsFavoritesItem()

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

Constructor for QgsFavoritesItem.

Accepts a path argument specifying the file path associated with the item.

Definition at line 1101 of file qgsdataitem.cpp.

Member Function Documentation

◆ addDirectory()

void QgsFavoritesItem::addDirectory	(	const QString &	directory,
		const QString &	name = `QString()`
	)

Adds a new directory to the favorites group.

If name is specified, it will be used as the favorite's name. Otherwise the name will be set to match directory.

See also: removeDirectory()

Definition at line 1135 of file qgsdataitem.cpp.

◆ createChildren()

QVector< QgsDataItem * > QgsFavoritesItem::createChildren ( )

overridevirtual

Create children.

Children are not expected to have parent set. This method MUST BE THREAD SAFE.

Reimplemented from QgsDataItem.

Definition at line 1111 of file qgsdataitem.cpp.

◆ iconFavorites()

QIcon QgsFavoritesItem::iconFavorites ( )

static

Icon for favorites group.

Definition at line 101 of file qgsdataitem.cpp.

◆ removeDirectory()

void QgsFavoritesItem::removeDirectory ( QgsDirectoryItem * item )

Removes an existing directory from the favorites group.

See also: addDirectory()

Definition at line 1154 of file qgsdataitem.cpp.

◆ renameFavorite()

void QgsFavoritesItem::renameFavorite	(	const QString &	path,
		const QString &	name
	)

Renames the stored favorite with corresponding path a new name.

Definition at line 1184 of file qgsdataitem.cpp.

◆ sortKey()

QVariant QgsFavoritesItem::sortKey ( ) const

overridevirtual

Returns the sorting key for the item.

By default name() is returned, but setSortKey() can be used to set a custom sort key for the item.

Alternatively subclasses can override this method to return a custom sort key.

See also: setSortKey()

Since: QGIS 3.0

Reimplemented from QgsDataItem.

Definition at line 106 of file qgsdataitem.cpp.

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

/tmp/buildd/qgis-3.0.2+14stretch/src/core/qgsdataitem.h
/tmp/buildd/qgis-3.0.2+14stretch/src/core/qgsdataitem.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members