QGIS API Documentation  2.99.0-Master (0a63d1f)
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsDataItem Class Reference

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

#include <qgsdataitem.h>

Inheritance diagram for QgsDataItem:
Inheritance graph
[legend]

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,
  Favorites, Project
}
 

Public Slots

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...
 
void emitDataChanged ()
 
virtual void populate (bool foreground=false)
 
virtual void refresh ()
 

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, 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 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 equal (const QgsDataItem *other)
 Returns true if this item is equal to another item (by testing item type and path). 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 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
 
virtual QWidget * paramWidget ()
 
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 (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)
 
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
 

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

Protected Member Functions

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

Capabilities mCapabilities
 
QVector< QgsDataItem * > mChildren
 
QIcon mIcon
 
QMap< QString, QIcon > mIconMap
 
QString mIconName
 
QString mName
 
QgsDataItemmParent
 
QString mPath
 
State mState
 
QString mToolTip
 
Type mType
 

Detailed Description

Base class for all items in the model.

Parent/children hierarchy is not based on QObject.

Definition at line 80 of file qgsdataitem.h.

Member Enumeration Documentation

◆ 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 181 of file qgsdataitem.h.

◆ State

Enumerator
NotPopulated 

Children not yet created.

Populating 

Creating children in separate thread (populating or refreshing)

Populated 

Children created.

Definition at line 108 of file qgsdataitem.h.

◆ Type

Enumerator
Collection 
Directory 
Layer 
Error 
Favorites 

Represents a favorite item.

Project 

Represents a QGIS project.

Definition at line 86 of file qgsdataitem.h.

Constructor & Destructor Documentation

◆ QgsDataItem()

QgsDataItem::QgsDataItem ( QgsDataItem::Type  type,
QgsDataItem parent,
const QString &  name,
const QString &  path 
)

Create new data item.

Definition at line 163 of file qgsdataitem.cpp.

◆ ~QgsDataItem()

QgsDataItem::~QgsDataItem ( )
virtual

Definition at line 177 of file qgsdataitem.cpp.

Member Function Documentation

◆ acceptDrop()

virtual bool QgsDataItem::acceptDrop ( )
inlinevirtual

Returns whether the item accepts drag and dropped layers - e.g.

for importing a dataset to a provider. Subclasses should override this and handleDrop() to accept dropped layers.

See also
handleDrop()

Definition at line 158 of file qgsdataitem.h.

◆ actions()

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

Returns the list of actions available for this item.

This is usually used for the popup menu on right-clicking the item. Subclasses should override this to provide actions.

Definition at line 152 of file qgsdataitem.h.

◆ addChildItem()

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

Inserts a new child item.

The child will be inserted at a position using an alphabetical order based on mName.

Parameters
childchild item to insert. Ownership is transferred, and item parent will be set and relevant connections made.
refresh- set to true to refresh populated item, emitting relevant signals to the model
See also
deleteChildItem()

Definition at line 473 of file qgsdataitem.cpp.

◆ beginInsertItems

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

◆ beginRemoveItems

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

◆ capabilities2()

virtual Capabilities QgsDataItem::capabilities2 ( ) const
inlinevirtual

Definition at line 197 of file qgsdataitem.h.

◆ children()

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

Definition at line 220 of file qgsdataitem.h.

◆ childrenCreated

void QgsDataItem::childrenCreated ( )
virtualslot

Definition at line 323 of file qgsdataitem.cpp.

◆ createChildren()

QVector< QgsDataItem * > QgsDataItem::createChildren ( )
virtual

Create children.

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

Reimplemented in QgsZipItem, QgsFavoritesItem, and QgsDirectoryItem.

Definition at line 273 of file qgsdataitem.cpp.

◆ dataChanged

void QgsDataItem::dataChanged ( QgsDataItem item)
signal

◆ deferredDelete()

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 258 of file qgsdataitem.h.

◆ deleteChildItem()

void QgsDataItem::deleteChildItem ( QgsDataItem child)
virtual

Removes and deletes a child item, emitting relevant signals to the model.

Parameters
childchild to remove. Item must exist as a current child.
See also
addChildItem()

Definition at line 509 of file qgsdataitem.cpp.

◆ deleteLater() [1/2]

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

Definition at line 227 of file qgsdataitem.cpp.

◆ deleteLater [2/2]

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

◆ depopulate

void QgsDataItem::depopulate ( )
virtualslot

Remove children recursively and set as not populated. This is used when refreshing collapsed items.

Definition at line 360 of file qgsdataitem.cpp.

◆ emitDataChanged

void QgsDataItem::emitDataChanged ( )
slot

Definition at line 268 of file qgsdataitem.cpp.

◆ endInsertItems

void QgsDataItem::endInsertItems ( )
signal

◆ endRemoveItems

void QgsDataItem::endRemoveItems ( )
signal

◆ equal()

bool QgsDataItem::equal ( const QgsDataItem other)
virtual

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

Reimplemented in QgsDirectoryItem, and QgsLayerItem.

Definition at line 549 of file qgsdataitem.cpp.

◆ findItem()

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

Definition at line 537 of file qgsdataitem.cpp.

◆ handleDrop()

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

Attempts to process the mime data dropped on this item.

Subclasses must override this and acceptDrop() if they accept dropped layers.

See also
acceptDrop()

Definition at line 164 of file qgsdataitem.h.

◆ hasChildren()

bool QgsDataItem::hasChildren ( )

Definition at line 444 of file qgsdataitem.cpp.

◆ hasDragEnabled()

virtual bool QgsDataItem::hasDragEnabled ( ) const
inlinevirtual

Returns true if the item may be dragged.

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

See also
mimeUri()
Note
added in 3.0

Reimplemented in QgsProjectItem, and QgsLayerItem.

Definition at line 172 of file qgsdataitem.h.

◆ icon()

QIcon QgsDataItem::icon ( )
virtual

Reimplemented in QgsDirectoryItem.

Definition at line 252 of file qgsdataitem.cpp.

◆ mimeUri()

virtual QgsMimeDataUtils::Uri QgsDataItem::mimeUri ( ) const
inlinevirtual

Return mime URI for the data item.

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

See also
hasDragEnabled()
Note
added in 3.0

Reimplemented in QgsLayerItem.

Definition at line 179 of file qgsdataitem.h.

◆ moveToThread()

void QgsDataItem::moveToThread ( QThread *  targetThread)

Move object and all its descendants to thread.

Definition at line 238 of file qgsdataitem.cpp.

◆ name()

QString QgsDataItem::name ( ) const
inline

Definition at line 222 of file qgsdataitem.h.

◆ paramWidget()

virtual QWidget* QgsDataItem::paramWidget ( )
inlinevirtual

Reimplemented in QgsDirectoryItem.

Definition at line 147 of file qgsdataitem.h.

◆ parent()

QgsDataItem* QgsDataItem::parent ( ) const
inline

Get item parent.

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

Definition at line 215 of file qgsdataitem.h.

◆ path()

QString QgsDataItem::path ( ) const
inline

Definition at line 224 of file qgsdataitem.h.

◆ pathComponent()

QString QgsDataItem::pathComponent ( const QString &  component)
static

Create path component replacing path separators.

Definition at line 199 of file qgsdataitem.cpp.

◆ populate() [1/2]

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

Definition at line 346 of file qgsdataitem.cpp.

◆ populate [2/2]

void QgsDataItem::populate ( bool  foreground = false)
virtualslot

Definition at line 278 of file qgsdataitem.cpp.

◆ refresh() [1/2]

void QgsDataItem::refresh ( const QVector< QgsDataItem *> &  children)
protectedvirtual

Refresh the items from a specified list of child items.

Definition at line 396 of file qgsdataitem.cpp.

◆ refresh [2/2]

void QgsDataItem::refresh ( )
virtualslot

Definition at line 373 of file qgsdataitem.cpp.

◆ removeChildItem()

QgsDataItem * QgsDataItem::removeChildItem ( QgsDataItem child)
virtual

Removes a child item and returns it without deleting it.

Emits relevant signals to model as required.

Parameters
childchild to remove
Returns
pointer to the removed item or null if no such item was found

Definition at line 520 of file qgsdataitem.cpp.

◆ rowCount()

int QgsDataItem::rowCount ( )

Definition at line 440 of file qgsdataitem.cpp.

◆ setCapabilities()

virtual void QgsDataItem::setCapabilities ( Capabilities  capabilities)
inlinevirtual

Sets the capabilities for the data item.

Definition at line 202 of file qgsdataitem.h.

◆ setCrs()

virtual bool QgsDataItem::setCrs ( const QgsCoordinateReferenceSystem crs)
inlinevirtual

Writes the selected crs into data source.

The original data source will be modified when calling this method.

Definition at line 194 of file qgsdataitem.h.

◆ setIcon()

void QgsDataItem::setIcon ( const QIcon &  icon)
inline

Definition at line 232 of file qgsdataitem.h.

◆ setIconName()

void QgsDataItem::setIconName ( const QString &  iconName)
inline

Definition at line 233 of file qgsdataitem.h.

◆ setName()

void QgsDataItem::setName ( const QString &  name)
inline

Definition at line 223 of file qgsdataitem.h.

◆ setParent()

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 449 of file qgsdataitem.cpp.

◆ setPath()

void QgsDataItem::setPath ( const QString &  path)
inline

Definition at line 225 of file qgsdataitem.h.

◆ setState()

void QgsDataItem::setState ( State  state)
virtual

Set item state.

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

Parameters
state
Note
added in 2.8

Reimplemented in QgsDirectoryItem.

Definition at line 564 of file qgsdataitem.cpp.

◆ setToolTip()

void QgsDataItem::setToolTip ( const QString &  msg)
inline

Definition at line 235 of file qgsdataitem.h.

◆ state()

QgsDataItem::State QgsDataItem::state ( ) const
Note
added in 2.8

Definition at line 559 of file qgsdataitem.cpp.

◆ stateChanged

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

◆ toolTip()

QString QgsDataItem::toolTip ( ) const
inline

Definition at line 236 of file qgsdataitem.h.

◆ type()

Type QgsDataItem::type ( ) const
inline

Definition at line 211 of file qgsdataitem.h.

Member Data Documentation

◆ mCapabilities

Capabilities QgsDataItem::mCapabilities
protected

Definition at line 261 of file qgsdataitem.h.

◆ mChildren

QVector<QgsDataItem*> QgsDataItem::mChildren
protected

Definition at line 263 of file qgsdataitem.h.

◆ mIcon

QIcon QgsDataItem::mIcon
protected

Definition at line 273 of file qgsdataitem.h.

◆ mIconMap

QMap<QString, QIcon> QgsDataItem::mIconMap
protected

Definition at line 274 of file qgsdataitem.h.

◆ mIconName

QString QgsDataItem::mIconName
protected

Definition at line 272 of file qgsdataitem.h.

◆ mName

QString QgsDataItem::mName
protected

Definition at line 265 of file qgsdataitem.h.

◆ mParent

QgsDataItem* QgsDataItem::mParent
protected

Definition at line 262 of file qgsdataitem.h.

◆ mPath

QString QgsDataItem::mPath
protected

Definition at line 270 of file qgsdataitem.h.

◆ mState

State QgsDataItem::mState
protected

Definition at line 264 of file qgsdataitem.h.

◆ mToolTip

QString QgsDataItem::mToolTip
protected

Definition at line 271 of file qgsdataitem.h.

◆ mType

Type QgsDataItem::mType
protected

Definition at line 260 of file qgsdataitem.h.


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