A cross platform button subclass for selecting color ramps. More...

#include <qgscolorrampbutton.h>

Inheritance diagram for QgsColorRampButton:

Public Slots
void	setButtonBackground (QgsColorRamp *colorramp=nullptr)
	Sets the background pixmap for the button based upon current color ramp. More...

void	setColorRamp (QgsColorRamp *colorramp)
	Sets the current color ramp for the button. More...

void	setColorRampFromName (const QString &name=QString())
	Sets the current color ramp for the button using a saved color ramp name. More...

void	setRandomColorRamp ()
	Sets the current color ramp for the button to random colors. More...

void	setToDefaultColorRamp ()
	Sets color ramp to the button's default color ramp, if set. More...

void	setToNull ()
	Sets color ramp to null. More...

Signals
void	colorRampChanged ()
	Emitted whenever a new color ramp is set for the button. More...

Public Member Functions
	QgsColorRampButton (QWidget *parent=nullptr, const QString &dialogTitle=QString())
	Construct a new color ramp button. More...

	~QgsColorRampButton () override

bool	acceptLiveUpdates () const
	Returns whether the button accepts live updates from QgsColorRampDialog. More...

QgsColorRamp *	colorRamp () const
	Returns a copy of the current color ramp. More...

QString	colorRampDialogTitle () const
	Returns the title for the color ramp dialog window. More...

QString	colorRampName () const
	Returns the name of the current color ramp when it's available in the style manager. More...

QString	context () const
	Returns the context string for the color ramp button. More...

QgsColorRamp *	defaultColorRamp () const
	Returns a copy of the default color ramp for the button, which is shown in the button's drop-down menu for the "default color ramp" option. More...

bool	isNull () const
	Returns `true` if the current color ramp is null. More...

bool	isRandomColorRamp () const
	Returns `true` if the current color ramp is random. More...

void	setAcceptLiveUpdates (const bool accept)
	Sets whether the button accepts live updates from QgsColorRampDialog. More...

void	setColorRampDialogTitle (const QString &title)
	Set the title for the color ramp dialog window. More...

void	setColorRampName (const QString &name)
	Sets the name of the current color ramp when it's available in the style manager. More...

void	setContext (const QString &context)
	Sets the context string for the color ramp button. More...

void	setDefaultColorRamp (QgsColorRamp *colorramp)
	Sets the default color ramp for the button, which is shown in the button's drop-down menu for the "default color ramp" option. More...

void	setShowGradientOnly (bool gradientonly)
	Sets whether the color ramp button only shows gradient type ramps. More...

void	setShowMenu (bool showMenu)
	Sets whether the drop-down menu should be shown for the button. More...

void	setShowNull (bool showNull)
	Sets whether a set to null (clear) option is shown in the button's drop-down menu. More...

void	setShowRandomColorRamp (bool showRandom)
	Sets whether a random colors option is shown in the button's drop-down menu. More...

bool	showGradientOnly () const
	Returns `true` if the color ramp button only shows gradient type ramps. More...

bool	showMenu () const
	Returns whether the drop-down menu is shown for the button. More...

bool	showNull () const
	Returns whether the set to null (clear) option is shown in the button's drop-down menu. More...

bool	showRandomColorRamp () const
	Returns whether random colors option is shown in the button's drop-down menu. More...

QSize	sizeHint () const override

Protected Member Functions
void	changeEvent (QEvent *e) override

bool	event (QEvent *e) override

void	mousePressEvent (QMouseEvent *e) override
	Reimplemented to detect right mouse button clicks on the color ramp button. More...

void	resizeEvent (QResizeEvent *event) override

void	showEvent (QShowEvent *e) override

Properties
bool	acceptLiveUpdates

QString	colorRampDialogTitle

QString	context

QgsColorRamp *	defaultColorRamp

bool	showMenu

Detailed Description

A cross platform button subclass for selecting color ramps.

Will open color ramp dialogs when clicked. Offers live updates to button from color ramp dialog. An attached drop-down menu allows for access to saved color ramps, as well as option to invert the current color ramp and create new ramps.

Since: QGIS 3.0

Definition at line 36 of file qgscolorrampbutton.h.

Constructor & Destructor Documentation

◆ QgsColorRampButton()

QgsColorRampButton::QgsColorRampButton	(	QWidget *	parent = `nullptr`,
		const QString &	dialogTitle = `QString()`
	)

Construct a new color ramp button.

Use parent to attach a parent QWidget to the dialog. Use dialogTitle string to define the title to show in the color ramp dialog

Definition at line 38 of file qgscolorrampbutton.cpp.

◆ ~QgsColorRampButton()

QgsColorRampButton::~QgsColorRampButton ( )

overridedefault

Member Function Documentation

◆ acceptLiveUpdates()

bool QgsColorRampButton::acceptLiveUpdates ( ) const

inline

Returns whether the button accepts live updates from QgsColorRampDialog.

Returns: true if the button will be accepted immediately when the dialog's color ramp changes

See also: setAcceptLiveUpdates

Definition at line 83 of file qgscolorrampbutton.h.

◆ changeEvent()

void QgsColorRampButton::changeEvent ( QEvent * e )

overrideprotected

Definition at line 437 of file qgscolorrampbutton.cpp.

◆ colorRamp()

QgsColorRamp * QgsColorRampButton::colorRamp ( ) const

Returns a copy of the current color ramp.

See also: setColorRamp()

Definition at line 578 of file qgscolorrampbutton.cpp.

◆ colorRampChanged

void QgsColorRampButton::colorRampChanged ( )

signal

Emitted whenever a new color ramp is set for the button.

The color ramp is always valid. In case the new color ramp is the same, no signal is emitted to avoid infinite loops.

◆ colorRampDialogTitle()

QString QgsColorRampButton::colorRampDialogTitle ( ) const

Returns the title for the color ramp dialog window.

Returns: title for the color ramp dialog

See also: setColorRampDialogTitle

Definition at line 588 of file qgscolorrampbutton.cpp.

◆ colorRampName()

QString QgsColorRampButton::colorRampName ( ) const

inline

Returns the name of the current color ramp when it's available in the style manager.

See also: setColorRampName

Definition at line 210 of file qgscolorrampbutton.h.

◆ context()

QString QgsColorRampButton::context ( ) const

inline

Returns the context string for the color ramp button.

The context string is passed to all color ramp preview icons shown in the button's drop-down menu, to (eventually) allow them to customize their display colors based on the context.

Returns: context context string for the color dialog button's color ramp preview icons

See also: setContext

Definition at line 184 of file qgscolorrampbutton.h.

◆ defaultColorRamp()

QgsColorRamp * QgsColorRampButton::defaultColorRamp ( ) const

Returns a copy of the default color ramp for the button, which is shown in the button's drop-down menu for the "default color ramp" option.

Returns: default color ramp for the button. Returns nullptr if the default color ramp option is disabled. Caller takes ownership of the returned object.

See also: setDefaultColorRamp

Definition at line 612 of file qgscolorrampbutton.cpp.

◆ event()

bool QgsColorRampButton::event ( QEvent * e )

overrideprotected

Definition at line 183 of file qgscolorrampbutton.cpp.

◆ isNull()

bool QgsColorRampButton::isNull ( ) const

Returns true if the current color ramp is null.

See also: setShowNull(); showNull()

Definition at line 632 of file qgscolorrampbutton.cpp.

◆ isRandomColorRamp()

bool QgsColorRampButton::isRandomColorRamp ( ) const

Returns true if the current color ramp is random.

See also: setShowNull(); showNull()

Definition at line 617 of file qgscolorrampbutton.cpp.

◆ mousePressEvent()

void QgsColorRampButton::mousePressEvent ( QMouseEvent * e )

overrideprotected

Reimplemented to detect right mouse button clicks on the color ramp button.

Definition at line 195 of file qgscolorrampbutton.cpp.

◆ resizeEvent()

void QgsColorRampButton::resizeEvent ( QResizeEvent * event )

overrideprotected

Definition at line 464 of file qgscolorrampbutton.cpp.

◆ setAcceptLiveUpdates()

void QgsColorRampButton::setAcceptLiveUpdates ( const bool accept )

inline

Sets whether the button accepts live updates from QgsColorRampDialog.

Live updates may cause changes that are not undoable on QColorRampDialog cancel.

Parameters

accept set to true to enable live updates

See also: acceptLiveUpdates

Definition at line 91 of file qgscolorrampbutton.h.

◆ setButtonBackground

void QgsColorRampButton::setButtonBackground ( QgsColorRamp * colorramp = nullptr )

slot

Sets the background pixmap for the button based upon current color ramp.

Parameters

colorramp Color ramp for button background. If no color ramp is specified, the button's current color ramp will be used

Definition at line 507 of file qgscolorrampbutton.cpp.

◆ setColorRamp

void QgsColorRampButton::setColorRamp ( QgsColorRamp * colorramp )

slot

Sets the current color ramp for the button.

Will emit a colorRampChanged() signal if the color ramp is different to the previous color ramp.

Parameters

colorramp New color ramp for the button. The ramp will be cloned and ownership is not transferred.

See also: setRandomColorRamp, setColorRampFromName, colorRamp

Definition at line 472 of file qgscolorrampbutton.cpp.

◆ setColorRampDialogTitle()

void QgsColorRampButton::setColorRampDialogTitle ( const QString & title )

Set the title for the color ramp dialog window.

Parameters

title Title for the color ramp dialog

See also: colorRampDialogTitle

Definition at line 583 of file qgscolorrampbutton.cpp.

◆ setColorRampFromName

void QgsColorRampButton::setColorRampFromName ( const QString & name = QString() )

slot

Sets the current color ramp for the button using a saved color ramp name.

Will emit a colorRampChanged() signal if the color ramp is different to the previous color ramp.

Parameters

name	Name of saved color ramp

See also: setColorRamp, setRandomColorRamp, colorRamp

Definition at line 486 of file qgscolorrampbutton.cpp.

◆ setColorRampName()

void QgsColorRampButton::setColorRampName ( const QString & name )

inline

Sets the name of the current color ramp when it's available in the style manager.

Parameters

name	Name of the saved color ramp

See also: colorRampName

Definition at line 204 of file qgscolorrampbutton.h.

◆ setContext()

void QgsColorRampButton::setContext ( const QString & context )

inline

Sets the context string for the color ramp button.

The context string is passed to all color ramp preview icons shown in the button's drop-down menu, to (eventually) allow them to customize their display colors based on the context.

Parameters

context context string for the color dialog button's color ramp preview icons

See also: context

Definition at line 175 of file qgscolorrampbutton.h.

◆ setDefaultColorRamp()

void QgsColorRampButton::setDefaultColorRamp ( QgsColorRamp * colorramp )

Sets the default color ramp for the button, which is shown in the button's drop-down menu for the "default color ramp" option.

Parameters

colorramp default color ramp for the button. Set to nullptr to disable the default color ramp option. The ramp will be cloned and ownership is not transferred.

See also: defaultColorRamp

Definition at line 607 of file qgscolorrampbutton.cpp.

◆ setRandomColorRamp

void QgsColorRampButton::setRandomColorRamp ( )

slot

Sets the current color ramp for the button to random colors.

Will emit a colorRampChanged() signal if the color ramp is different to the previous color ramp.

See also: setColorRamp, setColorRampFromName, colorRamp

Definition at line 498 of file qgscolorrampbutton.cpp.

◆ setShowGradientOnly()

void QgsColorRampButton::setShowGradientOnly ( bool gradientonly )

inline

Sets whether the color ramp button only shows gradient type ramps.

Parameters

gradientonly set to true to show only gradient type ramps

See also: showGradientOnly

Definition at line 191 of file qgscolorrampbutton.h.

◆ setShowMenu()

void QgsColorRampButton::setShowMenu ( bool showMenu )

Sets whether the drop-down menu should be shown for the button.

The default behavior is to show the menu.

Parameters

showMenu set to false to hide the drop-down menu

See also: showMenu

Definition at line 593 of file qgscolorrampbutton.cpp.

◆ setShowNull()

void QgsColorRampButton::setShowNull ( bool showNull )

Sets whether a set to null (clear) option is shown in the button's drop-down menu.

Parameters

showNull set to true to show a null option

See also: showNull(); isNull()

Definition at line 622 of file qgscolorrampbutton.cpp.

◆ setShowRandomColorRamp()

void QgsColorRampButton::setShowRandomColorRamp ( bool showRandom )

inline

Sets whether a random colors option is shown in the button's drop-down menu.

Parameters

showRandom set to true to show a random colors option

See also: showRandomColorRamp()

Definition at line 131 of file qgscolorrampbutton.h.

◆ setToDefaultColorRamp

void QgsColorRampButton::setToDefaultColorRamp ( )

slot

Sets color ramp to the button's default color ramp, if set.

See also: setDefaultColorRamp; defaultColorRamp; setToNull()

Definition at line 168 of file qgscolorrampbutton.cpp.

◆ setToNull

void QgsColorRampButton::setToNull ( )

slot

Sets color ramp to null.

See also: setToDefaultColorRamp()

Definition at line 178 of file qgscolorrampbutton.cpp.

◆ showEvent()

void QgsColorRampButton::showEvent ( QShowEvent * e )

overrideprotected

Definition at line 458 of file qgscolorrampbutton.cpp.

◆ showGradientOnly()

bool QgsColorRampButton::showGradientOnly ( ) const

inline

Returns true if the color ramp button only shows gradient type ramps.

See also: setShowGradientOnly

Definition at line 197 of file qgscolorrampbutton.h.

◆ showMenu()

bool QgsColorRampButton::showMenu ( ) const

Returns whether the drop-down menu is shown for the button.

Returns: true if drop-down menu is shown

See also: setShowMenu

Definition at line 602 of file qgscolorrampbutton.cpp.

◆ showNull()

bool QgsColorRampButton::showNull ( ) const

Returns whether the set to null (clear) option is shown in the button's drop-down menu.

See also: setShowNull(); isNull()

Definition at line 627 of file qgscolorrampbutton.cpp.

◆ showRandomColorRamp()

bool QgsColorRampButton::showRandomColorRamp ( ) const

inline

Returns whether random colors option is shown in the button's drop-down menu.

See also: setShowRandomColorRamp()

Definition at line 137 of file qgscolorrampbutton.h.

◆ sizeHint()

QSize QgsColorRampButton::sizeHint ( ) const

override

Definition at line 61 of file qgscolorrampbutton.cpp.

Property Documentation

◆ acceptLiveUpdates

bool QgsColorRampButton::acceptLiveUpdates

readwrite

Definition at line 36 of file qgscolorrampbutton.h.

◆ colorRampDialogTitle

QString QgsColorRampButton::colorRampDialogTitle

readwrite

Definition at line 36 of file qgscolorrampbutton.h.

◆ context

QString QgsColorRampButton::context

readwrite

Definition at line 36 of file qgscolorrampbutton.h.

◆ defaultColorRamp

QgsColorRamp * QgsColorRampButton::defaultColorRamp

readwrite

Definition at line 36 of file qgscolorrampbutton.h.

◆ showMenu

bool QgsColorRampButton::showMenu

readwrite

Definition at line 36 of file qgscolorrampbutton.h.

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

/build/qgis-3.28.0+99sid/src/gui/qgscolorrampbutton.h
/build/qgis-3.28.0+99sid/src/gui/qgscolorrampbutton.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ QgsColorRampButton()

◆ ~QgsColorRampButton()

Member Function Documentation

◆ acceptLiveUpdates()

◆ changeEvent()

◆ colorRamp()

◆ colorRampChanged

◆ colorRampDialogTitle()

◆ colorRampName()

◆ context()

◆ defaultColorRamp()

◆ event()

◆ isNull()

◆ isRandomColorRamp()

◆ mousePressEvent()

◆ resizeEvent()

◆ setAcceptLiveUpdates()

◆ setButtonBackground

◆ setColorRamp

◆ setColorRampDialogTitle()

◆ setColorRampFromName

◆ setColorRampName()

◆ setContext()

◆ setDefaultColorRamp()

◆ setRandomColorRamp

◆ setShowGradientOnly()

◆ setShowMenu()

◆ setShowNull()

◆ setShowRandomColorRamp()

◆ setToDefaultColorRamp

◆ setToNull

◆ showEvent()

◆ showGradientOnly()

◆ showMenu()

◆ showNull()

◆ showRandomColorRamp()

◆ sizeHint()

Property Documentation

◆ acceptLiveUpdates

◆ colorRampDialogTitle

◆ context

◆ defaultColorRamp

◆ showMenu