QGIS API Documentation  2.11.0-Master
Public Member Functions | List of all members
QgsColorSchemeModel Class Reference

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

#include <qgscolorschemelist.h>

Inheritance diagram for QgsColorSchemeModel:
Inheritance graph
[legend]

Public Member Functions

 QgsColorSchemeModel (QgsColorScheme *scheme, const QString &context=QString(), const QColor &baseColor=QColor(), QObject *parent=0)
 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...
 
QMimeDatamimeData (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, 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
 
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)
 
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
 

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

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 ( QgsColorScheme scheme,
const QString context = QString(),
const QColor baseColor = QColor(),
QObject parent = 0 
)
explicit

Constructor.

Parameters
schemecolor scheme for list
contextcontext string for color scheme
baseColorbase color for color scheme
parentparent object

Definition at line 238 of file qgscolorschemelist.cpp.

QgsColorSchemeModel::~QgsColorSchemeModel ( )

Definition at line 251 of file qgscolorschemelist.cpp.

Member Function Documentation

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

Add a color to the list.

Parameters
colorcolor to add
labellabel for color

Definition at line 586 of file qgscolorschemelist.cpp.

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.

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.

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

Definition at line 295 of file qgscolorschemelist.cpp.

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.

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

Definition at line 301 of file qgscolorschemelist.cpp.

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

Reimplemented from QAbstractItemModel.

Definition at line 461 of file qgscolorschemelist.cpp.

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

Reimplemented from QAbstractItemModel.

Definition at line 329 of file qgscolorschemelist.cpp.

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

Reimplemented from QAbstractItemModel.

Definition at line 384 of file qgscolorschemelist.cpp.

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

Definition at line 256 of file qgscolorschemelist.cpp.

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

Reimplemented from QAbstractItemModel.

Definition at line 566 of file qgscolorschemelist.cpp.

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.

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

Reimplemented from QAbstractItemModel.

Definition at line 444 of file qgscolorschemelist.cpp.

QStringList QgsColorSchemeModel::mimeTypes ( ) const
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 429 of file qgscolorschemelist.cpp.

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

Definition at line 274 of file qgscolorschemelist.cpp.

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

Reimplemented from QAbstractItemModel.

Definition at line 538 of file qgscolorschemelist.cpp.

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

Definition at line 282 of file qgscolorschemelist.cpp.

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

Reimplemented from QAbstractItemModel.

Definition at line 352 of file qgscolorschemelist.cpp.

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

Sets the color scheme to show in the widget.

Parameters
schemecolor scheme
contextcontext for color scheme
baseColorbase color for color scheme

Definition at line 527 of file qgscolorschemelist.cpp.

Qt::DropActions QgsColorSchemeModel::supportedDropActions ( ) const
overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 417 of file qgscolorschemelist.cpp.


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