A color ramp widget. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorRampWidget:

[legend]

Public Types
enum	Orientation { Horizontal = 0 , Vertical }
	Specifies the orientation of a color ramp. More...

Public Types inherited from QgsColorWidget
enum	ColorComponent { Multiple = 0 , Red , Green , Blue , Hue , Saturation , Value , Alpha , Cyan , Magenta , Yellow , Black }
	Specifies the color component which the widget alters. More...

enum class	ComponentUnit { Scaled0to255 , Percent , Degree }
	Specified the color component unit. More...

Signals
Q_DECL_DEPRECATED void	valueChanged (int value)
	Emitted when the widget's color component value changes.

void	valueChangedF (float value)
	Emitted when the widget's color component value changes.

Signals inherited from QgsColorWidget
void	colorChanged (const QColor &color)
	Emitted when the widget's color changes.

void	hovered ()
	Emitted when mouse hovers over widget.

Public Member Functions
	QgsColorRampWidget (QWidget *parent=nullptr, ColorComponent component=QgsColorWidget::Red, Orientation orientation=QgsColorRampWidget::Horizontal)
	Construct a new color ramp widget.

int	interiorMargin () const
	Fetches the margin between the edge of the widget and the ramp.

Orientation	orientation () const
	Fetches the orientation for the color ramp.

void	paintEvent (QPaintEvent *event) override

void	setInteriorMargin (int margin)
	Sets the margin between the edge of the widget and the ramp.

void	setMarkerSize (int markerSize)
	Sets the size for drawing the triangular markers on the ramp.

void	setOrientation (Orientation orientation)
	Sets the orientation for the color ramp.

void	setShowFrame (bool showFrame)
	Sets whether the ramp should be drawn within a frame.

bool	showFrame () const
	Fetches whether the ramp is drawn within a frame.

QSize	sizeHint () const override

Public Member Functions inherited from QgsColorWidget
	QgsColorWidget (QWidget *parent=nullptr, ColorComponent component=Multiple)
	Construct a new color widget.

QColor	color () const
	Returns the current color for the widget.

ColorComponent	component () const
	Returns the color component which the widget controls.

Q_DECL_DEPRECATED int	componentValue () const
	Returns the current value of the widget's color component.

float	componentValueF () const
	Returns the current value of the widget's color component.

Protected Member Functions
void	keyPressEvent (QKeyEvent *event) override

void	mouseMoveEvent (QMouseEvent *event) override

void	mousePressEvent (QMouseEvent *event) override

void	mouseReleaseEvent (QMouseEvent *event) override

void	wheelEvent (QWheelEvent *event) override

Protected Member Functions inherited from QgsColorWidget
QColor::Spec	colorSpec () const
	Returns color widget type of color, either RGB, HSV, CMYK, or Invalid if this component value is Multiple or Alpha.

int	componentRange () const
	Returns the range of valid values for the color widget's component.

Q_DECL_DEPRECATED int	componentValue (ColorComponent component) const
	Returns the value of a component of the widget's current color.

float	componentValueF (ColorComponent component) const
	Returns the value of a component of the widget's current color.

void	dragEnterEvent (QDragEnterEvent *e) override

void	dropEvent (QDropEvent *e) override

Q_DECL_DEPRECATED int	hue () const
	Returns the hue for the widget.

float	hueF () const
	Returns the hue for the widget.

void	mouseMoveEvent (QMouseEvent *e) override

void	mousePressEvent (QMouseEvent *e) override

void	mouseReleaseEvent (QMouseEvent *e) override

Friends
class	TestQgsCompoundColorWidget

Additional Inherited Members
Public Slots inherited from QgsColorWidget
virtual void	setColor (const QColor &color, bool emitSignals=false)
	Sets the color for the widget.

virtual void	setComponent (QgsColorWidget::ColorComponent component)
	Sets the color component which the widget controls.

virtual Q_DECL_DEPRECATED void	setComponentValue (int value)
	Alters the widget's color by setting the value for the widget's color component.

virtual void	setComponentValueF (float value)
	Alters the widget's color by setting the value for the widget's color component.

Static Public Member Functions inherited from QgsColorWidget
static ComponentUnit	componentUnit (ColorComponent component)
	Returns color component unit.

static QPixmap	createDragIcon (const QColor &color)
	Create an icon for dragging colors.

Static Protected Member Functions inherited from QgsColorWidget
static Q_DECL_DEPRECATED void	alterColor (QColor &color, QgsColorWidget::ColorComponent component, int newValue)
	Alters a color by modifying the value of a specific color component.

static void	alterColorF (QColor &color, QgsColorWidget::ColorComponent component, float newValue)
	Alters a color by modifying the value of a specific color component.

static QColor::Spec	colorSpec (QgsColorWidget::ColorComponent component)
	Returns component type of color, either RGB, HSV, CMYK, or Invalid if component value is Multiple or Alpha.

static int	componentRange (ColorComponent component)
	Returns the range of valid values a color component.

static const QPixmap &	transparentBackground ()
	Generates a checkboard pattern pixmap for use as a background to transparent colors.

Protected Attributes inherited from QgsColorWidget
ColorComponent	mComponent

QColor	mCurrentColor

float	mExplicitHue = 0
	QColor wipes the hue information when it is ambiguous (e.g., for saturation = 0).

Detailed Description

A color ramp widget.

This widget consists of an interactive box filled with a color which varies along its length by a single color component (e.g., varying saturation from 0 to 100%).

Definition at line 567 of file qgscolorwidgets.h.

Member Enumeration Documentation

◆ Orientation

enum QgsColorRampWidget::Orientation

Specifies the orientation of a color ramp.

Enumerator
Horizontal	Horizontal ramp.
Vertical	Vertical ramp.

Definition at line 576 of file qgscolorwidgets.h.

Constructor & Destructor Documentation

◆ QgsColorRampWidget()

QgsColorRampWidget::QgsColorRampWidget	(	QWidget *	parent = `nullptr`,
		const QgsColorWidget::ColorComponent	component = `QgsColorWidget::Red`,
		Orientation	orientation = `QgsColorRampWidget::Horizontal`
	)

Construct a new color ramp widget.

Parameters

parent	parent QWidget for the widget
component	color component which varies along the ramp
orientation	orientation for widget

Definition at line 1116 of file qgscolorwidgets.cpp.

Member Function Documentation

◆ interiorMargin()

int QgsColorRampWidget::interiorMargin ( ) const

inline

Fetches the margin between the edge of the widget and the ramp.

Returns: margin around the ramp

See also: setInteriorMargin

Definition at line 621 of file qgscolorwidgets.h.

◆ keyPressEvent()

void QgsColorRampWidget::keyPressEvent ( QKeyEvent * event )

overrideprotected

Definition at line 1370 of file qgscolorwidgets.cpp.

◆ mouseMoveEvent()

void QgsColorRampWidget::mouseMoveEvent ( QMouseEvent * event )

overrideprotected

Definition at line 1309 of file qgscolorwidgets.cpp.

◆ mousePressEvent()

void QgsColorRampWidget::mousePressEvent ( QMouseEvent * event )

overrideprotected

Definition at line 1345 of file qgscolorwidgets.cpp.

◆ mouseReleaseEvent()

void QgsColorRampWidget::mouseReleaseEvent ( QMouseEvent * event )

overrideprotected

Definition at line 1358 of file qgscolorwidgets.cpp.

◆ orientation()

Orientation QgsColorRampWidget::orientation ( ) const

inline

Fetches the orientation for the color ramp.

Returns: orientation for the ramp

See also: setOrientation

Definition at line 607 of file qgscolorwidgets.h.

◆ paintEvent()

void QgsColorRampWidget::paintEvent ( QPaintEvent * event )

override

Definition at line 1142 of file qgscolorwidgets.cpp.

◆ setInteriorMargin()

void QgsColorRampWidget::setInteriorMargin ( int margin )

Sets the margin between the edge of the widget and the ramp.

Parameters

margin margin around the ramp

See also: interiorMargin

Definition at line 1281 of file qgscolorwidgets.cpp.

◆ setMarkerSize()

void QgsColorRampWidget::setMarkerSize ( int markerSize )

Sets the size for drawing the triangular markers on the ramp.

Parameters

markerSize marker size in pixels

Definition at line 1301 of file qgscolorwidgets.cpp.

◆ setOrientation()

void QgsColorRampWidget::setOrientation ( const QgsColorRampWidget::Orientation orientation )

Sets the orientation for the color ramp.

Parameters

orientation new orientation for the ramp

See also: orientation

Definition at line 1265 of file qgscolorwidgets.cpp.

◆ setShowFrame()

void QgsColorRampWidget::setShowFrame ( bool showFrame )

Sets whether the ramp should be drawn within a frame.

Parameters

showFrame set to true to draw a frame around the ramp

See also: showFrame

Definition at line 1291 of file qgscolorwidgets.cpp.

◆ showFrame()

bool QgsColorRampWidget::showFrame ( ) const

inline

Fetches whether the ramp is drawn within a frame.

Returns: true if a frame is drawn around the ramp

See also: setShowFrame

Definition at line 635 of file qgscolorwidgets.h.

◆ sizeHint()

QSize QgsColorRampWidget::sizeHint ( ) const

override

Definition at line 1128 of file qgscolorwidgets.cpp.

◆ valueChanged

Q_DECL_DEPRECATED void QgsColorRampWidget::valueChanged ( int value )

signal

Emitted when the widget's color component value changes.

Parameters

value new value of color component in the range between 0 and the value returned by componentRange()

Deprecated:: QGIS 3.40. Use valueChangedF() instead.

◆ valueChangedF

void QgsColorRampWidget::valueChangedF ( float value )

signal

Emitted when the widget's color component value changes.

Parameters

value new value of color component in the range 0.0-1.0

Since: QGIS 3.40

◆ wheelEvent()

void QgsColorRampWidget::wheelEvent ( QWheelEvent * event )

overrideprotected

Definition at line 1319 of file qgscolorwidgets.cpp.

Friends And Related Symbol Documentation

◆ TestQgsCompoundColorWidget

friend class TestQgsCompoundColorWidget

friend

Definition at line 692 of file qgscolorwidgets.h.

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

/build/qgis-3.40.0+99sid/src/gui/qgscolorwidgets.h
/build/qgis-3.40.0+99sid/src/gui/qgscolorwidgets.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Orientation

Constructor & Destructor Documentation

◆ QgsColorRampWidget()

Member Function Documentation

◆ interiorMargin()

◆ keyPressEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ orientation()

◆ paintEvent()

◆ setInteriorMargin()

◆ setMarkerSize()

◆ setOrientation()

◆ setShowFrame()

◆ showFrame()

◆ sizeHint()

◆ valueChanged

◆ valueChangedF

◆ wheelEvent()

Friends And Related Symbol Documentation

◆ TestQgsCompoundColorWidget