QgsColorTextWidget Class Reference

A line edit widget which displays colors as text and accepts string representations of colors. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorTextWidget:

Public Types
enum	ColorTextFormat { HexRgb = 0 , HexRgbA , Rgb , Rgba }
	Specifies the display format for a color. 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...

Public Member Functions
	QgsColorTextWidget (QWidget *parent=nullptr)
	Construct a new color line edit widget.
void	setAllowOpacity (bool allowOpacity)
	Sets whether opacity modification (transparency) is permitted.
void	setColor (const QColor &color, bool emitSignals=false) override
	Sets the color for the widget.
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	resizeEvent (QResizeEvent *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

Additional Inherited Members
Public Slots inherited from QgsColorWidget
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.
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.
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 line edit widget which displays colors as text and accepts string representations of colors.

Definition at line 753 of file qgscolorwidgets.h.

Member Enumeration Documentation

ColorTextFormat

enum QgsColorTextWidget::ColorTextFormat

Specifies the display format for a color.

Enumerator
HexRgb	#RRGGBB in hexadecimal
HexRgbA	#RRGGBBAA in hexadecimal, with alpha
Rgb	Rgb( r, g, b ) format.
Rgba	Rgba( r, g, b, a ) format, with alpha.

Definition at line 761 of file qgscolorwidgets.h.

Constructor & Destructor Documentation

QgsColorTextWidget()

QgsColorTextWidget::QgsColorTextWidget

(

QWidget *

parent = nullptr

)

Construct a new color line edit widget.

Parameters

parent

parent QWidget for the widget

Definition at line 1565 of file qgscolorwidgets.cpp.

Member Function Documentation

resizeEvent()

void QgsColorTextWidget::resizeEvent ( QResizeEvent *  event )

overrideprotected

Definition at line 1603 of file qgscolorwidgets.cpp.

setAllowOpacity()

void QgsColorTextWidget::setAllowOpacity

(

bool

allowOpacity

)

Sets whether opacity modification (transparency) is permitted.

Defaults to true.

Parameters

allowOpacity

set to false to disable opacity modification

Definition at line 1703 of file qgscolorwidgets.cpp.

setColor()

void QgsColorTextWidget::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 1597 of file qgscolorwidgets.cpp.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgscolorwidgets.h
• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgscolorwidgets.cpp