QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Slots | Public Member Functions | Protected Member Functions | List of all members
QgsColorPreviewWidget Class Reference

A preview box which displays one or two colors as swatches. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorPreviewWidget:
Inheritance graph
[legend]

Public Slots

virtual void setColor2 (const QColor &color)
 Sets the second color for the widget.
- 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.

Public Member Functions

 QgsColorPreviewWidget (QWidget *parent=0)
 Construct a new color preview widget.
virtual ~QgsColorPreviewWidget ()
void paintEvent (QPaintEvent *event)
QColor color2 () const
 Returns the secondary color for the widget.
- 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

void mousePressEvent (QMouseEvent *e)
void mouseReleaseEvent (QMouseEvent *e)
void mouseMoveEvent (QMouseEvent *e)
- 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 Types inherited from QgsColorWidget
enum  ColorComponent {
  Multiple = 0, Red, Green, Blue,
  Hue, Saturation, Value, Alpha
}
- 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.
- 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 preview box which displays one or two colors as swatches.

Note
Added in version 2.5

Constructor & Destructor Documentation

QgsColorPreviewWidget::QgsColorPreviewWidget ( QWidget *  parent = 0)

Construct a new color preview widget.

Parameters
parentparent QWidget for the widget
QgsColorPreviewWidget::~QgsColorPreviewWidget ( )
virtual

Member Function Documentation

QColor QgsColorPreviewWidget::color2 ( ) const
inline

Returns the secondary color for the widget.

Returns
secondary widget color, or an invalid color if the widget has no secondary color
See Also
color
setColor2
void QgsColorPreviewWidget::mouseMoveEvent ( QMouseEvent *  e)
protected
void QgsColorPreviewWidget::mousePressEvent ( QMouseEvent *  e)
protected
void QgsColorPreviewWidget::mouseReleaseEvent ( QMouseEvent *  e)
protected
void QgsColorPreviewWidget::paintEvent ( QPaintEvent *  event)
void QgsColorPreviewWidget::setColor2 ( const QColor &  color)
virtualslot

Sets the second color for the widget.

Parameters
colorsecondary widget color. Set to an invalid color to prevent drawing of a secondary color
See Also
setColor
color2

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