QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
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=nullptr)
 Constructor. More...
 
void addColor (const QColor &color, const QString &label=QString(), bool allowDuplicate=false)
 Add a color to the list. More...
 
QColor baseColor () const
 Gets 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
 Gets 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
 

Detailed Description

A model for colors in a color scheme.

See also
QgsColorSchemeList

Definition at line 66 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
schemecolor scheme for list
contextcontext string for color scheme
baseColorbase color for color scheme
parentparent object

Definition at line 306 of file qgscolorschemelist.cpp.

Member Function Documentation

◆ addColor()

void QgsColorSchemeModel::addColor ( const QColor &  color,
const QString &  label = QString(),
bool  allowDuplicate = false 
)

Add a color to the list.

Parameters
colorcolor to add
labellabel for color
allowDuplicateset to true to allow duplicate colors to be added (colors which are already present in the list)

Definition at line 648 of file qgscolorschemelist.cpp.

◆ baseColor()

QColor QgsColorSchemeModel::baseColor ( ) const
inline

Gets 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 123 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 101 of file qgscolorschemelist.h.

◆ columnCount()

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

Definition at line 358 of file qgscolorschemelist.cpp.

◆ context()

QString QgsColorSchemeModel::context ( ) const
inline

Gets 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 116 of file qgscolorschemelist.h.

◆ data()

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

Definition at line 364 of file qgscolorschemelist.cpp.

◆ dropMimeData()

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

Definition at line 523 of file qgscolorschemelist.cpp.

◆ flags()

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

Definition at line 392 of file qgscolorschemelist.cpp.

◆ headerData()

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

Definition at line 447 of file qgscolorschemelist.cpp.

◆ index()

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

Definition at line 319 of file qgscolorschemelist.cpp.

◆ insertRows()

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

Definition at line 628 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 137 of file qgscolorschemelist.h.

◆ mimeData()

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

Definition at line 506 of file qgscolorschemelist.cpp.

◆ mimeTypes()

QStringList QgsColorSchemeModel::mimeTypes ( ) const
override

Definition at line 491 of file qgscolorschemelist.cpp.

◆ parent()

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

Definition at line 337 of file qgscolorschemelist.cpp.

◆ removeRows()

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

Definition at line 600 of file qgscolorschemelist.cpp.

◆ rowCount()

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

Definition at line 345 of file qgscolorschemelist.cpp.

◆ setData()

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

Definition at line 415 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
schemecolor scheme
contextcontext for color scheme
baseColorbase color for color scheme

Definition at line 589 of file qgscolorschemelist.cpp.

◆ supportedDropActions()

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

Definition at line 479 of file qgscolorschemelist.cpp.


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