QGIS API Documentation  2.99.0-Master (0cba29c)
Public Member Functions | List of all members
QgsColorSliderWidget Class Reference

A composite horizontal color ramp widget and associated spinbox for manual value entry. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorSliderWidget:
Inheritance graph
[legend]

Public Member Functions

 QgsColorSliderWidget (QWidget *parent=nullptr, const ColorComponent component=QgsColorWidget::Red)
 Construct a new color slider widget. More...
 
virtual void setColor (const QColor &color, const bool emitSignals=false) override
 Sets the color for the widget. More...
 
virtual void setComponent (const ColorComponent component) override
 Sets the color component which the widget controls. More...
 
virtual void setComponentValue (const int value) override
 Alters the widget's color by setting the value for the widget's color component. More...
 
- 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...
 

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...
 
- Public Slots inherited from QgsColorWidget
- 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...
 
- 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
 
- 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 composite horizontal color ramp widget and associated spinbox for manual value entry.

Since
QGIS 2.5

Definition at line 549 of file qgscolorwidgets.h.

Constructor & Destructor Documentation

◆ QgsColorSliderWidget()

QgsColorSliderWidget::QgsColorSliderWidget ( QWidget *  parent = nullptr,
const ColorComponent  component = QgsColorWidget::Red 
)

Construct a new color slider widget.

Parameters
parentparent QWidget for the widget
componentcolor component which is controlled by the slider

Definition at line 1270 of file qgscolorwidgets.cpp.

Member Function Documentation

◆ setColor()

void QgsColorSliderWidget::setColor ( const QColor &  color,
const bool  emitSignals = false 
)
overridevirtual

Sets the color for the widget.

Parameters
colorwidget color
emitSignalsset to true to emit the colorChanged signal after setting color
See also
color

Reimplemented from QgsColorWidget.

Definition at line 1340 of file qgscolorwidgets.cpp.

◆ setComponent()

void QgsColorSliderWidget::setComponent ( const 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 1307 of file qgscolorwidgets.cpp.

◆ setComponentValue()

void QgsColorSliderWidget::setComponentValue ( const int  value)
overridevirtual

Alters the widget's color by setting the value for the widget's color component.

Parameters
valuevalue for widget's color component. This value is automatically clipped to the range of valid values for the color component.
See also
componentValue
setComponent
Note
this method has no effect if the widget is set to the QgsColorWidget::Multiple component

Reimplemented from QgsColorWidget.

Definition at line 1329 of file qgscolorwidgets.cpp.


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