A color ramp widget. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorRampWidget:

Public Types
enum	Orientation { Horizontal = 0, Vertical }
Public Types inherited from QgsColorWidget
enum	ColorComponent { Multiple = 0, Red, Green, Blue, Hue, Saturation, Value, Alpha }

Signals
void	valueChanged (const int value)
	Emitted when the widget's color component value changes.
Signals inherited from QgsColorWidget
void	colorChanged (const QColor color)
	Emitted when the widget's color changes.

Public Member Functions
	QgsColorRampWidget (QWidget *parent=0, const ColorComponent component=QgsColorWidget::Red, const Orientation orientation=QgsColorRampWidget::Horizontal)
	Construct a new color ramp widget.
virtual	~QgsColorRampWidget ()
virtual QSize	sizeHint () const
void	paintEvent (QPaintEvent *event)
void	setOrientation (const Orientation orientation)
	Sets the orientation for the color ramp.
Orientation	orientation () const
	Fetches the orientation for the color ramp.
void	setInteriorMargin (const int margin)
	Sets the margin between the edge of the widget and the ramp.
int	interiorMargin () const
	Fetches the margin between the edge of the widget and the ramp.
void	setShowFrame (const bool showFrame)
	Sets whether the ramp should be drawn within a frame.
bool	showFrame () const
	Fetches whether the ramp is drawn within a frame.
void	setMarkerSize (const int markerSize)
	Sets the size for drawing the triangular markers on the ramp.
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.

Protected Member Functions
virtual void	mouseMoveEvent (QMouseEvent *event)
virtual void	mousePressEvent (QMouseEvent *event)
virtual void	keyPressEvent (QKeyEvent *event)
Protected Member Functions inherited from QgsColorWidget
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.
int	hue () const
	Returns the hue for the widget.
void	alterColor (QColor &color, const QgsColorWidget::ColorComponent component, const int newValue) const
	Alters a color by modifiying the value of a specific color component.
void	dragEnterEvent (QDragEnterEvent *e)
void	dropEvent (QDropEvent *e)

Additional Inherited Members
Public Slots inherited from QgsColorWidget
virtual void	setColor (const QColor color, const bool emitSignals=false)
	Sets the color for the widget.
virtual void	setComponent (const ColorComponent component)
	Sets the color component which the widget controls.
virtual void	setComponentValue (const int value)
	Alters the widget's color by setting the value for the widget's color component.
Static Public Member Functions inherited from QgsColorWidget
static QPixmap	createDragIcon (const QColor color)
	Create an icon for dragging colors.
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
QColor	mCurrentColor
ColorComponent	mComponent
int	mExplicitHue
	QColor wipes the hue information when it is ambiguous (eg, for saturation = 0).

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 (eg, varying saturation from 0 to 100%).

Note: Added in version 2.5

Member Enumeration Documentation

enum QgsColorRampWidget::Orientation

Specifies the orientation of a color ramp

Enumerator:

Horizontal	horizontal ramp
Vertical	vertical ramp

Constructor & Destructor Documentation

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

Construct a new color ramp widget.

Parameters

parent	parent QWidget for the widget
component	color component which varies along the ramp
orientation	orientation for widget

QgsColorRampWidget::~QgsColorRampWidget ( )

virtual

Member Function Documentation

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

void QgsColorRampWidget::keyPressEvent ( QKeyEvent * event )

protectedvirtual

void QgsColorRampWidget::mouseMoveEvent ( QMouseEvent * event )

protectedvirtual

void QgsColorRampWidget::mousePressEvent ( QMouseEvent * event )

protectedvirtual

Orientation QgsColorRampWidget::orientation ( ) const

inline

Fetches the orientation for the color ramp.

Returns: orientation for the ramp

See Also: setOrientation

void QgsColorRampWidget::paintEvent ( QPaintEvent * event )

void QgsColorRampWidget::setInteriorMargin ( const int margin )

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

Parameters

margin margin around the ramp

See Also: interiorMargin

void QgsColorRampWidget::setMarkerSize ( const int markerSize )

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

Parameters

markerSize marker size in pixels

void QgsColorRampWidget::setOrientation ( const Orientation orientation )

Sets the orientation for the color ramp.

Parameters

orientation new orientation for the ramp

See Also: orientation

void QgsColorRampWidget::setShowFrame ( const bool showFrame )

Sets whether the ramp should be drawn within a frame.

Parameters

showFrame set to true to draw a frame around the ramp

See Also: 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

QSize QgsColorRampWidget::sizeHint ( ) const

virtual

void QgsColorRampWidget::valueChanged ( const int value )

signal

Emitted when the widget's color component value changes.

Parameters

value new value of color component

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

/tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgscolorwidgets.h
/tmp/buildd/qgis-2.6.0+wheezy1/src/gui/qgscolorwidgets.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation