QGIS API Documentation  2.99.0-Master (9fdd060)
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

virtual void setColor (const QColor &color, const bool emitSignals=false) override
 
- Public Slots inherited from QgsColorWidget
virtual void setColor (const QColor &color, const bool emitSignals=false)
 Sets the color for the widget. More...
 
virtual void setComponent (const ColorComponent component)
 Sets the color component which the widget controls. More...
 
virtual void setComponentValue (const 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...
 
virtual ~QgsColorWheel ()
 
void paintEvent (QPaintEvent *event) override
 
virtual QSize sizeHint () const override
 
- Public Member Functions inherited from QgsColorWidget
 QgsColorWidget (QWidget *parent=nullptr, const 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

virtual void mouseMoveEvent (QMouseEvent *event) override
 
virtual void mousePressEvent (QMouseEvent *event) override
 
virtual void mouseReleaseEvent (QMouseEvent *event) override
 
virtual void resizeEvent (QResizeEvent *event) override
 
- Protected Member Functions inherited from QgsColorWidget
void alterColor (QColor &color, const QgsColorWidget::ColorComponent component, const int newValue) const
 Alters a color by modifiying 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 (const ColorComponent component) const
 Returns the range of valid values a color component. More...
 
int componentValue (const 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 366 of file qgscolorwidgets.cpp.

◆ ~QgsColorWheel()

QgsColorWheel::~QgsColorWheel ( )
virtual

Definition at line 382 of file qgscolorwidgets.cpp.

Member Function Documentation

◆ mouseMoveEvent()

void QgsColorWheel::mouseMoveEvent ( QMouseEvent *  event)
overrideprotectedvirtual

Definition at line 593 of file qgscolorwidgets.cpp.

◆ mousePressEvent()

void QgsColorWheel::mousePressEvent ( QMouseEvent *  event)
overrideprotectedvirtual

Definition at line 599 of file qgscolorwidgets.cpp.

◆ mouseReleaseEvent()

void QgsColorWheel::mouseReleaseEvent ( QMouseEvent *  event)
overrideprotectedvirtual

Definition at line 618 of file qgscolorwidgets.cpp.

◆ paintEvent()

void QgsColorWheel::paintEvent ( QPaintEvent *  event)
override

Definition at line 395 of file qgscolorwidgets.cpp.

◆ resizeEvent()

void QgsColorWheel::resizeEvent ( QResizeEvent *  event)
overrideprotectedvirtual

Definition at line 503 of file qgscolorwidgets.cpp.

◆ setColor

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

Definition at line 474 of file qgscolorwidgets.cpp.

◆ sizeHint()

QSize QgsColorWheel::sizeHint ( ) const
overridevirtual

Definition at line 389 of file qgscolorwidgets.cpp.


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