QgsColorButtonV2 Class Reference

A cross platform button subclass for selecting colors. More...

#include <qgscolorbuttonv2.h>

Public Types
enum	Behaviour { ShowDialog = 0, SignalOnly }

Public Slots
void	activatePicker ()
	Activates the color picker tool, which allows for sampling a color from anywhere on the screen.
void	copyColor ()
	Copies the current color to the clipboard.
void	pasteColor ()
	Pastes a color from the clipboard to the color button.
void	setButtonBackground (const QColor &color=QColor())
	Sets the background pixmap for the button based upon color and transparency.
void	setColor (const QColor &color)
	Sets the current color for the button.
void	setToDefaultColor ()
	Sets color to the button's default color, if set.
void	setToNoColor ()
	Sets color to a totally transparent color.

Signals
void	colorChanged (const QColor &color)
	Is emitted whenever a new color is set for the button.
void	colorClicked (const QColor &color)
	Emitted when the button is clicked, if the button's behaviour is set to SignalOnly.

Public Member Functions
	QgsColorButtonV2 (QWidget *parent=0, QString cdt="", QgsColorSchemeRegistry *registry=0)
	Construct a new color button.
virtual	~QgsColorButtonV2 ()
bool	acceptLiveUpdates () const
	Returns whether the button accepts live updates from QColorDialog.
bool	allowAlpha () const
	Returns whether alpha modification (transparency) is permitted for the color.
Behaviour	behaviour () const
	Returns the behaviour for when the button is clicked.
QColor	color () const
	Return the currently selected color.
QString	colorDialogTitle () const
	Returns the title for the color chooser dialog window.
QgsColorSchemeRegistry *	colorSchemeRegistry ()
	Returns the color scheme registry for the button, which controls the color swatch grids that are shown in the button's drop down menu.
QString	context () const
	Returns the context string for the color button.
QColor	defaultColor () const
	Returns the default color for the button, which is shown in the button's drop down menu for the "default color" option.
QString	noColorString () const
	Returns the string used for the "no color" option in the button's drop down menu.
void	setAcceptLiveUpdates (const bool accept)
	Sets whether the button accepts live updates from QColorDialog.
void	setAllowAlpha (const bool allowAlpha)
	Sets whether alpha modification (transparency) is permitted for the color.
void	setBehaviour (const Behaviour behaviour)
	Sets the behaviour for when the button is clicked.
void	setColorDialogTitle (const QString title)
	Set the title for the color chooser dialog window.
void	setColorSchemeRegistry (QgsColorSchemeRegistry *registry)
	Sets the color scheme registry for the button, which controls the color swatch grids that are shown in the button's drop down menu.
void	setContext (const QString context)
	Sets the context string for the color button.
void	setDefaultColor (const QColor color)
	Sets the default color for the button, which is shown in the button's drop down menu for the "default color" option.
void	setNoColorString (const QString noColorString)
	Sets the string to use for the "no color" option in the button's drop down menu.
void	setShowMenu (const bool showMenu)
	Sets whether the drop down menu should be shown for the button.
void	setShowNoColor (const bool showNoColorOption)
	Sets whether the "no color" option should be shown in the button's drop down menu.
bool	showMenu () const
	Returns whether the drop down menu is shown for the button.
bool	showNoColor () const
	Returns whether the "no color" option is shown in the button's drop down menu.
virtual QSize	sizeHint () const override

Protected Member Functions
void	changeEvent (QEvent *e) override
void	dragEnterEvent (QDragEnterEvent *e) override
	Reimplemented to accept dragged colors.
void	dragLeaveEvent (QDragLeaveEvent *e) override
	Reimplemented to reset button appearance after drag leave.
void	dropEvent (QDropEvent *e) override
	Reimplemented to accept dropped colors.
void	keyPressEvent (QKeyEvent *e) override
	Reimplemented to allow cancelling color pick via keypress, and sample via space bar press.
void	mouseMoveEvent (QMouseEvent *e) override
	Reimplemented to allow dragging colors from button.
void	mousePressEvent (QMouseEvent *e) override
	Reimplemented to detect right mouse button clicks on the color button and allow dragging colors.
void	mouseReleaseEvent (QMouseEvent *e) override
	Reimplemented to allow color picking.
void	resizeEvent (QResizeEvent *event) override
void	showEvent (QShowEvent *e) override

Static Protected Member Functions
static const QPixmap &	transparentBackground ()
	Returns a checkboard pattern pixmap for use as a background to transparent colors.

Properties
bool	acceptLiveUpdates
bool	allowAlpha
Behaviour	behaviour
QColor	color
QString	colorDialogTitle
QString	context
QColor	defaultColor
QString	noColorString
bool	showMenu
bool	showNoColor

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. An attached drop down menu allows for copying and pasting colors, picking colors from the screen, and selecting colors from color swatch grids.

Note

Added in version 2.5

Definition at line 34 of file qgscolorbuttonv2.h.

Member Enumeration Documentation

enum QgsColorButtonV2::Behaviour

Specifies the behaviour when the button is clicked

Enumerator:

ShowDialog	show a color picker dialog when clicked
SignalOnly	emit colorClicked signal only, no dialog

Definition at line 52 of file qgscolorbuttonv2.h.

Constructor & Destructor Documentation

QgsColorButtonV2::QgsColorButtonV2	(	QWidget *	parent = 0,
		QString	cdt = "",
		QgsColorSchemeRegistry *	registry = 0
	)

Construct a new color button.

Parameters

parent	The parent QWidget for the dialog
cdt	The title to show in the color chooser dialog
registry	a color scheme registry for color swatch grids to show in the drop down menu. If not specified, the button will use the global color scheme registry

Definition at line 41 of file qgscolorbuttonv2.cpp.

QgsColorButtonV2::~QgsColorButtonV2 ( )

virtual

Definition at line 70 of file qgscolorbuttonv2.cpp.

Member Function Documentation

bool QgsColorButtonV2::acceptLiveUpdates ( ) const

inline

Returns whether the button accepts live updates from QColorDialog.

Returns

true if the button will be accepted immediately when the dialog's color changes

See Also

setAcceptLiveUpdates

Definition at line 106 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::activatePicker ( )

slot

Activates the color picker tool, which allows for sampling a color from anywhere on the screen.

Definition at line 640 of file qgscolorbuttonv2.cpp.

bool QgsColorButtonV2::allowAlpha ( ) const

inline

Returns whether alpha modification (transparency) is permitted for the color.

Returns

true if alpha modification is allowed

See Also

setAllowAlpha

Definition at line 88 of file qgscolorbuttonv2.h.

Behaviour QgsColorButtonV2::behaviour ( ) const

inline

Returns the behaviour for when the button is clicked.

Returns

behaviour when button is clicked

See Also

setBehaviour

Definition at line 139 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::changeEvent ( QEvent *  e )

overrideprotected

Definition at line 460 of file qgscolorbuttonv2.cpp.

QColor QgsColorButtonV2::color

(

)

const

Return the currently selected color.

Returns

currently selected color

See Also

setColor

void QgsColorButtonV2::colorChanged ( const QColor &  color )

signal

Is emitted whenever a new color is set for the button.

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

void QgsColorButtonV2::colorClicked ( const QColor &  color )

signal

Emitted when the button is clicked, if the button's behaviour is set to SignalOnly.

Parameters

color

button color

See Also

setBehaviour

behaviour

QString QgsColorButtonV2::colorDialogTitle

(

)

const

Returns the title for the color chooser dialog window.

Returns

title for the color chooser dialog

See Also

setColorDialogTitle

QgsColorSchemeRegistry* QgsColorButtonV2::colorSchemeRegistry ( )

inline

Returns the color scheme registry for the button, which controls the color swatch grids that are shown in the button's drop down menu.

Returns

color scheme registry for the button. If returned value is 0 then all color swatch grids are hidden from the button's drop down menu.

See Also

setColorSchemeRegistry

Definition at line 225 of file qgscolorbuttonv2.h.

QString QgsColorButtonV2::context ( ) const

inline

Returns the context string for the color button.

The context string is passed to all color swatch grids shown in the button's drop down menu, to allow them to customise their display colors based on the context.

Returns

context string for the color button's color swatch grids

See Also

setContext

Definition at line 209 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::copyColor ( )

slot

Copies the current color to the clipboard.

See Also

pasteColor

Definition at line 623 of file qgscolorbuttonv2.cpp.

QColor QgsColorButtonV2::defaultColor ( ) const

inline

Returns the default color for the button, which is shown in the button's drop down menu for the "default color" option.

Returns

default color for the button. Returns an invalid QColor if the default color option is disabled.

See Also

setDefaultColor

Definition at line 155 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::dragEnterEvent ( QDragEnterEvent *  e )

overrideprotected

Reimplemented to accept dragged colors.

Definition at line 302 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::dragLeaveEvent ( QDragLeaveEvent *  e )

overrideprotected

Reimplemented to reset button appearance after drag leave.

Definition at line 316 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::dropEvent ( QDropEvent *  e )

overrideprotected

Reimplemented to accept dropped colors.

Definition at line 323 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::keyPressEvent ( QKeyEvent *  e )

overrideprotected

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

Definition at line 289 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::mouseMoveEvent ( QMouseEvent *  e )

overrideprotected

Reimplemented to allow dragging colors from button.

Definition at line 212 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::mousePressEvent ( QMouseEvent *  e )

overrideprotected

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

Definition at line 166 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::mouseReleaseEvent ( QMouseEvent *  e )

overrideprotected

Reimplemented to allow color picking.

Definition at line 254 of file qgscolorbuttonv2.cpp.

QString QgsColorButtonV2::noColorString ( ) const

inline

Returns the string used for the "no color" option in the button's drop down menu.

Returns

string used for the "no color" menu option

See Also

setNoColorString

showNoColor

Note

The "no color" option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

Definition at line 193 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::pasteColor ( )

slot

Pastes a color from the clipboard to the color button.

If clipboard does not contain a valid color or string representation of a color, then no change is applied.

See Also

copyColor

Definition at line 629 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::resizeEvent ( QResizeEvent *  event )

overrideprotected

Definition at line 487 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setAcceptLiveUpdates ( const bool  accept )

inline

Sets whether the button accepts live updates from QColorDialog.

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

Parameters

accept

set to true to enable live updates

See Also

acceptLiveUpdates

Definition at line 113 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::setAllowAlpha

(

const bool

allowAlpha

)

Sets whether alpha modification (transparency) is permitted for the color.

Defaults to false.

Parameters

allowAlpha

set to true to allow alpha modification

See Also

allowAlpha

Definition at line 655 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setBehaviour

(

const Behaviour

behaviour

)

Sets the behaviour for when the button is clicked.

The default behaviour is to show a color picker dialog.

Parameters

behaviour

behaviour when button is clicked

See Also

behaviour

Definition at line 679 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setButtonBackground ( const 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

color

Color for button background. If no color is specified, the button's current color will be used

Definition at line 550 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setColor ( const QColor &  color )

slot

Sets the current color for the button.

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

Parameters

color

new color for the button

See Also

color

Definition at line 495 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setColorDialogTitle

(

const QString

title

)

Set the title for the color chooser dialog window.

Parameters

title

Title for the color chooser dialog

See Also

colorDialogTitle

Definition at line 660 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setColorSchemeRegistry ( QgsColorSchemeRegistry *  registry )

inline

Sets the color scheme registry for the button, which controls the color swatch grids that are shown in the button's drop down menu.

Parameters

registry

color scheme registry for the button. Set to 0 to hide all color swatch grids from the button's drop down menu.

See Also

colorSchemeRegistry

Definition at line 217 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::setContext ( const QString  context )

inline

Sets the context string for the color button.

The context string is passed to all color swatch grids shown in the button's drop down menu, to allow them to customise their display colors based on the context.

Parameters

context

context string for the color button's color swatch grids

See Also

context

Definition at line 201 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::setDefaultColor

(

const QColor

color

)

Sets the default color for the button, which is shown in the button's drop down menu for the "default color" option.

Parameters

color

default color for the button. Set to an invalid QColor to disable the default color option.

See Also

defaultColor

Definition at line 684 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setNoColorString ( const QString  noColorString )

inline

Sets the string to use for the "no color" option in the button's drop down menu.

Parameters

noColorString

string to use for the "no color" menu option

See Also

noColorString

setShowNoColor

Note

The "no color" option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

Definition at line 184 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::setShowMenu

(

const bool

showMenu

)

Sets whether the drop down menu should be shown for the button.

The default behaviour is to show the menu.

Parameters

showMenu

set to false to hide the drop down menu

See Also

showMenu

Definition at line 670 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setShowNoColor ( const bool  showNoColorOption )

inline

Sets whether the "no color" option should be shown in the button's drop down menu.

If selected, the "no color" option sets the color button's color to a totally transparent color.

Parameters

showNoColorOption

set to true to show the no color option. This is disabled by default.

See Also

showNoColor

setNoColorString

Note

The "no color" option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

Definition at line 165 of file qgscolorbuttonv2.h.

void QgsColorButtonV2::setToDefaultColor ( )

slot

Sets color to the button's default color, if set.

See Also

setDefaultColor

defaultColor

Definition at line 148 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::setToNoColor ( )

slot

Sets color to a totally transparent color.

Note

If the color button is not set to show an alpha channel in the color dialog (see setColorDialogOptions) then the color will not be changed.

Definition at line 158 of file qgscolorbuttonv2.cpp.

void QgsColorButtonV2::showEvent ( QShowEvent *  e )

overrideprotected

Definition at line 481 of file qgscolorbuttonv2.cpp.

bool QgsColorButtonV2::showMenu ( ) const

inline

Returns whether the drop down menu is shown for the button.

Returns

true if drop down menu is shown

See Also

setShowMenu

Definition at line 126 of file qgscolorbuttonv2.h.

bool QgsColorButtonV2::showNoColor ( ) const

inline

Returns whether the "no color" option is shown in the button's drop down menu.

If selected, the "no color" option sets the color button's color to a totally transparent color.

Returns

true if the no color option is shown.

See Also

setShowNoColor

noColorString

Note

The "no color" option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

Definition at line 175 of file qgscolorbuttonv2.h.

QSize QgsColorButtonV2::sizeHint ( ) const

overridevirtual

Definition at line 74 of file qgscolorbuttonv2.cpp.

const QPixmap & QgsColorButtonV2::transparentBackground ( )

staticprotected

Returns a checkboard pattern pixmap for use as a background to transparent colors.

Definition at line 84 of file qgscolorbuttonv2.cpp.

Property Documentation

bool QgsColorButtonV2::acceptLiveUpdates

readwrite

Definition at line 38 of file qgscolorbuttonv2.h.

bool QgsColorButtonV2::allowAlpha

readwrite

Definition at line 40 of file qgscolorbuttonv2.h.

Behaviour QgsColorButtonV2::behaviour

readwrite

Definition at line 42 of file qgscolorbuttonv2.h.

QColor QgsColorButtonV2::color

readwrite

Definition at line 39 of file qgscolorbuttonv2.h.

QString QgsColorButtonV2::colorDialogTitle

readwrite

Definition at line 37 of file qgscolorbuttonv2.h.

QString QgsColorButtonV2::context

readwrite

Definition at line 46 of file qgscolorbuttonv2.h.

QColor QgsColorButtonV2::defaultColor

readwrite

Definition at line 43 of file qgscolorbuttonv2.h.

QString QgsColorButtonV2::noColorString

readwrite

Definition at line 45 of file qgscolorbuttonv2.h.

bool QgsColorButtonV2::showMenu

readwrite

Definition at line 41 of file qgscolorbuttonv2.h.

bool QgsColorButtonV2::showNoColor

readwrite

Definition at line 44 of file qgscolorbuttonv2.h.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgscolorbuttonv2.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgscolorbuttonv2.cpp