A model for colors in a color scheme. More...

#include <qgscolorschemelist.h>

Inheritance diagram for QgsColorSchemeModel:

Public Member Functions
	QgsColorSchemeModel (QgsColorScheme scheme, const QString &context=QString(), const QColor &baseColor=QColor(), QObject parent=nullptr)
	Constructor. More...

	~QgsColorSchemeModel ()

void	addColor (const QColor &color, const QString &label=QString())
	Add a color to the list. More...

QColor	baseColor () const
	Get the base color for the color scheme used by the model. More...

QgsNamedColorList	colors () const
	Returns a list of colors shown in the widget. More...

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

QString	context () const
	Get the current color scheme context for the model. More...

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

Qt::ItemFlags	flags (const QModelIndex &index) const override

QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override

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

bool	insertRows (int row, int count, const QModelIndex &parent=QModelIndex()) override

bool	isDirty () const
	Returns whether the color scheme model has been modified. More...

QMimeData *	mimeData (const QModelIndexList &indexes) const override

QStringList	mimeTypes () const override

QModelIndex	parent (const QModelIndex &index) const override

bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override

void	setScheme (QgsColorScheme *scheme, const QString &context=QString(), const QColor &baseColor=QColor())
	Sets the color scheme to show in the widget. More...

Qt::DropActions	supportedDropActions () const override

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 void	fetchMore (const QModelIndex &parent)

virtual bool	hasChildren (const QModelIndex &parent) const

bool	hasIndex (int row, int column, const QModelIndex &parent) 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 QMap< int, QVariant >	itemData (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

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 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

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 &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 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

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

QObject *	sender () 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

A model for colors in a color scheme.

See also: QgsColorSchemeList

Note: introduced in QGIS 2.5

Definition at line 58 of file qgscolorschemelist.h.

Constructor & Destructor Documentation

◆ QgsColorSchemeModel()

QgsColorSchemeModel::QgsColorSchemeModel	(	QgsColorScheme *	scheme,
		const QString &	context = `QString()`,
		const QColor &	baseColor = `QColor()`,
		QObject *	parent = `nullptr`
	)

explicit

Constructor.

Parameters

scheme	color scheme for list
context	context string for color scheme
baseColor	base color for color scheme
parent	parent object

Definition at line 243 of file qgscolorschemelist.cpp.

◆ ~QgsColorSchemeModel()

QgsColorSchemeModel::~QgsColorSchemeModel ( )

Definition at line 256 of file qgscolorschemelist.cpp.

Member Function Documentation

◆ addColor()

void QgsColorSchemeModel::addColor	(	const QColor &	color,
		const QString &	label = `QString()`
	)

Add a color to the list.

Parameters

color	color to add
label	label for color

Definition at line 590 of file qgscolorschemelist.cpp.

◆ baseColor()

QColor QgsColorSchemeModel::baseColor ( ) const

inline

Get the base color for the color scheme used by the model.

Returns: base color which is passed to scheme for color generation

See also: context

Definition at line 112 of file qgscolorschemelist.h.

◆ colors()

QgsNamedColorList QgsColorSchemeModel::colors ( ) const

inline

Returns a list of colors shown in the widget.

Returns: colors shown in the widget

Definition at line 93 of file qgscolorschemelist.h.

◆ columnCount()

int QgsColorSchemeModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

override

Definition at line 300 of file qgscolorschemelist.cpp.

◆ context()

QString QgsColorSchemeModel::context ( ) const

inline

Get the current color scheme context for the model.

Returns: context string which is passed to scheme for color generation

See also: baseColor

Definition at line 106 of file qgscolorschemelist.h.

◆ data()

QVariant QgsColorSchemeModel::data	(	const QModelIndex &	index,
		int	role = `Qt::DisplayRole`
	)		const

override

Definition at line 306 of file qgscolorschemelist.cpp.

◆ dropMimeData()

bool QgsColorSchemeModel::dropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 465 of file qgscolorschemelist.cpp.

◆ flags()

Qt::ItemFlags QgsColorSchemeModel::flags ( const QModelIndex & index ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 334 of file qgscolorschemelist.cpp.

◆ headerData()

QVariant QgsColorSchemeModel::headerData	(	int	section,
		Qt::Orientation	orientation,
		int	role = `Qt::DisplayRole`
	)		const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 389 of file qgscolorschemelist.cpp.

◆ index()

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

override

Definition at line 261 of file qgscolorschemelist.cpp.

◆ insertRows()

bool QgsColorSchemeModel::insertRows	(	int	row,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 570 of file qgscolorschemelist.cpp.

◆ isDirty()

bool QgsColorSchemeModel::isDirty ( ) const

inline

Returns whether the color scheme model has been modified.

Returns: true if colors have been modified

Definition at line 123 of file qgscolorschemelist.h.

◆ mimeData()

QMimeData * QgsColorSchemeModel::mimeData ( const QModelIndexList & indexes ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 448 of file qgscolorschemelist.cpp.

◆ mimeTypes()

QStringList QgsColorSchemeModel::mimeTypes ( ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 433 of file qgscolorschemelist.cpp.

◆ parent()

QModelIndex QgsColorSchemeModel::parent ( const QModelIndex & index ) const

override

Definition at line 279 of file qgscolorschemelist.cpp.

◆ removeRows()

bool QgsColorSchemeModel::removeRows	(	int	row,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 542 of file qgscolorschemelist.cpp.

◆ rowCount()

int QgsColorSchemeModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

override

Definition at line 287 of file qgscolorschemelist.cpp.

◆ setData()

bool QgsColorSchemeModel::setData	(	const QModelIndex &	index,
		const QVariant &	value,
		int	role = `Qt::EditRole`
	)

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 357 of file qgscolorschemelist.cpp.

◆ setScheme()

void QgsColorSchemeModel::setScheme	(	QgsColorScheme *	scheme,
		const QString &	context = `QString()`,
		const QColor &	baseColor = `QColor()`
	)

Sets the color scheme to show in the widget.

Parameters

scheme	color scheme
context	context for color scheme
baseColor	base color for color scheme

Definition at line 531 of file qgscolorschemelist.cpp.

◆ supportedDropActions()

Qt::DropActions QgsColorSchemeModel::supportedDropActions ( ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 421 of file qgscolorschemelist.cpp.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/gui/qgscolorschemelist.h
/tmp/buildd/qgis-2.18.21+99unstable/src/gui/qgscolorschemelist.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsColorSchemeModel()

◆ ~QgsColorSchemeModel()

Member Function Documentation

◆ addColor()

◆ baseColor()

◆ colors()

◆ columnCount()

◆ context()

◆ data()

◆ dropMimeData()

◆ flags()

◆ headerData()

◆ index()

◆ insertRows()

◆ isDirty()

◆ mimeData()

◆ mimeTypes()

◆ parent()

◆ removeRows()

◆ rowCount()

◆ setData()

◆ setScheme()

◆ supportedDropActions()