Class: QgsUserColorScheme

class qgis.core.QgsUserColorScheme(filename: str)

Bases: qgis._core.QgsGplColorScheme

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

QgsUserColorScheme(QgsUserColorScheme)

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

New in version 2.5: Enums

Methods

clone
erase Erases the associated gpl palette file from the users “palettes” folder
flags
gplFilePath
isEditable
schemeName
setName Sets the name for the scheme
setShowSchemeInMenu Sets whether a this scheme should be shown in color button menus.

Signals

Attributes

clone(self) → QgsUserColorScheme
erase(self) → bool

Erases the associated gpl palette file from the users “palettes” folder

Returns:True if erase was successful
flags(self) → QgsColorScheme.SchemeFlags
gplFilePath(self) → str
isEditable(self) → bool
schemeName(self) → str
setName(self, name: str)

Sets the name for the scheme

Parameters:name – new name
setShowSchemeInMenu(self, show: bool)

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

New in version 3.0.