QGIS API Documentation  2.5.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 ()
 
QModelIndex index (int row, int column, const QModelIndex &parent=QModelIndex()) const
 
QModelIndex parent (const QModelIndex &index) const
 
int rowCount (const QModelIndex &parent=QModelIndex()) const
 
int columnCount (const QModelIndex &parent=QModelIndex()) const
 
QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const
 
Qt::ItemFlags flags (const QModelIndex &index) const
 
bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
 
QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
 
Qt::DropActions supportedDropActions () const
 
QStringList mimeTypes () const
 
bool removeRows (int row, int count, const QModelIndex &parent=QModelIndex())
 
bool insertRows (int row, int count, const QModelIndex &parent=QModelIndex())
 
QMimeData * mimeData (const QModelIndexList &indexes) const
 
bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 
QgsNamedColorList colors () const
 Returns a list of colors shown in the widget. More...
 
void setScheme (QgsColorScheme *scheme, const QString context=QString(), const QColor baseColor=QColor())
 Sets the color scheme to show in the widget. More...
 
QString context () const
 Get the current color scheme context for the model. More...
 
QColor baseColor () const
 Get the base color for the color scheme used by the model. More...
 
void addColor (const QColor color, const QString label=QString())
 Add a color to the list. More...
 
bool isDirty () const
 Returns whether the color scheme model has been modified. More...
 

Detailed Description

A model for colors in a color scheme.

See also
QgsColorSchemeList
Note
introduced in QGIS 2.5

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
QgsColorSchemeModel::~QgsColorSchemeModel ( )

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
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
QgsNamedColorList QgsColorSchemeModel::colors ( ) const
inline

Returns a list of colors shown in the widget.

Returns
colors shown in the widget
int QgsColorSchemeModel::columnCount ( const QModelIndex &  parent = QModelIndex()) const
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
QVariant QgsColorSchemeModel::data ( const QModelIndex &  index,
int  role = Qt::DisplayRole 
) const
bool QgsColorSchemeModel::dropMimeData ( const QMimeData *  data,
Qt::DropAction  action,
int  row,
int  column,
const QModelIndex &  parent 
)
Qt::ItemFlags QgsColorSchemeModel::flags ( const QModelIndex &  index) const
QVariant QgsColorSchemeModel::headerData ( int  section,
Qt::Orientation  orientation,
int  role = Qt::DisplayRole 
) const
QModelIndex QgsColorSchemeModel::index ( int  row,
int  column,
const QModelIndex &  parent = QModelIndex() 
) const
bool QgsColorSchemeModel::insertRows ( int  row,
int  count,
const QModelIndex &  parent = QModelIndex() 
)
bool QgsColorSchemeModel::isDirty ( ) const
inline

Returns whether the color scheme model has been modified.

Returns
true if colors have been modified
QMimeData * QgsColorSchemeModel::mimeData ( const QModelIndexList &  indexes) const
QStringList QgsColorSchemeModel::mimeTypes ( ) const
QModelIndex QgsColorSchemeModel::parent ( const QModelIndex &  index) const
bool QgsColorSchemeModel::removeRows ( int  row,
int  count,
const QModelIndex &  parent = QModelIndex() 
)
int QgsColorSchemeModel::rowCount ( const QModelIndex &  parent = QModelIndex()) const
bool QgsColorSchemeModel::setData ( const QModelIndex &  index,
const QVariant &  value,
int  role = Qt::EditRole 
)
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
Qt::DropActions QgsColorSchemeModel::supportedDropActions ( ) const

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