QgsGradientStopEditor Class Reference

An interactive editor for previewing a gradient color ramp and modifying the position of color stops along the gradient. More...

#include <qgsgradientstopeditor.h>

Inheritance diagram for QgsGradientStopEditor:

Public Slots
void	deleteSelectedStop ()
	Deletes the current selected stop.
void	setColor1 (const QColor &color)
	Sets the color for the first stop.
void	setColor2 (const QColor &color)
	Sets the color for the last stop.
void	setSelectedStopColor (const QColor &color)
	Sets the color for the current selected stop.
void	setSelectedStopColorSpec (QColor::Spec spec)
	Sets the color spec for the current selected stop.
void	setSelectedStopDetails (const QColor &color, double offset)
	Sets the color and offset for the current selected stop.
void	setSelectedStopDirection (Qgis::AngularDirection direction)
	Sets the hue angular direction for the current selected stop.
void	setSelectedStopOffset (double offset)
	Sets the offset for the current selected stop.

Signals
void	changed ()
	Emitted when the gradient ramp is changed by a user.
void	selectedStopChanged (const QgsGradientStop &stop)
	Emitted when the current selected stop changes.

Public Member Functions
	QgsGradientStopEditor (QWidget *parent=nullptr, QgsGradientColorRamp *ramp=nullptr)
	Constructor for QgsGradientStopEditor.
QgsGradientColorRamp	gradientRamp () const
	Returns the current ramp created by the editor.
void	paintEvent (QPaintEvent *event) override
QgsGradientStop	selectedStop () const
	Returns details about the currently selected stop.
void	selectStop (int index)
	Sets the currently selected stop.
void	setGradientRamp (const QgsGradientColorRamp &ramp)
	Sets the current ramp shown in the editor.
QSize	sizeHint () const override

Protected Member Functions
void	dragEnterEvent (QDragEnterEvent *e) override
void	dropEvent (QDropEvent *e) override
void	keyPressEvent (QKeyEvent *event) override
void	mouseDoubleClickEvent (QMouseEvent *event) override
void	mouseMoveEvent (QMouseEvent *event) override
void	mousePressEvent (QMouseEvent *event) override

Detailed Description

An interactive editor for previewing a gradient color ramp and modifying the position of color stops along the gradient.

Since

QGIS 2.16

Definition at line 33 of file qgsgradientstopeditor.h.

Constructor & Destructor Documentation

QgsGradientStopEditor()

QgsGradientStopEditor::QgsGradientStopEditor	(	QWidget *	parent = nullptr,
		QgsGradientColorRamp *	ramp = nullptr
	)

Constructor for QgsGradientStopEditor.

Parameters

parent	parent widget
ramp	optional initial gradient ramp

Definition at line 36 of file qgsgradientstopeditor.cpp.

Member Function Documentation

changed

void QgsGradientStopEditor::changed ( )

signal

Emitted when the gradient ramp is changed by a user.

deleteSelectedStop

void QgsGradientStopEditor::deleteSelectedStop ( )

slot

Deletes the current selected stop.

This slot has no effect if either the first or last stop is selected, as they cannot be deleted.

Definition at line 267 of file qgsgradientstopeditor.cpp.

dragEnterEvent()

void QgsGradientStopEditor::dragEnterEvent ( QDragEnterEvent *  e )

overrideprotected

Definition at line 484 of file qgsgradientstopeditor.cpp.

dropEvent()

void QgsGradientStopEditor::dropEvent ( QDropEvent *  e )

overrideprotected

Definition at line 497 of file qgsgradientstopeditor.cpp.

gradientRamp()

QgsGradientColorRamp QgsGradientStopEditor::gradientRamp ( ) const

inline

Returns the current ramp created by the editor.

See also

setGradientRamp()

Definition at line 57 of file qgsgradientstopeditor.h.

keyPressEvent()

void QgsGradientStopEditor::keyPressEvent ( QKeyEvent *  event )

overrideprotected

Definition at line 388 of file qgsgradientstopeditor.cpp.

mouseDoubleClickEvent()

void QgsGradientStopEditor::mouseDoubleClickEvent ( QMouseEvent *  event )

overrideprotected

Definition at line 373 of file qgsgradientstopeditor.cpp.

mouseMoveEvent()

void QgsGradientStopEditor::mouseMoveEvent ( QMouseEvent *  event )

overrideprotected

Definition at line 298 of file qgsgradientstopeditor.cpp.

mousePressEvent()

void QgsGradientStopEditor::mousePressEvent ( QMouseEvent *  event )

overrideprotected

Definition at line 358 of file qgsgradientstopeditor.cpp.

paintEvent()

void QgsGradientStopEditor::paintEvent ( QPaintEvent *  event )

override

Definition at line 79 of file qgsgradientstopeditor.cpp.

selectedStop()

QgsGradientStop QgsGradientStopEditor::selectedStop

(

)

const

Returns details about the currently selected stop.

See also

selectStop()

Definition at line 163 of file qgsgradientstopeditor.cpp.

selectedStopChanged

void QgsGradientStopEditor::selectedStopChanged ( const QgsGradientStop &  stop )

signal

Emitted when the current selected stop changes.

Parameters

stop	details about newly selected stop

selectStop()

void QgsGradientStopEditor::selectStop

(

int

index

)

Sets the currently selected stop.

Parameters

index

index of stop, where 0 corresponds to the first stop

See also

selectedStop()

Definition at line 140 of file qgsgradientstopeditor.cpp.

setColor1

void QgsGradientStopEditor::setColor1 ( const QColor &  color )

slot

Sets the color for the first stop.

Parameters

color

new stop color

See also

setColor2()

setSelectedStopColor()

Definition at line 284 of file qgsgradientstopeditor.cpp.

setColor2

void QgsGradientStopEditor::setColor2 ( const QColor &  color )

slot

Sets the color for the last stop.

Parameters

color

new stop color

See also

setColor1()

setSelectedStopColor()

Definition at line 291 of file qgsgradientstopeditor.cpp.

setGradientRamp()

void QgsGradientStopEditor::setGradientRamp

(

const QgsGradientColorRamp &

ramp

)

Sets the current ramp shown in the editor.

Parameters

ramp	color ramp

See also

gradientRamp()

Definition at line 64 of file qgsgradientstopeditor.cpp.

setSelectedStopColor

void QgsGradientStopEditor::setSelectedStopColor ( const QColor &  color )

slot

Sets the color for the current selected stop.

Parameters

color

new stop color

See also

setSelectedStopOffset()

setSelectedStopDetails()

setColor1()

setColor2()

Definition at line 182 of file qgsgradientstopeditor.cpp.

setSelectedStopColorSpec

void QgsGradientStopEditor::setSelectedStopColorSpec ( QColor::Spec  spec )

slot

Sets the color spec for the current selected stop.

Since

QGIS 3.24

Definition at line 212 of file qgsgradientstopeditor.cpp.

setSelectedStopDetails

void QgsGradientStopEditor::setSelectedStopDetails ( const QColor &  color, double  offset  )

slot

Sets the color and offset for the current selected stop.

Parameters

color	new stop color
offset	new stop offset

See also

setSelectedStopColor()

setSelectedStopOffset()

Definition at line 246 of file qgsgradientstopeditor.cpp.

setSelectedStopDirection

void QgsGradientStopEditor::setSelectedStopDirection ( Qgis::AngularDirection  direction )

slot

Sets the hue angular direction for the current selected stop.

Since

QGIS 3.24

Definition at line 229 of file qgsgradientstopeditor.cpp.

setSelectedStopOffset

void QgsGradientStopEditor::setSelectedStopOffset ( double  offset )

slot

Sets the offset for the current selected stop.

This slot has no effect if either the first or last stop is selected, as they cannot be repositioned.

Parameters

offset

new stop offset

See also

setSelectedStopColor()

setSelectedStopDetails()

Definition at line 201 of file qgsgradientstopeditor.cpp.

sizeHint()

QSize QgsGradientStopEditor::sizeHint ( ) const

override

Definition at line 73 of file qgsgradientstopeditor.cpp.

---

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

• /build/qgis-3.34.0+99sid/src/gui/qgsgradientstopeditor.h
• /build/qgis-3.34.0+99sid/src/gui/qgsgradientstopeditor.cpp