QgsDataItem Class Reference

Base class for all items in the model. More...

#include <qgsdataitem.h>

Inheritance diagram for QgsDataItem:

Public Types
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 }

Public Slots
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
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)

Public Member Functions
	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)
virtual Q_DECL_DEPRECATED Capability	capabilities ()
virtual Capabilities	capabilities2 () const
QVector< QgsDataItem * >	children () const
virtual QVector< QgsDataItem * >	createChildren ()
	Create children.
virtual void	deleteChildItem (QgsDataItem *child)
virtual bool	equal (const QgsDataItem *other)
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 ()
QgsDataItem *	parent () const
	Get item parent.
QString	path () const
virtual QgsDataItem *	removeChildItem (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 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 Member Functions
bool	deferredDelete ()
	The item is scheduled to be deleted.
virtual void	populate (QVector< QgsDataItem * > children)
QIcon	populatingIcon ()
virtual void	refresh (QVector< QgsDataItem * > children)

Protected Attributes
Capabilities	mCapabilities
QVector< QgsDataItem * >	mChildren
QIcon	mIcon
QString	mIconName
QString	mName
QgsDataItem *	mParent
QString	mPath
bool	mPopulated
State	mState
QString	mToolTip
Type	mType

Static Protected Attributes
static QMap< QString, QIcon >	mIconMap = QMap<QString, QIcon>()

Detailed Description

Base class for all items in the model.

Parent/children hierarchy is not based on QObject.

Definition at line 43 of file qgsdataitem.h.

Member Enumeration Documentation

enum QgsDataItem::Capability

Enumerator:

NoCapabilities
SetCrs	Can set CRS on layer or group of layers.
Fertile	Can create children. Even items without this capability may have children, but cannot create them, it means that children are created by item ancestors.
Fast	createChildren() is fast enough to be run in main thread when refreshing items, most root items (wms,wfs,wcs,postgres...) are considered fast because they are reading data only from QSettings

Definition at line 110 of file qgsdataitem.h.

enum QgsDataItem::State

Enumerator:

NotPopulated	Children not yet created.
Populating	Creating children in separate thread (populating or refreshing)
Populated	children created

Definition at line 70 of file qgsdataitem.h.

enum QgsDataItem::Type

Enumerator:

Collection
Directory
Layer
Error
Favourites

Definition at line 49 of file qgsdataitem.h.

Constructor & Destructor Documentation

QgsDataItem::QgsDataItem	(	QgsDataItem::Type	type,
		QgsDataItem *	parent,
		QString	name,
		QString	path
	)

Create new data item.

Definition at line 158 of file qgsdataitem.cpp.

QgsDataItem::~QgsDataItem ( )

virtual

Definition at line 173 of file qgsdataitem.cpp.

Member Function Documentation

virtual bool QgsDataItem::acceptDrop ( )

inlinevirtual

Definition at line 105 of file qgsdataitem.h.

virtual QList<QAction*> QgsDataItem::actions ( )

inlinevirtual

Definition at line 102 of file qgsdataitem.h.

void QgsDataItem::addChildItem ( QgsDataItem *  child, bool  refresh = false  )

virtual

Definition at line 494 of file qgsdataitem.cpp.

void QgsDataItem::beginInsertItems ( QgsDataItem *  parent, int  first, int  last  )

signal

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

signal

virtual Q_DECL_DEPRECATED Capability QgsDataItem::capabilities ( )

inlinevirtual

Deprecated:

since 2.8, returned type this will changed to Capabilities

Definition at line 124 of file qgsdataitem.h.

virtual Capabilities QgsDataItem::capabilities2 ( ) const

inlinevirtual

Definition at line 126 of file qgsdataitem.h.

QVector<QgsDataItem*> QgsDataItem::children ( ) const

inline

Definition at line 145 of file qgsdataitem.h.

void QgsDataItem::childrenCreated ( )

virtualslot

Definition at line 344 of file qgsdataitem.cpp.

QVector< QgsDataItem * > QgsDataItem::createChildren ( )

virtual

Create children.

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

Reimplemented in QgsZipItem, QgsFavouritesItem, and QgsDirectoryItem.

Definition at line 295 of file qgsdataitem.cpp.

void QgsDataItem::dataChanged ( QgsDataItem *  item )

signal

bool QgsDataItem::deferredDelete ( )

inlineprotected

The item is scheduled to be deleted.

E.g. if deleteLater() is called when item is in Populating state (createChildren() running in another thread), the deferredDelete() returns true and item will be deleted once Populating finished. Items with slow reateChildren() (for example network or database based) may check during createChildren() if deferredDelete() returns true and return from createChildren() immediately because result will be useless.

Definition at line 179 of file qgsdataitem.h.

void QgsDataItem::deleteChildItem ( QgsDataItem *  child )

virtual

Definition at line 528 of file qgsdataitem.cpp.

void QgsDataItem::deleteLater ( QVector< QgsDataItem * > &  items )

static

Definition at line 221 of file qgsdataitem.cpp.

void QgsDataItem::deleteLater ( )

virtualslot

Safely delete the item:

• disconnects parent
• unsets parent (but does not remove itself)
• deletes all its descendants recursively
• waits until Populating state (createChildren() in thread) finished without blocking main thread
• calls QObject::deleteLater()

Definition at line 198 of file qgsdataitem.cpp.

void QgsDataItem::depopulate ( )

virtualslot

Remove children recursively and set as not populated.

This is used when refreshing collapsed items.

Definition at line 381 of file qgsdataitem.cpp.

void QgsDataItem::emitBeginInsertItems ( QgsDataItem *  parent, int  first, int  last  )

slot

Definition at line 260 of file qgsdataitem.cpp.

void QgsDataItem::emitBeginRemoveItems ( QgsDataItem *  parent, int  first, int  last  )

slot

Definition at line 268 of file qgsdataitem.cpp.

void QgsDataItem::emitDataChanged ( QgsDataItem *  item )

slot

Definition at line 277 of file qgsdataitem.cpp.

void QgsDataItem::emitDataChanged ( )

slot

Definition at line 282 of file qgsdataitem.cpp.

void QgsDataItem::emitEndInsertItems ( )

slot

Definition at line 264 of file qgsdataitem.cpp.

void QgsDataItem::emitEndRemoveItems ( )

slot

Definition at line 272 of file qgsdataitem.cpp.

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

slot

Definition at line 287 of file qgsdataitem.cpp.

void QgsDataItem::endInsertItems ( )

signal

void QgsDataItem::endRemoveItems ( )

signal

bool QgsDataItem::equal ( const QgsDataItem *  other )

virtual

Reimplemented in QgsDirectoryItem, and QgsLayerItem.

Definition at line 563 of file qgsdataitem.cpp.

int QgsDataItem::findItem ( QVector< QgsDataItem * >  items, QgsDataItem *  item  )

static

Definition at line 551 of file qgsdataitem.cpp.

virtual bool QgsDataItem::handleDrop ( const QMimeData *  , Qt::DropAction    )

inlinevirtual

Definition at line 108 of file qgsdataitem.h.

bool QgsDataItem::hasChildren

(

)

Definition at line 465 of file qgsdataitem.cpp.

QIcon QgsDataItem::icon ( )

virtual

Reimplemented in QgsDirectoryItem.

Definition at line 246 of file qgsdataitem.cpp.

bool QgsDataItem::isPopulated ( )

inline

Deprecated:

in 2.8, use state()

Definition at line 84 of file qgsdataitem.h.

void QgsDataItem::moveToThread

(

QThread *

targetThread

)

Move object and all its descendants to thread.

Definition at line 232 of file qgsdataitem.cpp.

QString QgsDataItem::name ( ) const

inline

Definition at line 147 of file qgsdataitem.h.

virtual QWidget* QgsDataItem::paramWidget ( )

inlinevirtual

Reimplemented in QgsDirectoryItem.

Definition at line 99 of file qgsdataitem.h.

QgsDataItem* QgsDataItem::parent ( ) const

inline

Get item parent.

QgsDataItem maintains its own items hierarchy, it does not use QObject hierarchy.

Definition at line 141 of file qgsdataitem.h.

QString QgsDataItem::path ( ) const

inline

Definition at line 149 of file qgsdataitem.h.

QString QgsDataItem::pathComponent ( const QString &  component )

static

Create path component replacing path separators.

Definition at line 193 of file qgsdataitem.cpp.

void QgsDataItem::populate ( QVector< QgsDataItem * >  children )

protectedvirtual

Definition at line 367 of file qgsdataitem.cpp.

void QgsDataItem::populate ( )

virtualslot

Definition at line 300 of file qgsdataitem.cpp.

QIcon QgsDataItem::populatingIcon ( )

inlineprotected

Definition at line 172 of file qgsdataitem.h.

void QgsDataItem::refresh ( QVector< QgsDataItem * >  children )

protectedvirtual

Definition at line 417 of file qgsdataitem.cpp.

void QgsDataItem::refresh ( )

virtualslot

Definition at line 394 of file qgsdataitem.cpp.

QgsDataItem * QgsDataItem::removeChildItem ( QgsDataItem *  child )

virtual

Definition at line 539 of file qgsdataitem.cpp.

int QgsDataItem::rowCount

(

)

Definition at line 461 of file qgsdataitem.cpp.

virtual void QgsDataItem::setCapabilities ( Capabilities  capabilities )

inlinevirtual

Definition at line 128 of file qgsdataitem.h.

virtual bool QgsDataItem::setCrs ( QgsCoordinateReferenceSystem  crs )

inlinevirtual

Definition at line 120 of file qgsdataitem.h.

void QgsDataItem::setIcon ( QIcon  icon )

inline

Definition at line 157 of file qgsdataitem.h.

void QgsDataItem::setIconName ( const QString &  iconName )

inline

Definition at line 158 of file qgsdataitem.h.

void QgsDataItem::setName ( const QString &  name )

inline

Definition at line 148 of file qgsdataitem.h.

void QgsDataItem::setParent

(

QgsDataItem *

parent

)

Set item parent and connect / disconnect parent to / from item signals.

It does not add itself to parents children (mChildren)

Definition at line 470 of file qgsdataitem.cpp.

void QgsDataItem::setPath ( const QString &  path )

inline

Definition at line 150 of file qgsdataitem.h.

void QgsDataItem::setPopulatingIcon ( )

slot

Definition at line 573 of file qgsdataitem.cpp.

void QgsDataItem::setState ( State  state )

virtual

Set item state.

It also take care about starting/stopping loading icon animation.

Parameters

state

Reimplemented in QgsDirectoryItem.

Definition at line 587 of file qgsdataitem.cpp.

void QgsDataItem::setToolTip ( QString  msg )

inline

Definition at line 160 of file qgsdataitem.h.

QgsDataItem::State QgsDataItem::state

(

)

const

Definition at line 578 of file qgsdataitem.cpp.

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

signal

QString QgsDataItem::toolTip ( ) const

inline

Definition at line 161 of file qgsdataitem.h.

Type QgsDataItem::type ( ) const

inline

Definition at line 137 of file qgsdataitem.h.

Member Data Documentation

Capabilities QgsDataItem::mCapabilities

protected

Definition at line 182 of file qgsdataitem.h.

QVector<QgsDataItem*> QgsDataItem::mChildren

protected

Definition at line 184 of file qgsdataitem.h.

QIcon QgsDataItem::mIcon

protected

Definition at line 196 of file qgsdataitem.h.

QMap< QString, QIcon > QgsDataItem::mIconMap = QMap<QString, QIcon>()

staticprotected

Definition at line 197 of file qgsdataitem.h.

QString QgsDataItem::mIconName

protected

Definition at line 195 of file qgsdataitem.h.

QString QgsDataItem::mName

protected

Definition at line 188 of file qgsdataitem.h.

QgsDataItem* QgsDataItem::mParent

protected

Definition at line 183 of file qgsdataitem.h.

QString QgsDataItem::mPath

protected

Definition at line 193 of file qgsdataitem.h.

bool QgsDataItem::mPopulated

protected

Deprecated:

since 2.8, use mState

Definition at line 187 of file qgsdataitem.h.

State QgsDataItem::mState

protected

Definition at line 185 of file qgsdataitem.h.

QString QgsDataItem::mToolTip

protected

Definition at line 194 of file qgsdataitem.h.

Type QgsDataItem::mType

protected

Definition at line 181 of file qgsdataitem.h.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsdataitem.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgsdataitem.cpp