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:

[legend]

Collaboration diagram for QgsColorButton:

[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)

void	mousePressEvent (QMouseEvent *e)
	Reimplemented to detect right mouse button clicks on the color button and allow dragging colors. More...

void	mouseMoveEvent (QMouseEvent *e)
	Reimplemented to allow dragging colors from button. More...

void	dragEnterEvent (QDragEnterEvent *e)
	Reimplemented to accept dragged colors. More...

void	dropEvent (QDropEvent *e)
	Reimplemented to accept dropped colors. More...

Static Protected Member Functions
static const QPixmap &	transpBkgrd ()

Properties
QString	colorDialogTitle

bool	acceptLiveUpdates

QColor	color

QColorDialog::ColorDialogOptions	colorDialogOptions

Private Slots
void	onButtonClicked ()

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

Private Member Functions
void	showContextMenu (QMouseEvent *event)
	Shows the color button context menu and handles copying and pasting color values. More...

QMimeData *	createColorMimeData () const
	Creates mime data from the current color. More...

bool	colorFromMimeData (const QMimeData *mimeData, QColor &resultColor)
	Attempts to parse mimeData as a color, either via the mime data's color data or by parsing a textual representation of a color. More...

Private Attributes
QString	mColorDialogTitle

QColor	mColor

QColorDialog::ColorDialogOptions	mColorDialogOptions

bool	mAcceptLiveUpdates

QTemporaryFile	mTempPNG

bool	mColorSet

QPoint	mDragStartPosition

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

parent	The parent QWidget for the dialog
cdt	The title to show in the color chooser dialog
cdo	Options for the color chooser dialog

Note: changed in 1.9

Definition at line 65 of file qgscolorbutton.cpp.

References onButtonClicked().

QgsColorButton::~QgsColorButton ( )

Definition at line 78 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 104 of file qgscolorbutton.h.

void QgsColorButton::changeEvent ( QEvent * e )

protected

Definition at line 274 of file qgscolorbutton.cpp.

References setButtonBackground().

QColor QgsColorButton::color ( ) const

Return the currently selected color.

Returns: the currently selected color

Note: added in 1.9

Referenced by onButtonClicked(), and setColor().

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

color New 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

QString QgsColorButton::colorDialogTitle ( )

Returns the title, which the color chooser dialog shows.

Returns: Title for the color chooser dialog

Note: added in 1.9

bool QgsColorButton::colorFromMimeData	(	const QMimeData *	mimeData,
		QColor &	resultColor
	)

private

Attempts to parse mimeData as a color, either via the mime data's color data or by parsing a textual representation of a color.

Returns: true if mime data could be intrepreted as a color

Parameters

mimeData	mime data
resultColor	QColor to store evaluated color

Note: added in 2.3

See also: createColorMimeData

Definition at line 137 of file qgscolorbutton.cpp.

References mColor, mColorDialogOptions, and QgsSymbolLayerV2Utils::parseColorWithAlpha().

Referenced by dragEnterEvent(), dropEvent(), and showContextMenu().

QMimeData * QgsColorButton::createColorMimeData ( ) const

private

Creates mime data from the current color.

Sets both the mime data's color data, and the mime data's text with the color's hex code.

Note: added in 2.3

See also: colorFromMimeData

Definition at line 129 of file qgscolorbutton.cpp.

References mColor.

Referenced by mouseMoveEvent(), and showContextMenu().

void QgsColorButton::dragEnterEvent ( QDragEnterEvent * e )

protected

Reimplemented to accept dragged colors.

Definition at line 212 of file qgscolorbutton.cpp.

References colorFromMimeData().

void QgsColorButton::dropEvent ( QDropEvent * e )

protected

Reimplemented to accept dropped colors.

Definition at line 222 of file qgscolorbutton.cpp.

References colorFromMimeData(), and setColor().

void QgsColorButton::mouseMoveEvent ( QMouseEvent * e )

protected

Reimplemented to allow dragging colors from button.

Definition at line 175 of file qgscolorbutton.cpp.

References createColorMimeData(), mColor, and mDragStartPosition.

void QgsColorButton::mousePressEvent ( QMouseEvent * e )

protected

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

Definition at line 115 of file qgscolorbutton.cpp.

References mDragStartPosition, and showContextMenu().

void QgsColorButton::onButtonClicked ( )

privateslot

Definition at line 94 of file qgscolorbutton.cpp.

References color(), QgsColorDialog::getLiveColor(), mAcceptLiveUpdates, mColorDialogOptions, mColorDialogTitle, and setValidColor().

Referenced by QgsColorButton().

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 112 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