QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Slots | Signals | Public Member Functions | Static Public 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  Type {
  Collection, Directory, Layer, Error,
  Favourites
}
 

Public Slots

void emitBeginInsertItems (QgsDataItem *parent, int first, int last)
 
void emitBeginRemoveItems (QgsDataItem *parent, int first, int last)
 
void emitEndInsertItems ()
 
void emitEndRemoveItems ()
 

Signals

void beginInsertItems (QgsDataItem *parent, int first, int last)
 
void beginRemoveItems (QgsDataItem *parent, int first, int last)
 
void endInsertItems ()
 
void endRemoveItems ()
 

Public Member Functions

 QgsDataItem (QgsDataItem::Type type, QgsDataItem *parent, QString name, QString path)
 
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 ()
 
virtual void deleteChildItem (QgsDataItem *child)
 
virtual void depopulate ()
 Remove children recursively and set as not populated. More...
 
virtual bool equal (const QgsDataItem *other)
 
virtual bool handleDrop (const QMimeData *, Qt::DropAction)
 
bool hasChildren ()
 
virtual QIcon icon ()
 
bool isPopulated ()
 
QString name () const
 
virtual QWidget * paramWidget ()
 
QgsDataItemparent () const
 
QString path () const
 
virtual void populate ()
 
virtual void populate (QVector< QgsDataItem * > children)
 
virtual void refresh ()
 
virtual void refresh (QVector< QgsDataItem * > children)
 
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 setParent (QgsDataItem *parent)
 
void setPath (const QString &path)
 
void setPopulated ()
 Set as populated without populating. More...
 
void setToolTip (QString msg)
 
QString toolTip () const
 
Type type () const
 

Static Public Member Functions

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

Protected Attributes

Capabilities mCapabilities
 
QVector< QgsDataItem * > mChildren
 
QIcon mIcon
 
QString mIconName
 
QString mName
 
QgsDataItemmParent
 
QString mPath
 
bool mPopulated
 
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

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

Enumerator
Collection 
Directory 
Layer 
Error 
Favourites 

Definition at line 43 of file qgsdataitem.h.

Constructor & Destructor Documentation

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

Definition at line 152 of file qgsdataitem.cpp.

QgsDataItem::~QgsDataItem ( )
virtual

Definition at line 164 of file qgsdataitem.cpp.

Member Function Documentation

virtual bool QgsDataItem::acceptDrop ( )
inlinevirtual

Definition at line 96 of file qgsdataitem.h.

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

Definition at line 93 of file qgsdataitem.h.

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

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

virtual Capabilities QgsDataItem::capabilities2 ( ) const
inlinevirtual

Definition at line 117 of file qgsdataitem.h.

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

Definition at line 131 of file qgsdataitem.h.

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

Reimplemented in QgsZipItem, QgsFavouritesItem, and QgsDirectoryItem.

Definition at line 197 of file qgsdataitem.cpp.

void QgsDataItem::deleteChildItem ( QgsDataItem child)
virtual

Definition at line 302 of file qgsdataitem.cpp.

void QgsDataItem::depopulate ( )
virtual

Remove children recursively and set as not populated.

This is used when refreshing collapsed items.

Definition at line 235 of file qgsdataitem.cpp.

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

Definition at line 180 of file qgsdataitem.cpp.

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

Definition at line 188 of file qgsdataitem.cpp.

void QgsDataItem::emitEndInsertItems ( )
slot

Definition at line 184 of file qgsdataitem.cpp.

void QgsDataItem::emitEndRemoveItems ( )
slot

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

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

Definition at line 333 of file qgsdataitem.cpp.

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

Definition at line 99 of file qgsdataitem.h.

bool QgsDataItem::hasChildren ( )

Definition at line 255 of file qgsdataitem.cpp.

QIcon QgsDataItem::icon ( )
virtual

Reimplemented in QgsDirectoryItem.

Definition at line 169 of file qgsdataitem.cpp.

bool QgsDataItem::isPopulated ( )
inline

Definition at line 72 of file qgsdataitem.h.

QString QgsDataItem::name ( ) const
inline

Definition at line 133 of file qgsdataitem.h.

virtual QWidget* QgsDataItem::paramWidget ( )
inlinevirtual

Reimplemented in QgsDirectoryItem.

Definition at line 90 of file qgsdataitem.h.

QgsDataItem* QgsDataItem::parent ( ) const
inline

Definition at line 129 of file qgsdataitem.h.

QString QgsDataItem::path ( ) const
inline

Definition at line 134 of file qgsdataitem.h.

void QgsDataItem::populate ( )
virtual

Definition at line 202 of file qgsdataitem.cpp.

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

Definition at line 218 of file qgsdataitem.cpp.

void QgsDataItem::refresh ( )
virtual

Definition at line 387 of file qgsdataitem.cpp.

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

Definition at line 344 of file qgsdataitem.cpp.

QgsDataItem * QgsDataItem::removeChildItem ( QgsDataItem child)
virtual

Definition at line 313 of file qgsdataitem.cpp.

int QgsDataItem::rowCount ( )

Definition at line 251 of file qgsdataitem.cpp.

virtual void QgsDataItem::setCapabilities ( Capabilities  capabilities)
inlinevirtual

Definition at line 119 of file qgsdataitem.h.

virtual bool QgsDataItem::setCrs ( QgsCoordinateReferenceSystem  crs)
inlinevirtual

Definition at line 111 of file qgsdataitem.h.

void QgsDataItem::setIcon ( QIcon  icon)
inline

Definition at line 140 of file qgsdataitem.h.

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

Definition at line 141 of file qgsdataitem.h.

void QgsDataItem::setParent ( QgsDataItem parent)
inline

Definition at line 130 of file qgsdataitem.h.

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

Definition at line 135 of file qgsdataitem.h.

void QgsDataItem::setPopulated ( )
inline

Set as populated without populating.

Definition at line 75 of file qgsdataitem.h.

void QgsDataItem::setToolTip ( QString  msg)
inline

Definition at line 143 of file qgsdataitem.h.

QString QgsDataItem::toolTip ( ) const
inline

Definition at line 144 of file qgsdataitem.h.

Type QgsDataItem::type ( ) const
inline

Definition at line 128 of file qgsdataitem.h.

Member Data Documentation

Capabilities QgsDataItem::mCapabilities
protected

Definition at line 149 of file qgsdataitem.h.

QVector<QgsDataItem*> QgsDataItem::mChildren
protected

Definition at line 151 of file qgsdataitem.h.

QIcon QgsDataItem::mIcon
protected

Definition at line 161 of file qgsdataitem.h.

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

Definition at line 162 of file qgsdataitem.h.

QString QgsDataItem::mIconName
protected

Definition at line 160 of file qgsdataitem.h.

QString QgsDataItem::mName
protected

Definition at line 153 of file qgsdataitem.h.

QgsDataItem* QgsDataItem::mParent
protected

Definition at line 150 of file qgsdataitem.h.

QString QgsDataItem::mPath
protected

Definition at line 158 of file qgsdataitem.h.

bool QgsDataItem::mPopulated
protected

Definition at line 152 of file qgsdataitem.h.

QString QgsDataItem::mToolTip
protected

Definition at line 159 of file qgsdataitem.h.

Type QgsDataItem::mType
protected

Definition at line 148 of file qgsdataitem.h.


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