QgsUserColorScheme Class Reference

A color scheme which stores its colors in a gpl palette file within the "palettes" subfolder off the user's QGIS settings folder. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsUserColorScheme:

Public Member Functions
	QgsUserColorScheme (const QString &filename)
	Constructs a new user color scheme, using a specified gpl palette file.
QgsUserColorScheme *	clone () const override
	Clones a color scheme.
bool	erase ()
	Erases the associated gpl palette file from the users "palettes" folder.
QgsColorScheme::SchemeFlags	flags () const override
	Returns the current flags for the color scheme.
bool	isEditable () const override
	Returns whether the color scheme is editable.
QString	schemeName () const override
	Gets the name for the color scheme.
void	setName (const QString &name)
	Sets the name for the scheme.
void	setShowSchemeInMenu (bool show)
	Sets whether a this scheme should be shown in color button menus.
Public Member Functions inherited from QgsGplColorScheme
	QgsGplColorScheme ()=default
QgsNamedColorList	fetchColors (const QString &context=QString(), const QColor &baseColor=QColor()) override
	Gets a list of colors from the scheme.
bool	setColors (const QgsNamedColorList &colors, const QString &context=QString(), const QColor &baseColor=QColor()) override
	Sets the colors for the scheme.
Public Member Functions inherited from QgsColorScheme
	QgsColorScheme ()=default
virtual	~QgsColorScheme ()=default

Protected Member Functions
QString	gplFilePath () override
	Returns the file path for the associated gpl palette file.

Protected Attributes
bool	mEditable = false
QString	mFilename
QString	mName

Additional Inherited Members
Public Types inherited from QgsColorScheme
enum	SchemeFlag { ShowInColorDialog = 0x01 , ShowInColorButtonMenu = 0x02 , ShowInAllContexts = ShowInColorDialog | ShowInColorButtonMenu }
	Flags for controlling behavior of color scheme. More...
typedef QFlags< SchemeFlag >	SchemeFlags

Detailed Description

A color scheme which stores its colors in a gpl palette file within the "palettes" subfolder off the user's QGIS settings folder.

Definition at line 165 of file qgscolorscheme.h.

Constructor & Destructor Documentation

QgsUserColorScheme()

QgsUserColorScheme::QgsUserColorScheme

(

const QString &

filename

)

Constructs a new user color scheme, using a specified gpl palette file.

Parameters

filename

filename of gpl palette file stored in the users "palettes" folder

Definition at line 292 of file qgscolorscheme.cpp.

Member Function Documentation

clone()

QgsUserColorScheme * QgsUserColorScheme::clone ( ) const

overridevirtual

Clones a color scheme.

Returns

copy of color scheme

Implements QgsColorScheme.

Definition at line 335 of file qgscolorscheme.cpp.

erase()

bool QgsUserColorScheme::erase

(

)

Erases the associated gpl palette file from the users "palettes" folder.

Returns

true if erase was successful

Definition at line 355 of file qgscolorscheme.cpp.

flags()

QgsColorScheme::SchemeFlags QgsUserColorScheme::flags ( ) const

overridevirtual

Returns the current flags for the color scheme.

Returns

current flags

Reimplemented from QgsColorScheme.

Definition at line 340 of file qgscolorscheme.cpp.

gplFilePath()

QString QgsUserColorScheme::gplFilePath ( )

overrideprotectedvirtual

Returns the file path for the associated gpl palette file.

Returns

gpl file path

Implements QgsGplColorScheme.

Definition at line 390 of file qgscolorscheme.cpp.

isEditable()

bool QgsUserColorScheme::isEditable ( ) const

inlineoverridevirtual

Returns whether the color scheme is editable.

Returns

true if scheme is editable

See also

setColors

Reimplemented from QgsColorScheme.

Definition at line 179 of file qgscolorscheme.h.

schemeName()

QString QgsUserColorScheme::schemeName ( ) const

overridevirtual

Gets the name for the color scheme.

Returns

color scheme name

Implements QgsColorScheme.

Definition at line 330 of file qgscolorscheme.cpp.

setName()

void QgsUserColorScheme::setName ( const QString &  name )

inline

Sets the name for the scheme.

Parameters

name

new name

Definition at line 187 of file qgscolorscheme.h.

setShowSchemeInMenu()

void QgsUserColorScheme::setShowSchemeInMenu

(

bool

show

)

Sets whether a this scheme should be shown in color button menus.

Parameters

show	set to true to show in color button menus, or false to hide from menus

Definition at line 373 of file qgscolorscheme.cpp.

Member Data Documentation

mEditable

bool QgsUserColorScheme::mEditable = false

protected

Definition at line 207 of file qgscolorscheme.h.

mFilename

QString QgsUserColorScheme::mFilename

protected

Definition at line 205 of file qgscolorscheme.h.

mName

QString QgsUserColorScheme::mName

protected

Definition at line 203 of file qgscolorscheme.h.

---

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

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/core/qgscolorscheme.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/core/qgscolorscheme.cpp