QGIS API Documentation  2.11.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Attributes | Protected Slots | Protected Attributes | List of all members
QgsMapLayerModel Class Reference

The QgsMapLayerModel class is a model to display layers in widgets. More...

#include <qgsmaplayermodel.h>

Inheritance diagram for QgsMapLayerModel:
Inheritance graph
[legend]

Public Member Functions

 QgsMapLayerModel (QObject *parent=0)
 QgsMapLayerModel creates a model to display layers in widgets. More...
 
 QgsMapLayerModel (QList< QgsMapLayer * > layers, QObject *parent=0)
 QgsMapLayerModel creates a model to display a specific list of layers in a widget. More...
 
void checkAll (Qt::CheckState checkState)
 checkAll changes the checkstate for all the layers More...
 
int columnCount (const QModelIndex &parent) const override
 
QVariant data (const QModelIndex &index, int role) const override
 
Qt::ItemFlags flags (const QModelIndex &index) const override
 
QModelIndex index (int row, int column, const QModelIndex &parent=QModelIndex()) const override
 
QModelIndex indexFromLayer (QgsMapLayer *layer) const
 indexFromLayer returns the model index for a given layer More...
 
bool itemsCheckable () const
 returns if the items can be checked or not More...
 
QList< QgsMapLayer * > layersChecked (Qt::CheckState checkState=Qt::Checked)
 layersChecked returns the list of layers which are checked (or unchecked) More...
 
QModelIndex parent (const QModelIndex &child) const override
 
int rowCount (const QModelIndex &parent) const override
 
bool setData (const QModelIndex &index, const QVariant &value, int role) override
 
void setItemsCheckable (bool checkable)
 setItemsCheckable defines if layers should be selectable in the widget More...
 
- Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent)
 
virtual  ~QAbstractItemModel ()
 
virtual QModelIndex buddy (const QModelIndex &index) const
 
virtual bool canFetchMore (const QModelIndex &parent) const
 
virtual int columnCount (const QModelIndex &parent) const =0
 
void columnsAboutToBeInserted (const QModelIndex &parent, int start, int end)
 
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsAboutToBeRemoved (const QModelIndex &parent, int start, int end)
 
void columnsInserted (const QModelIndex &parent, int start, int end)
 
void columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsRemoved (const QModelIndex &parent, int start, int end)
 
virtual QVariant data (const QModelIndex &index, int role) const =0
 
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight)
 
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 
virtual void fetchMore (const QModelIndex &parent)
 
virtual bool hasChildren (const QModelIndex &parent) const
 
bool hasIndex (int row, int column, const QModelIndex &parent) const
 
virtual QVariant headerData (int section, Qt::Orientation orientation, int role) const
 
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 
virtual QModelIndex index (int row, int column, const QModelIndex &parent) const =0
 
bool insertColumn (int column, const QModelIndex &parent)
 
virtual bool insertColumns (int column, int count, const QModelIndex &parent)
 
bool insertRow (int row, const QModelIndex &parent)
 
virtual bool insertRows (int row, int count, const QModelIndex &parent)
 
virtual QMap< int, QVariantitemData (const QModelIndex &index) const
 
void layoutAboutToBeChanged ()
 
void layoutChanged ()
 
virtual QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits, QFlags< Qt::MatchFlag > flags) const
 
virtual QMimeDatamimeData (const QModelIndexList &indexes) const
 
virtual QStringList mimeTypes () const
 
void modelAboutToBeReset ()
 
void modelReset ()
 
virtual QModelIndex parent (const QModelIndex &index) const =0
 
bool removeColumn (int column, const QModelIndex &parent)
 
virtual bool removeColumns (int column, int count, const QModelIndex &parent)
 
bool removeRow (int row, const QModelIndex &parent)
 
virtual bool removeRows (int row, int count, const QModelIndex &parent)
 
virtual void revert ()
 
const QHash< int, QByteArray > & roleNames () const
 
virtual int rowCount (const QModelIndex &parent) const =0
 
void rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)
 
void rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsAboutToBeRemoved (const QModelIndex &parent, int start, int end)
 
void rowsInserted (const QModelIndex &parent, int start, int end)
 
void rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsRemoved (const QModelIndex &parent, int start, int end)
 
virtual bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)
 
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
 
void setSupportedDragActions (QFlags< Qt::DropAction > actions)
 
QModelIndex sibling (int row, int column, const QModelIndex &index) const
 
virtual void sort (int column, Qt::SortOrder order)
 
virtual QSize span (const QModelIndex &index) const
 
virtual bool submit ()
 
Qt::DropActions supportedDragActions () const
 
virtual Qt::DropActions supportedDropActions () 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 Attributes

static const int LayerIdRole = Qt::UserRole + 1
 

Protected Slots

void addLayers (QList< QgsMapLayer * > layers)
 
void removeLayers (const QStringList layerIds)
 

Protected Attributes

bool mItemCheckable
 
QList< QgsMapLayer * > mLayers
 
QMap< QString, Qt::CheckState > mLayersChecked
 

Additional Inherited Members

- 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 inherited from QAbstractItemModel
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 
void beginInsertRows (const QModelIndex &parent, int first, int last)
 
bool beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 
void beginResetModel ()
 
void changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
 
void changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
 
QModelIndex createIndex (int row, int column, void *ptr) const
 
QModelIndex createIndex (int row, int column, int id) const
 
QModelIndex createIndex (int row, int column, quint32 id) const
 
void endInsertColumns ()
 
void endInsertRows ()
 
void endMoveColumns ()
 
void endMoveRows ()
 
void endRemoveColumns ()
 
void endRemoveRows ()
 
void endResetModel ()
 
QModelIndexList persistentIndexList () const
 
void reset ()
 
void resetInternalData ()
 
void setRoleNames (const QHash< int, QByteArray > &roleNames)
 
- 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)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

The QgsMapLayerModel class is a model to display layers in widgets.

See Also
QgsMapLayerProxyModel to sort and/filter the layers
QgsFieldModel to combine in with a field selector.
Note
added in 2.3

Definition at line 32 of file qgsmaplayermodel.h.

Constructor & Destructor Documentation

QgsMapLayerModel::QgsMapLayerModel ( QObject parent = 0)
explicit

QgsMapLayerModel creates a model to display layers in widgets.

Definition at line 36 of file qgsmaplayermodel.cpp.

QgsMapLayerModel::QgsMapLayerModel ( QList< QgsMapLayer * >  layers,
QObject parent = 0 
)
explicit

QgsMapLayerModel creates a model to display a specific list of layers in a widget.

Definition at line 27 of file qgsmaplayermodel.cpp.

Member Function Documentation

void QgsMapLayerModel::addLayers ( QList< QgsMapLayer * >  layers)
protectedslot

Definition at line 96 of file qgsmaplayermodel.cpp.

void QgsMapLayerModel::checkAll ( Qt::CheckState  checkState)

checkAll changes the checkstate for all the layers

Definition at line 51 of file qgsmaplayermodel.cpp.

int QgsMapLayerModel::columnCount ( const QModelIndex parent) const
override

Definition at line 130 of file qgsmaplayermodel.cpp.

QVariant QgsMapLayerModel::data ( const QModelIndex index,
int  role 
) const
override

Definition at line 137 of file qgsmaplayermodel.cpp.

Qt::ItemFlags QgsMapLayerModel::flags ( const QModelIndex index) const
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 217 of file qgsmaplayermodel.cpp.

QModelIndex QgsMapLayerModel::index ( int  row,
int  column,
const QModelIndex parent = QModelIndex() 
) const
override

Definition at line 107 of file qgsmaplayermodel.cpp.

QModelIndex QgsMapLayerModel::indexFromLayer ( QgsMapLayer layer) const

indexFromLayer returns the model index for a given layer

Definition at line 73 of file qgsmaplayermodel.cpp.

bool QgsMapLayerModel::itemsCheckable ( ) const
inline

returns if the items can be checked or not

Definition at line 60 of file qgsmaplayermodel.h.

QList< QgsMapLayer * > QgsMapLayerModel::layersChecked ( Qt::CheckState  checkState = Qt::Checked)

layersChecked returns the list of layers which are checked (or unchecked)

Definition at line 60 of file qgsmaplayermodel.cpp.

QModelIndex QgsMapLayerModel::parent ( const QModelIndex child) const
override

Definition at line 118 of file qgsmaplayermodel.cpp.

void QgsMapLayerModel::removeLayers ( const QStringList  layerIds)
protectedslot

Definition at line 79 of file qgsmaplayermodel.cpp.

int QgsMapLayerModel::rowCount ( const QModelIndex parent) const
override

Definition at line 125 of file qgsmaplayermodel.cpp.

bool QgsMapLayerModel::setData ( const QModelIndex index,
const QVariant value,
int  role 
)
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 233 of file qgsmaplayermodel.cpp.

void QgsMapLayerModel::setItemsCheckable ( bool  checkable)

setItemsCheckable defines if layers should be selectable in the widget

Definition at line 46 of file qgsmaplayermodel.cpp.

Member Data Documentation

const int QgsMapLayerModel::LayerIdRole = Qt::UserRole + 1
static

Definition at line 36 of file qgsmaplayermodel.h.

bool QgsMapLayerModel::mItemCheckable
protected

Definition at line 75 of file qgsmaplayermodel.h.

QList<QgsMapLayer*> QgsMapLayerModel::mLayers
protected

Definition at line 73 of file qgsmaplayermodel.h.

QMap<QString, Qt::CheckState> QgsMapLayerModel::mLayersChecked
protected

Definition at line 74 of file qgsmaplayermodel.h.


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