QgsColorSliderWidget Class Reference

A composite horizontal color ramp widget and associated spinbox for manual value entry. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorSliderWidget:

Public Member Functions
	QgsColorSliderWidget (QWidget *parent=nullptr, ColorComponent component=QgsColorWidget::Red)
	Construct a new color slider widget.
void	setColor (const QColor &color, bool emitSignals=false) override
	Sets the color for the widget.
void	setComponent (ColorComponent component) override
	Sets the color component which the widget controls.
void	setComponentValueF (float value) override
	Alters the widget's color by setting the value for the widget's color component.
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.

Friends
class	TestQgsCompoundColorWidget

Additional Inherited Members
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...
Public Slots inherited from QgsColorWidget
virtual Q_DECL_DEPRECATED void	setComponentValue (int value)
	Alters the widget's color by setting the value for the widget's color component.
Signals inherited from QgsColorWidget
void	colorChanged (const QColor &color)
	Emitted when the widget's color changes.
void	hovered ()
	Emitted when mouse hovers over widget.
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.
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
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 composite horizontal color ramp widget and associated spinbox for manual value entry.

Definition at line 702 of file qgscolorwidgets.h.

Constructor & Destructor Documentation

QgsColorSliderWidget()

QgsColorSliderWidget::QgsColorSliderWidget	(	QWidget *	parent = nullptr,
		ColorComponent	component = QgsColorWidget::Red
	)

Construct a new color slider widget.

Parameters

parent	parent QWidget for the widget
component	color component which is controlled by the slider

Definition at line 1455 of file qgscolorwidgets.cpp.

Member Function Documentation

setColor()

void QgsColorSliderWidget::setColor ( const QColor &  color, bool  emitSignals = false  )

overridevirtual

Sets the color for the widget.

Parameters

color	widget color
emitSignals	set to true to emit the colorChanged signal after setting color

See also

color

Reimplemented from QgsColorWidget.

Definition at line 1516 of file qgscolorwidgets.cpp.

setComponent()

void QgsColorSliderWidget::setComponent ( const QgsColorWidget::ColorComponent  component )

overridevirtual

Sets the color component which the widget controls.

Parameters

component

color component for widget

See also

component

Reimplemented from QgsColorWidget.

Definition at line 1483 of file qgscolorwidgets.cpp.

setComponentValueF()

void QgsColorSliderWidget::setComponentValueF ( float  value )

overridevirtual

Alters the widget's color by setting the value for the widget's color component.

Parameters

value

value for widget's color component in the range 0.0-1.0. This value is automatically clipped to the range 0.0-1.0.

See also

componentValue

setComponent

Note

this method has no effect if the widget is set to the QgsColorWidget::Multiple component

Since

QGIS 3.40

Reimplemented from QgsColorWidget.

Definition at line 1505 of file qgscolorwidgets.cpp.

Friends And Related Symbol Documentation

TestQgsCompoundColorWidget

friend class TestQgsCompoundColorWidget

friend

Definition at line 761 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