QGIS API Documentation  2.8.2-Wien
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsColorSchemeModel Class Reference

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

#include <qgscolorschemelist.h>

Public Member Functions

 QgsColorSchemeModel (QgsColorScheme *scheme, const QString &context=QString(), const QColor &baseColor=QColor(), QObject *parent=0)
 Constructor.
 ~QgsColorSchemeModel ()
void addColor (const QColor &color, const QString &label=QString())
 Add a color to the list.
QColor baseColor () const
 Get the base color for the color scheme used by the model.
QgsNamedColorList colors () const
 Returns a list of colors shown in the widget.
int columnCount (const QModelIndex &parent=QModelIndex()) const override
QString context () const
 Get the current color scheme context for the model.
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.
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.
Qt::DropActions supportedDropActions () const override

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

Definition at line 461 of file qgscolorschemelist.cpp.

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

Definition at line 329 of file qgscolorschemelist.cpp.

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

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() 
)
override

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
override

Definition at line 444 of file qgscolorschemelist.cpp.

QStringList QgsColorSchemeModel::mimeTypes ( ) const
override

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() 
)
override

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

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
override

Definition at line 417 of file qgscolorschemelist.cpp.


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