QGIS API Documentation 4.3.0-Master (91d4a333d5d)
Loading...
Searching...
No Matches
QgsColorPickerHelper Class Reference

A utility class for sampling colors from the screen. More...

#include <qgscolorpickerhelper.h>

Inheritance diagram for QgsColorPickerHelper:

Public Slots

void activate (int sampleRadius=0)
 Activates the color picking operation.

Signals

void canceled ()
 Emitted when the user cancels the picking operation.
void colorHovered (const QColor &color)
 Emitted when the user hovers over a color from the screen.
void colorPicked (const QColor &color)
 Emitted when the user has finished picking a color from the screen.

Public Member Functions

 QgsColorPickerHelper (QObject *parent)
 Constructor for QgsColorPickerHelper for the specified parent widget.
 ~QgsColorPickerHelper () override

Protected Member Functions

bool eventFilter (QObject *watched, QEvent *event) override

Detailed Description

A utility class for sampling colors from the screen.

Note
Not available in Python bindings.
Since
QGIS 4.4

Definition at line 43 of file qgscolorpickerhelper.h.

Constructor & Destructor Documentation

◆ QgsColorPickerHelper()

QgsColorPickerHelper::QgsColorPickerHelper ( QObject * parent)

Constructor for QgsColorPickerHelper for the specified parent widget.

Definition at line 30 of file qgscolorpickerhelper.cpp.

◆ ~QgsColorPickerHelper()

QgsColorPickerHelper::~QgsColorPickerHelper ( )
override

Definition at line 41 of file qgscolorpickerhelper.cpp.

Member Function Documentation

◆ activate

void QgsColorPickerHelper::activate ( int sampleRadius = 0)
slot

Activates the color picking operation.

Definition at line 49 of file qgscolorpickerhelper.cpp.

◆ canceled

void QgsColorPickerHelper::canceled ( )
signal

Emitted when the user cancels the picking operation.

◆ colorHovered

void QgsColorPickerHelper::colorHovered ( const QColor & color)
signal

Emitted when the user hovers over a color from the screen.

◆ colorPicked

void QgsColorPickerHelper::colorPicked ( const QColor & color)
signal

Emitted when the user has finished picking a color from the screen.

◆ eventFilter()

bool QgsColorPickerHelper::eventFilter ( QObject * watched,
QEvent * event )
overrideprotected

Definition at line 79 of file qgscolorpickerhelper.cpp.


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