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
QgsColorBox Class Reference

A color box widget. More...

#include <qgscolorwidgets.h>

Inheritance diagram for QgsColorBox:
Inheritance graph
[legend]

Public Slots

virtual void setColor (const QColor color, const bool emitSignals=false)
- Public Slots inherited from QgsColorWidget
virtual void setColor (const QColor color, const bool emitSignals=false)
 Sets the color for the widget.
virtual void setComponentValue (const int value)
 Alters the widget's color by setting the value for the widget's color component.

Public Member Functions

 QgsColorBox (QWidget *parent=0, const ColorComponent component=Value)
 Construct a new color box widget.
virtual ~QgsColorBox ()
virtual QSize sizeHint () const
void paintEvent (QPaintEvent *event)
virtual void setComponent (const ColorComponent component)
 Sets the color component which the widget controls.
- 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 resizeEvent (QResizeEvent *event)
virtual void mouseMoveEvent (QMouseEvent *event)
virtual void mousePressEvent (QMouseEvent *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 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 color box widget.

This widget consists of a two dimensional rectangle filled with color variations, where a different color component varies along both the horizontal and vertical axis.

Note
Added in version 2.5

Constructor & Destructor Documentation

QgsColorBox::QgsColorBox ( QWidget *  parent = 0,
const ColorComponent  component = Value 
)

Construct a new color box widget.

Parameters
parentparent QWidget for the widget
componentconstant color component for the widget. The color components which vary along the horizontal and vertical axis are automatically assigned based on this constant color component.
QgsColorBox::~QgsColorBox ( )
virtual

Member Function Documentation

void QgsColorBox::mouseMoveEvent ( QMouseEvent *  event)
protectedvirtual
void QgsColorBox::mousePressEvent ( QMouseEvent *  event)
protectedvirtual
void QgsColorBox::paintEvent ( QPaintEvent *  event)
void QgsColorBox::resizeEvent ( QResizeEvent *  event)
protectedvirtual
void QgsColorBox::setColor ( const QColor  color,
const bool  emitSignals = false 
)
virtualslot
void QgsColorBox::setComponent ( const ColorComponent  component)
virtual

Sets the color component which the widget controls.

Parameters
componentcolor component for widget
See Also
component

Reimplemented from QgsColorWidget.

QSize QgsColorBox::sizeHint ( ) const
virtual

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