QgsMapLayerModel Class Reference

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

#include <qgsmaplayermodel.h>

Public Member Functions
	QgsMapLayerModel (QObject *parent=0)
	QgsMapLayerModel creates a model to display layers in widgets.
	QgsMapLayerModel (QList< QgsMapLayer * > layers, QObject *parent=0)
	QgsMapLayerModel creates a model to display a specific list of layers in a widget.
void	setItemsCheckable (bool checkable)
	setItemsCheckable defines if layers should be selectable in the widget
void	checkAll (Qt::CheckState checkState)
	checkAll changes the checkstate for all the layers
QList< QgsMapLayer * >	layersChecked (Qt::CheckState checkState=Qt::Checked)
	layersChecked returns the list of layers which are checked (or unchecked)
bool	itemsCheckable () const
	returns if the items can be checked or not
QModelIndex	indexFromLayer (QgsMapLayer *layer) const
	indexFromLayer returns the model index for a given layer
QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const
QModelIndex	parent (const QModelIndex &child) const
int	rowCount (const QModelIndex &parent) const
int	columnCount (const QModelIndex &parent) const
QVariant	data (const QModelIndex &index, int role) const
bool	setData (const QModelIndex &index, const QVariant &value, int role)
Qt::ItemFlags	flags (const QModelIndex &index) const

Static Public Attributes
static const int	LayerIdRole = Qt::UserRole + 1

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

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

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

Constructor & Destructor Documentation

QgsMapLayerModel::QgsMapLayerModel ( QObject *  parent = 0 )

explicit

QgsMapLayerModel creates a model to display layers in widgets.

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

explicit

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

Member Function Documentation

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

protectedslot

void QgsMapLayerModel::checkAll

(

Qt::CheckState

checkState

)

checkAll changes the checkstate for all the layers

int QgsMapLayerModel::columnCount

(

const QModelIndex &

parent

)

const

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

Qt::ItemFlags QgsMapLayerModel::flags

(

const QModelIndex &

index

)

const

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

QModelIndex QgsMapLayerModel::indexFromLayer

(

QgsMapLayer *

layer

)

const

indexFromLayer returns the model index for a given layer

bool QgsMapLayerModel::itemsCheckable ( ) const

inline

returns if the items can be checked or not

QList< QgsMapLayer * > QgsMapLayerModel::layersChecked

(

Qt::CheckState

checkState = Qt::Checked

)

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

QModelIndex QgsMapLayerModel::parent

(

const QModelIndex &

child

)

const

void QgsMapLayerModel::removeLayers ( const QStringList  layerIds )

protectedslot

int QgsMapLayerModel::rowCount

(

const QModelIndex &

parent

)

const

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

void QgsMapLayerModel::setItemsCheckable

(

bool

checkable

)

setItemsCheckable defines if layers should be selectable in the widget

Member Data Documentation

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

static

bool QgsMapLayerModel::mItemCheckable

protected

QList<QgsMapLayer*> QgsMapLayerModel::mLayers

protected

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

protected

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsmaplayermodel.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgsmaplayermodel.cpp