QGIS API Documentation  2.99.0-Master (13a3f2f)
Public Types | Signals | Public Member Functions | Protected Member Functions | List of all members
QgsColorRampWidget Class Reference

A color ramp widget. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorRampWidget:
Inheritance graph
[legend]

Public Types

enum  Orientation { Horizontal = 0, Vertical }
 Specifies the orientation of a color ramp. More...
 
- 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

void valueChanged (const int value)
 Emitted when the widget's color component value changes. 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...
 

Public Member Functions

 QgsColorRampWidget (QWidget *parent=nullptr, const ColorComponent component=QgsColorWidget::Red, const Orientation orientation=QgsColorRampWidget::Horizontal)
 Construct a new color ramp widget. More...
 
int interiorMargin () const
 Fetches the margin between the edge of the widget and the ramp. More...
 
Orientation orientation () const
 Fetches the orientation for the color ramp. More...
 
void paintEvent (QPaintEvent *event) override
 
void setInteriorMargin (const int margin)
 Sets the margin between the edge of the widget and the ramp. More...
 
void setMarkerSize (const int markerSize)
 Sets the size for drawing the triangular markers on the ramp. More...
 
void setOrientation (const Orientation orientation)
 Sets the orientation for the color ramp. More...
 
void setShowFrame (const bool showFrame)
 Sets whether the ramp should be drawn within a frame. More...
 
bool showFrame () const
 Fetches whether the ramp is drawn within a frame. More...
 
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 keyPressEvent (QKeyEvent *event) override
 
virtual void mouseMoveEvent (QMouseEvent *event) override
 
virtual void mousePressEvent (QMouseEvent *event) override
 
virtual void wheelEvent (QWheelEvent *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 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...
 
- 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 color ramp widget.

This widget consists of an interactive box filled with a color which varies along its length by a single color component (e.g., varying saturation from 0 to 100%).

Since
QGIS 2.5

Definition at line 437 of file qgscolorwidgets.h.

Member Enumeration Documentation

◆ Orientation

Specifies the orientation of a color ramp.

Enumerator
Horizontal 

Horizontal ramp.

Vertical 

Vertical ramp.

Definition at line 445 of file qgscolorwidgets.h.

Constructor & Destructor Documentation

◆ QgsColorRampWidget()

QgsColorRampWidget::QgsColorRampWidget ( QWidget *  parent = nullptr,
const ColorComponent  component = QgsColorWidget::Red,
const Orientation  orientation = QgsColorRampWidget::Horizontal 
)

Construct a new color ramp widget.

Parameters
parentparent QWidget for the widget
componentcolor component which varies along the ramp
orientationorientation for widget

Definition at line 973 of file qgscolorwidgets.cpp.

Member Function Documentation

◆ interiorMargin()

int QgsColorRampWidget::interiorMargin ( ) const
inline

Fetches the margin between the edge of the widget and the ramp.

Returns
margin around the ramp
See also
setInteriorMargin

Definition at line 485 of file qgscolorwidgets.h.

◆ keyPressEvent()

void QgsColorRampWidget::keyPressEvent ( QKeyEvent *  event)
overrideprotectedvirtual

Definition at line 1193 of file qgscolorwidgets.cpp.

◆ mouseMoveEvent()

void QgsColorRampWidget::mouseMoveEvent ( QMouseEvent *  event)
overrideprotectedvirtual

Definition at line 1161 of file qgscolorwidgets.cpp.

◆ mousePressEvent()

void QgsColorRampWidget::mousePressEvent ( QMouseEvent *  event)
overrideprotectedvirtual

Definition at line 1188 of file qgscolorwidgets.cpp.

◆ orientation()

Orientation QgsColorRampWidget::orientation ( ) const
inline

Fetches the orientation for the color ramp.

Returns
orientation for the ramp
See also
setOrientation

Definition at line 473 of file qgscolorwidgets.h.

◆ paintEvent()

void QgsColorRampWidget::paintEvent ( QPaintEvent *  event)
override

Definition at line 1001 of file qgscolorwidgets.cpp.

◆ setInteriorMargin()

void QgsColorRampWidget::setInteriorMargin ( const int  margin)

Sets the margin between the edge of the widget and the ramp.

Parameters
marginmargin around the ramp
See also
interiorMargin

Definition at line 1133 of file qgscolorwidgets.cpp.

◆ setMarkerSize()

void QgsColorRampWidget::setMarkerSize ( const int  markerSize)

Sets the size for drawing the triangular markers on the ramp.

Parameters
markerSizemarker size in pixels

Definition at line 1153 of file qgscolorwidgets.cpp.

◆ setOrientation()

void QgsColorRampWidget::setOrientation ( const Orientation  orientation)

Sets the orientation for the color ramp.

Parameters
orientationnew orientation for the ramp
See also
orientation

Definition at line 1117 of file qgscolorwidgets.cpp.

◆ setShowFrame()

void QgsColorRampWidget::setShowFrame ( const bool  showFrame)

Sets whether the ramp should be drawn within a frame.

Parameters
showFrameset to true to draw a frame around the ramp
See also
showFrame

Definition at line 1143 of file qgscolorwidgets.cpp.

◆ showFrame()

bool QgsColorRampWidget::showFrame ( ) const
inline

Fetches whether the ramp is drawn within a frame.

Returns
true if a frame is drawn around the ramp
See also
setShowFrame

Definition at line 497 of file qgscolorwidgets.h.

◆ sizeHint()

QSize QgsColorRampWidget::sizeHint ( ) const
overridevirtual

Definition at line 987 of file qgscolorwidgets.cpp.

◆ valueChanged

void QgsColorRampWidget::valueChanged ( const int  value)
signal

Emitted when the widget's color component value changes.

Parameters
valuenew value of color component

◆ wheelEvent()

void QgsColorRampWidget::wheelEvent ( QWheelEvent *  event)
overrideprotectedvirtual

Definition at line 1167 of file qgscolorwidgets.cpp.


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