QGIS API Documentation  2.7.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Slots | Signals | Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
QgsColorButton Class Reference

A cross platform button subclass for selecting colors. Will open a color chooser dialog when clicked. Offers live updates to button from color chooser dialog. More...

#include <qgscolorbutton.h>

Inheritance diagram for QgsColorButton:
Inheritance graph
[legend]

Public Slots

void setButtonBackground (QColor color=QColor())
 Sets the background pixmap for the button based upon color and transparency. More...
 

Signals

void colorChanged (const QColor &color)
 Is emitted, whenever a new color is accepted. More...
 

Public Member Functions

 QgsColorButton (QWidget *parent=0, QString cdt="", QColorDialog::ColorDialogOptions cdo=0)
 Construct a new color button. More...
 
 ~QgsColorButton ()
 
bool acceptLiveUpdates ()
 Whether the button accepts live updates from QColorDialog. More...
 
QColor color () const
 Return the currently selected color. More...
 
QColorDialog::ColorDialogOptions colorDialogOptions ()
 Returns the options for the color chooser dialog. More...
 
QString colorDialogTitle ()
 Returns the title, which the color chooser dialog shows. More...
 
void setAcceptLiveUpdates (bool accept)
 Sets whether the button accepts live updates from QColorDialog. More...
 
void setColor (const QColor &color)
 Specify the current color. More...
 
void setColorDialogOptions (QColorDialog::ColorDialogOptions cdo)
 Specify the options for the color chooser dialog (e.g. More...
 
void setColorDialogTitle (QString cdt)
 Set the title, which the color chooser dialog will show. More...
 

Protected Member Functions

void changeEvent (QEvent *e)
 
void dragEnterEvent (QDragEnterEvent *e)
 Reimplemented to accept dragged colors. More...
 
void dropEvent (QDropEvent *e)
 Reimplemented to accept dropped colors. More...
 
void keyPressEvent (QKeyEvent *e)
 Reimplemented to allow cancelling color pick via keypress, and sample via space bar press. More...
 
void mouseMoveEvent (QMouseEvent *e)
 Reimplemented to allow dragging colors from button. More...
 
void mousePressEvent (QMouseEvent *e)
 Reimplemented to detect right mouse button clicks on the color button and allow dragging colors. More...
 
void mouseReleaseEvent (QMouseEvent *e)
 Reimplemented to allow color picking. More...
 
void showEvent (QShowEvent *e)
 

Static Protected Member Functions

static const QPixmap & transpBkgrd ()
 

Detailed Description

A cross platform button subclass for selecting colors. Will open a color chooser dialog when clicked. Offers live updates to button from color chooser dialog.

A cross platform button subclass for selecting colors.

A subclass of QPushButton is needed to draw the button content because some platforms such as Mac OS X and Windows XP enforce a consistent GUI look by always using the button color of the current style and not allowing button backgrounds to be changed on a button by button basis. Therefore, a wholely stylesheet-based button is used for the no-text variant.

This class is a simplified version of QtColorButton, an internal class used by Qt Designer to do the same thing.

Will open a color chooser dialog when clicked. Offers live updates to button from color chooser dialog

Note
inherited base class moved from QToolButton to QPushButton in QGIS 1.9

Definition at line 31 of file qgscolorbutton.h.

Constructor & Destructor Documentation

QgsColorButton::QgsColorButton ( QWidget *  parent = 0,
QString  cdt = "",
QColorDialog::ColorDialogOptions  cdo = 0 
)

Construct a new color button.

Parameters
parentThe parent QWidget for the dialog
cdtThe title to show in the color chooser dialog
cdoOptions for the color chooser dialog
Note
changed in 1.9

Definition at line 67 of file qgscolorbutton.cpp.

QgsColorButton::~QgsColorButton ( )

Definition at line 81 of file qgscolorbutton.cpp.

Member Function Documentation

bool QgsColorButton::acceptLiveUpdates ( )
inline

Whether the button accepts live updates from QColorDialog.

Definition at line 96 of file qgscolorbutton.h.

void QgsColorButton::changeEvent ( QEvent *  e)
protected

Definition at line 396 of file qgscolorbutton.cpp.

QColor QgsColorButton::color ( ) const

Return the currently selected color.

Returns
the currently selected color
void QgsColorButton::colorChanged ( const QColor &  color)
signal

Is emitted, whenever a new color is accepted.

The color is always valid. In case the new color is the same, no signal is emitted, to avoid infinite loops.

Parameters
colorNew color
QColorDialog::ColorDialogOptions QgsColorButton::colorDialogOptions ( )

Returns the options for the color chooser dialog.

Returns
Options for the color chooser dialog
QString QgsColorButton::colorDialogTitle ( )

Returns the title, which the color chooser dialog shows.

Returns
Title for the color chooser dialog
void QgsColorButton::dragEnterEvent ( QDragEnterEvent *  e)
protected

Reimplemented to accept dragged colors.

Definition at line 316 of file qgscolorbutton.cpp.

void QgsColorButton::dropEvent ( QDropEvent *  e)
protected

Reimplemented to accept dropped colors.

Definition at line 326 of file qgscolorbutton.cpp.

void QgsColorButton::keyPressEvent ( QKeyEvent *  e)
protected

Reimplemented to allow cancelling color pick via keypress, and sample via space bar press.

Definition at line 303 of file qgscolorbutton.cpp.

void QgsColorButton::mouseMoveEvent ( QMouseEvent *  e)
protected

Reimplemented to allow dragging colors from button.

Definition at line 216 of file qgscolorbutton.cpp.

void QgsColorButton::mousePressEvent ( QMouseEvent *  e)
protected

Reimplemented to detect right mouse button clicks on the color button and allow dragging colors.

Definition at line 149 of file qgscolorbutton.cpp.

void QgsColorButton::mouseReleaseEvent ( QMouseEvent *  e)
protected

Reimplemented to allow color picking.

Definition at line 270 of file qgscolorbutton.cpp.

void QgsColorButton::setAcceptLiveUpdates ( bool  accept)
inline

Sets whether the button accepts live updates from QColorDialog.

Live updates may cause changes that are not undoable on QColorDialog cancel.

Definition at line 102 of file qgscolorbutton.h.

void QgsColorButton::setButtonBackground ( QColor  color = QColor())
slot

Sets the background pixmap for the button based upon color and transparency.

Call directly to update background after adding/removing QColorDialog::ShowAlphaChannel option but the color has not changed, i.e. setColor() wouldn't update button and you want the button to retain the set color's alpha component regardless

Parameters
colorColor for button background

Definition at line 446 of file qgscolorbutton.cpp.

void QgsColorButton::setColor ( const QColor &  color)

Specify the current color.

Will emit a colorChanged signal if the color is different to the previous.

Parameters
colorthe new color

Definition at line 423 of file qgscolorbutton.cpp.

void QgsColorButton::setColorDialogOptions ( QColorDialog::ColorDialogOptions  cdo)

Specify the options for the color chooser dialog (e.g.

alpha).

Parameters
cdoOptions for the color chooser dialog

Definition at line 581 of file qgscolorbutton.cpp.

void QgsColorButton::setColorDialogTitle ( QString  cdt)

Set the title, which the color chooser dialog will show.

Parameters
cdtTitle for the color chooser dialog

Definition at line 591 of file qgscolorbutton.cpp.

void QgsColorButton::showEvent ( QShowEvent *  e)
protected

Definition at line 417 of file qgscolorbutton.cpp.

const QPixmap & QgsColorButton::transpBkgrd ( )
staticprotected

Definition at line 87 of file qgscolorbutton.cpp.


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