QGIS API Documentation  2.11.0-Master
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static 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,
  Favourites
}
 

Public Slots

virtual void childrenCreated ()
 
virtual void deleteLater ()
 Safely delete the item: More...
 
virtual void depopulate ()
 Remove children recursively and set as not populated. More...
 
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 (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, QString name, QString path)
 Create new data item. More...
 
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. More...
 
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. More...
 
QString name () const
 
virtual QWidgetparamWidget ()
 
QgsDataItemparent () const
 Get item parent. More...
 
QString path () const
 
virtual QgsDataItemremoveChildItem (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. More...
 
void setPath (const QString &path)
 
virtual void setState (State state)
 Set item state. More...
 
void setToolTip (QString msg)
 
State state () const
 
QString toolTip () const
 
Type type () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () 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...
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Protected Member Functions

bool deferredDelete ()
 The item is scheduled to be deleted. More...
 
virtual void populate (QVector< QgsDataItem * > children)
 
virtual void refresh (QVector< QgsDataItem * > children)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

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

Static Protected Attributes

static QMap< QString, QIconmIconMap = QMap<QString, QIcon>()
 

Additional Inherited Members

- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Base class for all items in the model.

Parent/children hierarchy is not based on QObject.

Definition at line 75 of file qgsdataitem.h.

Member Enumeration Documentation

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

Enumerator
NotPopulated 

Children not yet created.

Populating 

Creating children in separate thread (populating or refreshing)

Populated 

children created

Definition at line 102 of file qgsdataitem.h.

Enumerator
Collection 
Directory 
Layer 
Error 
Favourites 

Definition at line 81 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 209 of file qgsdataitem.cpp.

QgsDataItem::~QgsDataItem ( )
virtual

Definition at line 224 of file qgsdataitem.cpp.

Member Function Documentation

virtual bool QgsDataItem::acceptDrop ( )
inlinevirtual

Definition at line 140 of file qgsdataitem.h.

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

Definition at line 137 of file qgsdataitem.h.

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

Definition at line 547 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 159 of file qgsdataitem.h.

virtual Capabilities QgsDataItem::capabilities2 ( ) const
inlinevirtual

Definition at line 161 of file qgsdataitem.h.

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

Definition at line 180 of file qgsdataitem.h.

void QgsDataItem::childrenCreated ( )
virtualslot

Definition at line 397 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 348 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 213 of file qgsdataitem.h.

void QgsDataItem::deleteChildItem ( QgsDataItem child)
virtual

Definition at line 581 of file qgsdataitem.cpp.

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

Definition at line 272 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 249 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 434 of file qgsdataitem.cpp.

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

Definition at line 313 of file qgsdataitem.cpp.

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

Definition at line 321 of file qgsdataitem.cpp.

void QgsDataItem::emitDataChanged ( QgsDataItem item)
slot

Definition at line 330 of file qgsdataitem.cpp.

void QgsDataItem::emitDataChanged ( )
slot

Definition at line 335 of file qgsdataitem.cpp.

void QgsDataItem::emitEndInsertItems ( )
slot

Definition at line 317 of file qgsdataitem.cpp.

void QgsDataItem::emitEndRemoveItems ( )
slot

Definition at line 325 of file qgsdataitem.cpp.

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

Definition at line 340 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 616 of file qgsdataitem.cpp.

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

Definition at line 604 of file qgsdataitem.cpp.

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

Definition at line 143 of file qgsdataitem.h.

bool QgsDataItem::hasChildren ( )

Definition at line 518 of file qgsdataitem.cpp.

QIcon QgsDataItem::icon ( )
virtual

Reimplemented in QgsDirectoryItem.

Definition at line 297 of file qgsdataitem.cpp.

bool QgsDataItem::isPopulated ( )
inline
Deprecated:
in 2.8, use state()

Definition at line 119 of file qgsdataitem.h.

void QgsDataItem::moveToThread ( QThread targetThread)

Move object and all its descendants to thread.

Definition at line 283 of file qgsdataitem.cpp.

QString QgsDataItem::name ( ) const
inline

Definition at line 182 of file qgsdataitem.h.

virtual QWidget* QgsDataItem::paramWidget ( )
inlinevirtual

Reimplemented in QgsDirectoryItem.

Definition at line 134 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 176 of file qgsdataitem.h.

QString QgsDataItem::path ( ) const
inline

Definition at line 184 of file qgsdataitem.h.

QString QgsDataItem::pathComponent ( const QString component)
static

Create path component replacing path separators.

Definition at line 244 of file qgsdataitem.cpp.

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

Definition at line 420 of file qgsdataitem.cpp.

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

Definition at line 353 of file qgsdataitem.cpp.

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

Definition at line 470 of file qgsdataitem.cpp.

void QgsDataItem::refresh ( )
virtualslot

Definition at line 447 of file qgsdataitem.cpp.

QgsDataItem * QgsDataItem::removeChildItem ( QgsDataItem child)
virtual

Definition at line 592 of file qgsdataitem.cpp.

int QgsDataItem::rowCount ( )

Definition at line 514 of file qgsdataitem.cpp.

virtual void QgsDataItem::setCapabilities ( Capabilities  capabilities)
inlinevirtual

Definition at line 163 of file qgsdataitem.h.

virtual bool QgsDataItem::setCrs ( QgsCoordinateReferenceSystem  crs)
inlinevirtual

Definition at line 155 of file qgsdataitem.h.

void QgsDataItem::setIcon ( QIcon  icon)
inline

Definition at line 192 of file qgsdataitem.h.

void QgsDataItem::setIconName ( const QString iconName)
inline

Definition at line 193 of file qgsdataitem.h.

void QgsDataItem::setName ( const QString name)
inline

Definition at line 183 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 523 of file qgsdataitem.cpp.

void QgsDataItem::setPath ( const QString path)
inline

Definition at line 185 of file qgsdataitem.h.

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

void QgsDataItem::setToolTip ( QString  msg)
inline

Definition at line 195 of file qgsdataitem.h.

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

Definition at line 626 of file qgsdataitem.cpp.

void QgsDataItem::stateChanged ( QgsDataItem item,
QgsDataItem::State  oldState 
)
signal
QString QgsDataItem::toolTip ( ) const
inline

Definition at line 196 of file qgsdataitem.h.

Type QgsDataItem::type ( ) const
inline

Definition at line 172 of file qgsdataitem.h.

Member Data Documentation

Capabilities QgsDataItem::mCapabilities
protected

Definition at line 216 of file qgsdataitem.h.

QVector<QgsDataItem*> QgsDataItem::mChildren
protected

Definition at line 218 of file qgsdataitem.h.

QIcon QgsDataItem::mIcon
protected

Definition at line 230 of file qgsdataitem.h.

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

Definition at line 231 of file qgsdataitem.h.

QString QgsDataItem::mIconName
protected

Definition at line 229 of file qgsdataitem.h.

QString QgsDataItem::mName
protected

Definition at line 222 of file qgsdataitem.h.

QgsDataItem* QgsDataItem::mParent
protected

Definition at line 217 of file qgsdataitem.h.

QString QgsDataItem::mPath
protected

Definition at line 227 of file qgsdataitem.h.

bool QgsDataItem::mPopulated
protected
Deprecated:
since 2.8, use mState

Definition at line 221 of file qgsdataitem.h.

State QgsDataItem::mState
protected

Definition at line 219 of file qgsdataitem.h.

QString QgsDataItem::mToolTip
protected

Definition at line 228 of file qgsdataitem.h.

Type QgsDataItem::mType
protected

Definition at line 215 of file qgsdataitem.h.


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