QGIS API Documentation
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsCptCityColorRampV2 Class Reference

#include <qgsvectorcolorrampv2.h>

Inheritance diagram for QgsCptCityColorRampV2:
Inheritance graph
[legend]

Public Member Functions

 QgsCptCityColorRampV2 (const QString &schemeName=DEFAULT_CPTCITY_SCHEMENAME, const QString &variantName=DEFAULT_CPTCITY_VARIANTNAME, bool doLoadFile=true)
 
 QgsCptCityColorRampV2 (const QString &schemeName, const QStringList &variantList, const QString &variantName=QString(), bool doLoadFile=true)
 
virtual QgsCptCityColorRampV2clone () const override
 Creates a clone of the color ramp. More...
 
QgsVectorGradientColorRampV2cloneGradientRamp () const
 
void copy (const QgsCptCityColorRampV2 *other)
 
QString copyingFileName () const
 
QgsStringMap copyingInfo () const
 
QString descFileName () const
 
bool fileLoaded () const
 
QString fileName () const
 
bool hasMultiStops () const
 
bool loadFile ()
 
void loadPalette ()
 
virtual QgsStringMap properties () const override
 Returns a string map containing all the color ramp's properties. More...
 
QString schemeName () const
 
void setName (const QString &schemeName, const QString &variantName="", const QStringList &variantList=QStringList())
 
void setSchemeName (const QString &schemeName)
 
void setVariantList (const QStringList &variantList)
 
void setVariantName (const QString &variantName)
 
virtual QString type () const override
 Returns a string representing the color ramp type. More...
 
QStringList variantList () const
 
QString variantName () const
 
- Public Member Functions inherited from QgsVectorGradientColorRampV2
 QgsVectorGradientColorRampV2 (const QColor &color1=DEFAULT_GRADIENT_COLOR1, const QColor &color2=DEFAULT_GRADIENT_COLOR2, bool discrete=false, const QgsGradientStopsList &stops=QgsGradientStopsList())
 Constructor for QgsVectorGradientColorRampV2. More...
 
void addStopsToGradient (QGradient *gradient, double alpha=1)
 Copy color ramp stops to a QGradient. More...
 
virtual QColor color (double value) const override
 Returns the color corresponding to a specified value. More...
 
QColor color1 () const
 Returns the gradient start color. More...
 
QColor color2 () const
 Returns the gradient end color. More...
 
void convertToDiscrete (bool discrete)
 Converts a gradient with existing color stops to or from discrete interpolation. More...
 
virtual int count () const override
 Returns number of defined colors, or -1 if undefined. More...
 
QgsStringMap info () const
 Returns any additional info attached to the gradient ramp (eg authorship notes) More...
 
bool isDiscrete () const
 Returns true if the gradient is using discrete interpolation, rather than smoothly interpolating between colors. More...
 
void setColor1 (const QColor &color)
 Sets the gradient start color. More...
 
void setColor2 (const QColor &color)
 Sets the gradient end color. More...
 
void setDiscrete (bool discrete)
 Sets whether the gradient should use discrete interpolation, rather than smoothly interpolating between colors. More...
 
void setInfo (const QgsStringMap &info)
 Sets additional info to attach to the gradient ramp (eg authorship notes) More...
 
void setStops (const QgsGradientStopsList &stops)
 Sets the list of intermediate gradient stops for the ramp. More...
 
QgsGradientStopsList stops () const
 Returns the list of intermediate gradient stops for the ramp. More...
 
virtual double value (int index) const override
 Returns relative value between [0,1] of color at specified index. More...
 
- Public Member Functions inherited from QgsVectorColorRampV2
virtual ~QgsVectorColorRampV2 ()
 

Static Public Member Functions

static QgsVectorColorRampV2create (const QgsStringMap &properties=QgsStringMap())
 
- Static Public Member Functions inherited from QgsVectorGradientColorRampV2
static QgsVectorColorRampV2create (const QgsStringMap &properties=QgsStringMap())
 Creates a new QgsVectorColorRampV2 from a map of properties. More...
 

Protected Attributes

bool mFileLoaded
 
bool mMultiStops
 
QString mSchemeName
 
QStringList mVariantList
 
QString mVariantName
 
- Protected Attributes inherited from QgsVectorGradientColorRampV2
QColor mColor1
 
QColor mColor2
 
bool mDiscrete
 
QgsStringMap mInfo
 
QgsGradientStopsList mStops
 

Detailed Description

Definition at line 350 of file qgsvectorcolorrampv2.h.

Constructor & Destructor Documentation

QgsCptCityColorRampV2::QgsCptCityColorRampV2 ( const QString schemeName = DEFAULT_CPTCITY_SCHEMENAME,
const QString variantName = DEFAULT_CPTCITY_VARIANTNAME,
bool  doLoadFile = true 
)

Definition at line 528 of file qgsvectorcolorrampv2.cpp.

QgsCptCityColorRampV2::QgsCptCityColorRampV2 ( const QString schemeName,
const QStringList variantList,
const QString variantName = QString(),
bool  doLoadFile = true 
)

Definition at line 540 of file qgsvectorcolorrampv2.cpp.

Member Function Documentation

QgsCptCityColorRampV2 * QgsCptCityColorRampV2::clone ( ) const
overridevirtual

Creates a clone of the color ramp.

Reimplemented from QgsVectorGradientColorRampV2.

Definition at line 567 of file qgsvectorcolorrampv2.cpp.

QgsVectorGradientColorRampV2 * QgsCptCityColorRampV2::cloneGradientRamp ( ) const

Definition at line 588 of file qgsvectorcolorrampv2.cpp.

void QgsCptCityColorRampV2::copy ( const QgsCptCityColorRampV2 other)

Definition at line 574 of file qgsvectorcolorrampv2.cpp.

QString QgsCptCityColorRampV2::copyingFileName ( ) const

Definition at line 623 of file qgsvectorcolorrampv2.cpp.

QgsStringMap QgsCptCityColorRampV2::copyingInfo ( ) const

Definition at line 635 of file qgsvectorcolorrampv2.cpp.

QgsVectorColorRampV2 * QgsCptCityColorRampV2::create ( const QgsStringMap properties = QgsStringMap())
static

Definition at line 554 of file qgsvectorcolorrampv2.cpp.

QString QgsCptCityColorRampV2::descFileName ( ) const

Definition at line 629 of file qgsvectorcolorrampv2.cpp.

bool QgsCptCityColorRampV2::fileLoaded ( ) const
inline

Definition at line 385 of file qgsvectorcolorrampv2.h.

QString QgsCptCityColorRampV2::fileName ( ) const

Definition at line 613 of file qgsvectorcolorrampv2.cpp.

bool QgsCptCityColorRampV2::hasMultiStops ( ) const
inline

Definition at line 381 of file qgsvectorcolorrampv2.h.

bool QgsCptCityColorRampV2::loadFile ( )

Definition at line 640 of file qgsvectorcolorrampv2.cpp.

void QgsCptCityColorRampV2::loadPalette ( )
inline

Definition at line 380 of file qgsvectorcolorrampv2.h.

QgsStringMap QgsCptCityColorRampV2::properties ( ) const
overridevirtual

Returns a string map containing all the color ramp's properties.

Reimplemented from QgsVectorGradientColorRampV2.

Definition at line 604 of file qgsvectorcolorrampv2.cpp.

QString QgsCptCityColorRampV2::schemeName ( ) const
inline

Definition at line 369 of file qgsvectorcolorrampv2.h.

void QgsCptCityColorRampV2::setName ( const QString schemeName,
const QString variantName = "",
const QStringList variantList = QStringList() 
)
inline

Definition at line 377 of file qgsvectorcolorrampv2.h.

void QgsCptCityColorRampV2::setSchemeName ( const QString schemeName)
inline

Definition at line 374 of file qgsvectorcolorrampv2.h.

void QgsCptCityColorRampV2::setVariantList ( const QStringList variantList)
inline

Definition at line 376 of file qgsvectorcolorrampv2.h.

void QgsCptCityColorRampV2::setVariantName ( const QString variantName)
inline

Definition at line 375 of file qgsvectorcolorrampv2.h.

virtual QString QgsCptCityColorRampV2::type ( ) const
inlineoverridevirtual

Returns a string representing the color ramp type.

Reimplemented from QgsVectorGradientColorRampV2.

Definition at line 361 of file qgsvectorcolorrampv2.h.

QStringList QgsCptCityColorRampV2::variantList ( ) const
inline

Definition at line 371 of file qgsvectorcolorrampv2.h.

QString QgsCptCityColorRampV2::variantName ( ) const
inline

Definition at line 370 of file qgsvectorcolorrampv2.h.

Member Data Documentation

bool QgsCptCityColorRampV2::mFileLoaded
protected

Definition at line 396 of file qgsvectorcolorrampv2.h.

bool QgsCptCityColorRampV2::mMultiStops
protected

Definition at line 397 of file qgsvectorcolorrampv2.h.

QString QgsCptCityColorRampV2::mSchemeName
protected

Definition at line 393 of file qgsvectorcolorrampv2.h.

QStringList QgsCptCityColorRampV2::mVariantList
protected

Definition at line 395 of file qgsvectorcolorrampv2.h.

QString QgsCptCityColorRampV2::mVariantName
protected

Definition at line 394 of file qgsvectorcolorrampv2.h.


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