QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Slots | Signals | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Private Slots | Private Attributes | 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]
Collaboration diagram for QgsColorButton:
Collaboration graph
[legend]

Public Slots

void setButtonBackground ()
 Sets the background pixmap for the button based upon set 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 ()
 
void setColor (const QColor &color)
 Specify the current color. More...
 
QColor color () const
 Return the currently selected color. More...
 
void setColorDialogOptions (QColorDialog::ColorDialogOptions cdo)
 Specify the options for the color chooser dialog (e.g. More...
 
QColorDialog::ColorDialogOptions colorDialogOptions ()
 Returns the options for the color chooser dialog. More...
 
void setColorDialogTitle (QString cdt)
 Set the title, which the color chooser dialog will show. More...
 
QString colorDialogTitle ()
 Returns the title, which the color chooser dialog shows. More...
 
bool acceptLiveUpdates ()
 Whether the button accepts live updates from QColorDialog. More...
 
void setAcceptLiveUpdates (bool accept)
 Sets whether the button accepts live updates from QColorDialog. More...
 

Protected Member Functions

void changeEvent (QEvent *e)
 
void showEvent (QShowEvent *e)
 

Static Protected Member Functions

static const QPixmap & transpBkgrd ()
 

Private Slots

void onButtonClicked ()
 
void setValidColor (const QColor &newColor)
 Sets color for button, if valid. More...
 

Private Attributes

QString mColorDialogTitle
 
QColor mColor
 
QColorDialog::ColorDialogOptions mColorDialogOptions
 
bool mAcceptLiveUpdates
 
QTemporaryFile mTempPNG
 
bool mColorSet
 

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 30 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 41 of file qgscolorbutton.cpp.

References onButtonClicked().

QgsColorButton::~QgsColorButton ( )

Definition at line 53 of file qgscolorbutton.cpp.

References mTempPNG.

Member Function Documentation

bool QgsColorButton::acceptLiveUpdates ( )
inline

Whether the button accepts live updates from QColorDialog.

Note
added in 1.9

Definition at line 98 of file qgscolorbutton.h.

void QgsColorButton::changeEvent ( QEvent *  e)
protected

Definition at line 98 of file qgscolorbutton.cpp.

References setButtonBackground().

QColor QgsColorButton::color ( void  ) const

Return the currently selected color.

Returns
the currently selected color
Note
added in 1.9

Definition at line 270 of file qgscolorbutton.cpp.

References mColor.

Referenced by onButtonClicked(), setColor(), and QgsAttributeEditor::updateColor().

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
Note
added in 1.9

Referenced by setColor().

QColorDialog::ColorDialogOptions QgsColorButton::colorDialogOptions ( )

Returns the options for the color chooser dialog.

Returns
Options for the color chooser dialog
Note
added in 1.9

Definition at line 280 of file qgscolorbutton.cpp.

References mColorDialogOptions.

QString QgsColorButton::colorDialogTitle ( )

Returns the title, which the color chooser dialog shows.

Returns
Title for the color chooser dialog
Note
added in 1.9

Definition at line 290 of file qgscolorbutton.cpp.

References mColorDialogTitle.

void QgsColorButton::onButtonClicked ( )
privateslot
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.

Note
added in 1.9

Definition at line 106 of file qgscolorbutton.h.

void QgsColorButton::setButtonBackground ( )
slot

Sets the background pixmap for the button based upon set 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

Note
added in 1.9

Definition at line 148 of file qgscolorbutton.cpp.

References mColor, mColorDialogOptions, mTempPNG, and transpBkgrd().

Referenced by changeEvent(), setColor(), and showEvent().

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
Note
added in 1.9

Definition at line 125 of file qgscolorbutton.cpp.

References color(), colorChanged(), mColor, mColorSet, and setButtonBackground().

Referenced by setValidColor(), QgsAttributeEditor::setValue(), and QgsAttributeEditor::updateColor().

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

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

alpha).

Parameters
cdoOptions for the color chooser dialog
Note
added in 1.9

Definition at line 275 of file qgscolorbutton.cpp.

References mColorDialogOptions.

void QgsColorButton::setColorDialogTitle ( QString  cdt)

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

Parameters
cdtTitle for the color chooser dialog
Note
added in 1.9

Definition at line 285 of file qgscolorbutton.cpp.

References mColorDialogTitle.

void QgsColorButton::setValidColor ( const QColor &  newColor)
privateslot

Sets color for button, if valid.

Note
added in 1.9

Definition at line 90 of file qgscolorbutton.cpp.

References setColor().

Referenced by onButtonClicked().

void QgsColorButton::showEvent ( QShowEvent *  e)
protected

Definition at line 119 of file qgscolorbutton.cpp.

References setButtonBackground().

const QPixmap & QgsColorButton::transpBkgrd ( )
staticprotected

Definition at line 59 of file qgscolorbutton.cpp.

References QgsApplication::getThemePixmap().

Referenced by setButtonBackground().

Member Data Documentation

bool QgsColorButton::mAcceptLiveUpdates
private

Definition at line 141 of file qgscolorbutton.h.

Referenced by onButtonClicked().

QColor QgsColorButton::mColor
private

Definition at line 139 of file qgscolorbutton.h.

Referenced by color(), setButtonBackground(), and setColor().

QColorDialog::ColorDialogOptions QgsColorButton::mColorDialogOptions
private
QString QgsColorButton::mColorDialogTitle
private

Definition at line 138 of file qgscolorbutton.h.

Referenced by colorDialogTitle(), onButtonClicked(), and setColorDialogTitle().

bool QgsColorButton::mColorSet
private

Definition at line 143 of file qgscolorbutton.h.

Referenced by setColor().

QTemporaryFile QgsColorButton::mTempPNG
private

Definition at line 142 of file qgscolorbutton.h.

Referenced by setButtonBackground(), and ~QgsColorButton().


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