QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Types | Public Member Functions | Protected Member Functions | List of all members
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:
Inheritance graph
[legend]

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
}
 Specifies the color component which the widget alters. More...
 

Public Member Functions

 QgsColorTextWidget (QWidget *parent=nullptr)
 Construct a new color line edit widget. More...
 
void setAllowOpacity (bool allowOpacity)
 Sets whether opacity modification (transparency) is permitted. More...
 
void setColor (const QColor &color, bool emitSignals=false) override
 Sets the color for the widget. More...
 
- Public Member Functions inherited from QgsColorWidget
 QgsColorWidget (QWidget *parent=nullptr, ColorComponent component=Multiple)
 Construct a new color widget. More...
 
QColor color () const
 Returns the current color for the widget. More...
 
ColorComponent component () const
 Returns the color component which the widget controls. More...
 
int componentValue () const
 Returns the current value of the widget's color component. More...
 

Protected Member Functions

void resizeEvent (QResizeEvent *event) override
 
- Protected Member Functions inherited from QgsColorWidget
void alterColor (QColor &color, QgsColorWidget::ColorComponent component, int newValue) const
 Alters a color by modifying the value of a specific color component. More...
 
int componentRange () const
 Returns the range of valid values for the color widget's component. More...
 
int componentRange (ColorComponent component) const
 Returns the range of valid values a color component. More...
 
int componentValue (ColorComponent component) const
 Returns the value of a component of the widget's current color. More...
 
void dragEnterEvent (QDragEnterEvent *e) override
 
void dropEvent (QDropEvent *e) override
 
int hue () const
 Returns the hue for the widget. More...
 
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 setColor (const QColor &color, bool emitSignals=false)
 Sets the color for the widget. More...
 
virtual void setComponent (QgsColorWidget::ColorComponent component)
 Sets the color component which the widget controls. More...
 
virtual void setComponentValue (int value)
 Alters the widget's color by setting the value for the widget's color component. More...
 
- Signals inherited from QgsColorWidget
void colorChanged (const QColor &color)
 Emitted when the widget's color changes. More...
 
void hovered ()
 Emitted when mouse hovers over widget. More...
 
- Static Public Member Functions inherited from QgsColorWidget
static QPixmap createDragIcon (const QColor &color)
 Create an icon for dragging colors. More...
 
- Static Protected Member Functions inherited from QgsColorWidget
static const QPixmap & transparentBackground ()
 Generates a checkboard pattern pixmap for use as a background to transparent colors. More...
 
- Protected Attributes inherited from QgsColorWidget
ColorComponent mComponent
 
QColor mCurrentColor
 
int mExplicitHue = 0
 QColor wipes the hue information when it is ambiguous (e.g., for saturation = 0). More...
 

Detailed Description

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

Definition at line 673 of file qgscolorwidgets.h.

Member Enumeration Documentation

◆ 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 682 of file qgscolorwidgets.h.

Constructor & Destructor Documentation

◆ QgsColorTextWidget()

QgsColorTextWidget::QgsColorTextWidget ( QWidget *  parent = nullptr)

Construct a new color line edit widget.

Parameters
parentparent QWidget for the widget

Definition at line 1479 of file qgscolorwidgets.cpp.

Member Function Documentation

◆ resizeEvent()

void QgsColorTextWidget::resizeEvent ( QResizeEvent *  event)
overrideprotected

Definition at line 1517 of file qgscolorwidgets.cpp.

◆ setAllowOpacity()

void QgsColorTextWidget::setAllowOpacity ( bool  allowOpacity)

Sets whether opacity modification (transparency) is permitted.

Defaults to true.

Parameters
allowOpacityset to false to disable opacity modification

Definition at line 1618 of file qgscolorwidgets.cpp.

◆ setColor()

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

Sets the color for the widget.

Parameters
colorwidget color
emitSignalsset to true to emit the colorChanged signal after setting color
See also
color

Reimplemented from QgsColorWidget.

Definition at line 1511 of file qgscolorwidgets.cpp.


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