QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
Public Slots | Public Member Functions | Protected Member Functions | List of all members
QgsColorBox Class Reference

A color box widget. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorBox:
Inheritance graph
[legend]

Public Slots

void setColor (const QColor &color, bool emitSignals=false) override
 
- Public Slots inherited from QgsColorWidget
virtual void setColor (const QColor &color, bool emitSignals=false)
 Sets the color for the widget. More...
 
virtual void setComponentValue (int value)
 Alters the widget's color by setting the value for the widget's color component. More...
 

Public Member Functions

 QgsColorBox (QWidget *parent=nullptr, ColorComponent component=Value)
 Construct a new color box widget. More...
 
 ~QgsColorBox () override
 
void paintEvent (QPaintEvent *event) override
 
void setComponent (ColorComponent component) override
 Sets the color component which the widget controls. More...
 
QSize sizeHint () const override
 
- 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 mouseMoveEvent (QMouseEvent *event) override
 
void mousePressEvent (QMouseEvent *event) override
 
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 Types inherited from QgsColorWidget
enum  ColorComponent {
  Multiple = 0, Red, Green, Blue,
  Hue, Saturation, Value, Alpha
}
 Specifies the color component which the widget alters. 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 color box widget.

This widget consists of a two dimensional rectangle filled with color variations, where a different color component varies along both the horizontal and vertical axis.

Since
QGIS 2.5

Definition at line 383 of file qgscolorwidgets.h.

Constructor & Destructor Documentation

◆ QgsColorBox()

QgsColorBox::QgsColorBox ( QWidget *  parent = nullptr,
ColorComponent  component = Value 
)

Construct a new color box widget.

Parameters
parentparent QWidget for the widget
componentconstant color component for the widget. The color components which vary along the horizontal and vertical axis are automatically assigned based on this constant color component.

Definition at line 741 of file qgscolorwidgets.cpp.

◆ ~QgsColorBox()

QgsColorBox::~QgsColorBox ( )
override

Definition at line 750 of file qgscolorwidgets.cpp.

Member Function Documentation

◆ mouseMoveEvent()

void QgsColorBox::mouseMoveEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 847 of file qgscolorwidgets.cpp.

◆ mousePressEvent()

void QgsColorBox::mousePressEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 853 of file qgscolorwidgets.cpp.

◆ paintEvent()

void QgsColorBox::paintEvent ( QPaintEvent *  event)
override

Definition at line 765 of file qgscolorwidgets.cpp.

◆ resizeEvent()

void QgsColorBox::resizeEvent ( QResizeEvent *  event)
overrideprotected

Definition at line 839 of file qgscolorwidgets.cpp.

◆ setColor

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

Definition at line 809 of file qgscolorwidgets.cpp.

◆ setComponent()

void QgsColorBox::setComponent ( const QgsColorWidget::ColorComponent  component)
overridevirtual

Sets the color component which the widget controls.

Parameters
componentcolor component for widget
See also
component

Reimplemented from QgsColorWidget.

Definition at line 799 of file qgscolorwidgets.cpp.

◆ sizeHint()

QSize QgsColorBox::sizeHint ( ) const
override

Definition at line 755 of file qgscolorwidgets.cpp.


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