QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Public Slots | Public Member Functions | Protected Member Functions | List of all members
QgsColorWheel Class Reference

A color wheel widget. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorWheel:
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 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...
 

Public Member Functions

 QgsColorWheel (QWidget *parent=nullptr)
 Constructs a new color wheel widget. More...
 
 ~QgsColorWheel () override
 
void paintEvent (QPaintEvent *event) override
 
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 mouseReleaseEvent (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 wheel widget.

This widget consists of an outer ring which allows for hue selection, and an inner rotating triangle which allows for saturation and value selection.

Since
QGIS 2.5

Definition at line 289 of file qgscolorwidgets.h.

Constructor & Destructor Documentation

◆ QgsColorWheel()

QgsColorWheel::QgsColorWheel ( QWidget *  parent = nullptr)

Constructs a new color wheel widget.

Parameters
parentparent QWidget for the widget

Definition at line 370 of file qgscolorwidgets.cpp.

◆ ~QgsColorWheel()

QgsColorWheel::~QgsColorWheel ( )
override

Definition at line 386 of file qgscolorwidgets.cpp.

Member Function Documentation

◆ mouseMoveEvent()

void QgsColorWheel::mouseMoveEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 601 of file qgscolorwidgets.cpp.

◆ mousePressEvent()

void QgsColorWheel::mousePressEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 607 of file qgscolorwidgets.cpp.

◆ mouseReleaseEvent()

void QgsColorWheel::mouseReleaseEvent ( QMouseEvent *  event)
overrideprotected

Definition at line 626 of file qgscolorwidgets.cpp.

◆ paintEvent()

void QgsColorWheel::paintEvent ( QPaintEvent *  event)
override

Definition at line 403 of file qgscolorwidgets.cpp.

◆ resizeEvent()

void QgsColorWheel::resizeEvent ( QResizeEvent *  event)
overrideprotected

Definition at line 511 of file qgscolorwidgets.cpp.

◆ setColor

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

Definition at line 482 of file qgscolorwidgets.cpp.

◆ sizeHint()

QSize QgsColorWheel::sizeHint ( ) const
override

Definition at line 393 of file qgscolorwidgets.cpp.


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