QGIS API Documentation
2.12.0-Lyon
|
Base class for all items in the model. More...
#include <qgsdataitem.h>
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, const QString &name, const 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 QWidget * | paramWidget () |
QgsDataItem * | parent () const |
Get item parent. More... | |
QString | path () const |
virtual QgsDataItem * | removeChildItem (QgsDataItem *child) |
int | rowCount () |
virtual void | setCapabilities (const Capabilities &capabilities) |
virtual bool | setCrs (QgsCoordinateReferenceSystem crs) |
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 |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QObject (QObject *parent, const char *name) | |
virtual | ~QObject () |
bool | blockSignals (bool block) |
QObject * | child (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< QByteArray > | dynamicPropertyNames () const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name) const |
QList< T > | findChildren (const QRegExp ®Exp) 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 QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
const char * | name () const |
const char * | name (const char *defaultName) const |
QString | objectName () const |
QObject * | parent () 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) |
QThread * | thread () 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 (const 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 |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
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>() |
Additional Inherited Members | |
Static Protected Member Functions inherited from QObject | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
Properties inherited from QObject | |
objectName | |
Base class for all items in the model.
Parent/children hierarchy is not based on QObject.
Definition at line 75 of file qgsdataitem.h.
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.
enum QgsDataItem::State |
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.
enum QgsDataItem::Type |
Enumerator | |
---|---|
Collection | |
Directory | |
Layer | |
Error | |
Favourites |
Definition at line 81 of file qgsdataitem.h.
QgsDataItem::QgsDataItem | ( | QgsDataItem::Type | type, |
QgsDataItem * | parent, | ||
const QString & | name, | ||
const QString & | path | ||
) |
Create new data item.
Definition at line 209 of file qgsdataitem.cpp.
|
virtual |
Definition at line 224 of file qgsdataitem.cpp.
|
inlinevirtual |
Definition at line 140 of file qgsdataitem.h.
Definition at line 137 of file qgsdataitem.h.
|
virtual |
Definition at line 550 of file qgsdataitem.cpp.
|
signal |
|
signal |
|
inlinevirtual |
Definition at line 159 of file qgsdataitem.h.
|
inlinevirtual |
Definition at line 161 of file qgsdataitem.h.
|
inline |
Definition at line 180 of file qgsdataitem.h.
|
virtualslot |
Definition at line 400 of file qgsdataitem.cpp.
|
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 350 of file qgsdataitem.cpp.
|
signal |
|
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.
|
virtual |
Definition at line 584 of file qgsdataitem.cpp.
|
static |
Definition at line 274 of file qgsdataitem.cpp.
|
virtualslot |
Safely delete the item:
Definition at line 251 of file qgsdataitem.cpp.
|
virtualslot |
Remove children recursively and set as not populated.
This is used when refreshing collapsed items.
Definition at line 437 of file qgsdataitem.cpp.
|
slot |
Definition at line 315 of file qgsdataitem.cpp.
|
slot |
Definition at line 323 of file qgsdataitem.cpp.
|
slot |
Definition at line 332 of file qgsdataitem.cpp.
|
slot |
Definition at line 337 of file qgsdataitem.cpp.
|
slot |
Definition at line 319 of file qgsdataitem.cpp.
|
slot |
Definition at line 327 of file qgsdataitem.cpp.
|
slot |
Definition at line 342 of file qgsdataitem.cpp.
|
signal |
|
signal |
|
virtual |
Reimplemented in QgsDirectoryItem, and QgsLayerItem.
Definition at line 619 of file qgsdataitem.cpp.
|
static |
Definition at line 607 of file qgsdataitem.cpp.
|
inlinevirtual |
Definition at line 143 of file qgsdataitem.h.
bool QgsDataItem::hasChildren | ( | ) |
Definition at line 521 of file qgsdataitem.cpp.
|
virtual |
Reimplemented in QgsDirectoryItem.
Definition at line 299 of file qgsdataitem.cpp.
|
inline |
Definition at line 119 of file qgsdataitem.h.
void QgsDataItem::moveToThread | ( | QThread * | targetThread | ) |
Move object and all its descendants to thread.
Definition at line 285 of file qgsdataitem.cpp.
|
inline |
Definition at line 182 of file qgsdataitem.h.
|
inlinevirtual |
Reimplemented in QgsDirectoryItem.
Definition at line 134 of file qgsdataitem.h.
|
inline |
Get item parent.
QgsDataItem maintains its own items hierarchy, it does not use QObject hierarchy.
Definition at line 176 of file qgsdataitem.h.
|
inline |
Definition at line 184 of file qgsdataitem.h.
Create path component replacing path separators.
Definition at line 246 of file qgsdataitem.cpp.
|
protectedvirtual |
Definition at line 423 of file qgsdataitem.cpp.
|
virtualslot |
Definition at line 355 of file qgsdataitem.cpp.
|
protectedvirtual |
Definition at line 473 of file qgsdataitem.cpp.
|
virtualslot |
Definition at line 450 of file qgsdataitem.cpp.
|
virtual |
Definition at line 595 of file qgsdataitem.cpp.
int QgsDataItem::rowCount | ( | ) |
Definition at line 517 of file qgsdataitem.cpp.
|
inlinevirtual |
Definition at line 163 of file qgsdataitem.h.
|
inlinevirtual |
Definition at line 155 of file qgsdataitem.h.
|
inline |
Definition at line 192 of file qgsdataitem.h.
|
inline |
Definition at line 193 of file qgsdataitem.h.
|
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 526 of file qgsdataitem.cpp.
|
inline |
Definition at line 185 of file qgsdataitem.h.
|
virtual |
Set item state.
It also take care about starting/stopping loading icon animation.
state |
Reimplemented in QgsDirectoryItem.
Definition at line 638 of file qgsdataitem.cpp.
|
inline |
Definition at line 195 of file qgsdataitem.h.
QgsDataItem::State QgsDataItem::state | ( | ) | const |
Definition at line 629 of file qgsdataitem.cpp.
|
signal |
|
inline |
Definition at line 196 of file qgsdataitem.h.
|
inline |
Definition at line 172 of file qgsdataitem.h.
|
protected |
Definition at line 216 of file qgsdataitem.h.
|
protected |
Definition at line 218 of file qgsdataitem.h.
|
protected |
Definition at line 230 of file qgsdataitem.h.
Definition at line 231 of file qgsdataitem.h.
|
protected |
Definition at line 229 of file qgsdataitem.h.
|
protected |
Definition at line 222 of file qgsdataitem.h.
|
protected |
Definition at line 217 of file qgsdataitem.h.
|
protected |
Definition at line 227 of file qgsdataitem.h.
|
protected |
Definition at line 221 of file qgsdataitem.h.
|
protected |
Definition at line 219 of file qgsdataitem.h.
|
protected |
Definition at line 228 of file qgsdataitem.h.
|
protected |
Definition at line 215 of file qgsdataitem.h.