QGIS API Documentation  2.99.0-Master (d55fa22)
Public Slots | Public Member Functions | Protected Member Functions | List of all members
QgsColorPreviewWidget Class Reference

A preview box which displays one or two colors as swatches. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorPreviewWidget:
Inheritance graph
[legend]

Public Slots

virtual void setColor2 (const QColor &color)
 Sets the second color for the widget. More...
 
- 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

 QgsColorPreviewWidget (QWidget *parent=nullptr)
 Construct a new color preview widget. More...
 
QColor color2 () const
 Returns the secondary color for the widget. More...
 
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

void mouseMoveEvent (QMouseEvent *e) override
 
void mousePressEvent (QMouseEvent *e) override
 
void mouseReleaseEvent (QMouseEvent *e) 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
 QColor wipes the hue information when it is ambiguous (e.g., for saturation = 0). More...
 

Detailed Description

A preview box which displays one or two colors as swatches.

Since
QGIS 2.5

Definition at line 670 of file qgscolorwidgets.h.

Constructor & Destructor Documentation

◆ QgsColorPreviewWidget()

QgsColorPreviewWidget::QgsColorPreviewWidget ( QWidget *  parent = nullptr)

Construct a new color preview widget.

Parameters
parentparent QWidget for the widget

Definition at line 1536 of file qgscolorwidgets.cpp.

Member Function Documentation

◆ color2()

QColor QgsColorPreviewWidget::color2 ( ) const
inline

Returns the secondary color for the widget.

Returns
secondary widget color, or an invalid color if the widget has no secondary color
See also
color
setColor2

Definition at line 690 of file qgscolorwidgets.h.

◆ mouseMoveEvent()

void QgsColorPreviewWidget::mouseMoveEvent ( QMouseEvent *  e)
overrideprotected

Definition at line 1643 of file qgscolorwidgets.cpp.

◆ mousePressEvent()

void QgsColorPreviewWidget::mousePressEvent ( QMouseEvent *  e)
overrideprotected

Definition at line 1610 of file qgscolorwidgets.cpp.

◆ mouseReleaseEvent()

void QgsColorPreviewWidget::mouseReleaseEvent ( QMouseEvent *  e)
overrideprotected

Definition at line 1619 of file qgscolorwidgets.cpp.

◆ paintEvent()

void QgsColorPreviewWidget::paintEvent ( QPaintEvent *  event)
override

Definition at line 1575 of file qgscolorwidgets.cpp.

◆ setColor2

void QgsColorPreviewWidget::setColor2 ( const QColor &  color)
virtualslot

Sets the second color for the widget.

Parameters
colorsecondary widget color. Set to an invalid color to prevent drawing of a secondary color
See also
setColor
color2

Definition at line 1600 of file qgscolorwidgets.cpp.

◆ sizeHint()

QSize QgsColorPreviewWidget::sizeHint ( ) const
overridevirtual

Definition at line 1595 of file qgscolorwidgets.cpp.


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