QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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
 
QString context () const
 Get the current color scheme context for the model. More...
 
QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const
 
bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 
Qt::ItemFlags flags (const QModelIndex &index) const
 
QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
 
QModelIndex index (int row, int column, const QModelIndex &parent=QModelIndex()) const
 
bool insertRows (int row, int count, const QModelIndex &parent=QModelIndex())
 
bool isDirty () const
 Returns whether the color scheme model has been modified. More...
 
QMimeData * mimeData (const QModelIndexList &indexes) const
 
QStringList mimeTypes () const
 
QModelIndex parent (const QModelIndex &index) const
 
bool removeRows (int row, int count, const QModelIndex &parent=QModelIndex())
 
int rowCount (const QModelIndex &parent=QModelIndex()) const
 
bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
 
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
 

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 236 of file qgscolorschemelist.cpp.

QgsColorSchemeModel::~QgsColorSchemeModel ( )

Definition at line 249 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 584 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

Definition at line 293 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

Definition at line 299 of file qgscolorschemelist.cpp.

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

Definition at line 459 of file qgscolorschemelist.cpp.

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

Definition at line 327 of file qgscolorschemelist.cpp.

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

Definition at line 382 of file qgscolorschemelist.cpp.

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

Definition at line 254 of file qgscolorschemelist.cpp.

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

Definition at line 564 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

Definition at line 442 of file qgscolorschemelist.cpp.

QStringList QgsColorSchemeModel::mimeTypes ( ) const

Definition at line 427 of file qgscolorschemelist.cpp.

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

Definition at line 272 of file qgscolorschemelist.cpp.

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

Definition at line 536 of file qgscolorschemelist.cpp.

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

Definition at line 280 of file qgscolorschemelist.cpp.

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

Definition at line 350 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 525 of file qgscolorschemelist.cpp.

Qt::DropActions QgsColorSchemeModel::supportedDropActions ( ) const

Definition at line 415 of file qgscolorschemelist.cpp.


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