QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
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.
 
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.
 

Public Member Functions

 QgsColorBox (QWidget *parent=nullptr, ColorComponent component=Value)
 Construct a new color box widget.
 
 ~QgsColorBox () override
 
void paintEvent (QPaintEvent *event) override
 
void setComponent (ColorComponent component) override
 Sets the color component which the widget controls.
 
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 mouseMoveEvent (QMouseEvent *event) override
 
void mousePressEvent (QMouseEvent *event) override
 
void mouseReleaseEvent (QMouseEvent *event) override
 
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 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 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 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.

Definition at line 469 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 853 of file qgscolorwidgets.cpp.

◆ ~QgsColorBox()

QgsColorBox::~QgsColorBox ( )
override

Definition at line 862 of file qgscolorwidgets.cpp.

Member Function Documentation

◆ mouseMoveEvent()

void QgsColorBox::mouseMoveEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 947 of file qgscolorwidgets.cpp.

◆ mousePressEvent()

void QgsColorBox::mousePressEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 956 of file qgscolorwidgets.cpp.

◆ mouseReleaseEvent()

void QgsColorBox::mouseReleaseEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 969 of file qgscolorwidgets.cpp.

◆ paintEvent()

void QgsColorBox::paintEvent ( QPaintEvent *  event)
override

Definition at line 873 of file qgscolorwidgets.cpp.

◆ resizeEvent()

void QgsColorBox::resizeEvent ( QResizeEvent *  event)
overrideprotected

Definition at line 939 of file qgscolorwidgets.cpp.

◆ setColor

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

Definition at line 920 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 910 of file qgscolorwidgets.cpp.

◆ sizeHint()

QSize QgsColorBox::sizeHint ( ) const
override

Definition at line 867 of file qgscolorwidgets.cpp.


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