QgsColorSliderWidget Class Reference

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

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorSliderWidget:

Public Member Functions
	QgsColorSliderWidget (QWidget *parent=0, const ColorComponent component=QgsColorWidget::Red)
	Construct a new color slider widget.
virtual	~QgsColorSliderWidget ()
virtual void	setColor (const QColor &color, const bool emitSignals=false) override
	Sets the color for the widget.
virtual void	setComponent (const ColorComponent component) override
	Sets the color component which the widget controls.
virtual void	setComponentValue (const int value) override
	Alters the widget's color by setting the value for the widget's color component.
Public Member Functions inherited from QgsColorWidget
	QgsColorWidget (QWidget *parent=0, const ColorComponent component=Multiple)
	Construct a new color widget.
virtual	~QgsColorWidget ()
QColor	color () const
	Returns the current color for the widget.
ColorComponent	component () const
	Returns the color component which the widget controls.
int	componentValue () const
	Returns the current value of the widget's color component.

Additional Inherited Members
Public Types inherited from QgsColorWidget
enum	ColorComponent {   Multiple = 0, Red, Green, Blue,   Hue, Saturation, Value, Alpha }
Public Slots inherited from QgsColorWidget
Signals inherited from QgsColorWidget
void	colorChanged (const QColor &color)
	Emitted when the widget's color changes.
Static Public Member Functions inherited from QgsColorWidget
static QPixmap	createDragIcon (const QColor &color)
	Create an icon for dragging colors.
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.
int	componentRange () const
	Returns the range of valid values for the color widget's component.
int	componentRange (const ColorComponent component) const
	Returns the range of valid values a color component.
int	componentValue (const ColorComponent component) const
	Returns the value of a component of the widget's current color.
void	dragEnterEvent (QDragEnterEvent *e) override
void	dropEvent (QDropEvent *e) override
int	hue () const
	Returns the hue for the widget.
Static Protected Member Functions inherited from QgsColorWidget
static const QPixmap &	transparentBackground ()
	Generates a checkboard pattern pixmap for use as a background to transparent colors.
Protected Attributes inherited from QgsColorWidget
ColorComponent	mComponent
QColor	mCurrentColor
int	mExplicitHue
	QColor wipes the hue information when it is ambiguous (eg, for saturation = 0).

Detailed Description

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

Note

Added in version 2.5

Definition at line 471 of file qgscolorwidgets.h.

Constructor & Destructor Documentation

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

Construct a new color slider widget.

Parameters

parent	parent QWidget for the widget
component	color component which is controlled by the slider

Definition at line 1233 of file qgscolorwidgets.cpp.

QgsColorSliderWidget::~QgsColorSliderWidget ( )

virtual

Definition at line 1270 of file qgscolorwidgets.cpp.

Member Function Documentation

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

overridevirtual

Sets the color for the widget.

Parameters

color	widget color
emitSignals	set to true to emit the colorChanged signal after setting color

See Also

color

Reimplemented from QgsColorWidget.

Definition at line 1307 of file qgscolorwidgets.cpp.

void QgsColorSliderWidget::setComponent ( const ColorComponent  component )

overridevirtual

Sets the color component which the widget controls.

Parameters

component

color component for widget

See Also

component

Reimplemented from QgsColorWidget.

Definition at line 1274 of file qgscolorwidgets.cpp.

void QgsColorSliderWidget::setComponentValue ( const int  value )

overridevirtual

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

Parameters

value

value 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 1296 of file qgscolorwidgets.cpp.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgscolorwidgets.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgscolorwidgets.cpp