QGIS API Documentation  2.99.0-Master (e077efd)
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Properties | List of all members
QgsColorButton Class Reference

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

#include <qgscolorbutton.h>

Inheritance diagram for QgsColorButton:
Inheritance graph
[legend]

Public Types

enum  Behaviour { ShowDialog = 0, SignalOnly }
 Specifies the behaviour when the button is clicked. More...
 

Public Slots

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

Signals

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

Public Member Functions

 QgsColorButton (QWidget *parent=nullptr, const QString &cdt="", QgsColorSchemeRegistry *registry=nullptr)
 Construct a new color button. More...
 
virtual ~QgsColorButton ()
 
bool acceptLiveUpdates () const
 Returns whether the button accepts live updates from QColorDialog. More...
 
bool allowAlpha () const
 Returns whether alpha modification (transparency) is permitted for the color. More...
 
Behaviour behaviour () const
 Returns the behaviour for when the button is clicked. More...
 
QColor color () const
 Return the currently selected color. More...
 
QString colorDialogTitle () const
 Returns the title for the color chooser dialog window. More...
 
QgsColorSchemeRegistrycolorSchemeRegistry ()
 Returns the color scheme registry for the button, which controls the color swatch grids that are shown in the button's drop down menu. More...
 
QString context () const
 Returns the context string for the color button. More...
 
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. More...
 
bool isNull () const
 Returns true if the current color is null. More...
 
QString noColorString () const
 Returns the string used for the "no color" option in the button's drop down menu. More...
 
void setAcceptLiveUpdates (const bool accept)
 Sets whether the button accepts live updates from QColorDialog. More...
 
void setAllowAlpha (const bool allowAlpha)
 Sets whether alpha modification (transparency) is permitted for the color. More...
 
void setBehaviour (const Behaviour behaviour)
 Sets the behaviour for when the button is clicked. More...
 
void setColorDialogTitle (const QString &title)
 Set the title for the color chooser dialog window. More...
 
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. More...
 
void setContext (const QString &context)
 Sets the context string for the color button. More...
 
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. More...
 
void setNoColorString (const QString &noColorString)
 Sets the string to use for the "no color" option in the button's drop down menu. More...
 
void setShowMenu (const bool showMenu)
 Sets whether the drop down menu should be shown for the button. More...
 
void setShowNoColor (const bool showNoColorOption)
 Sets whether the "no color" option should be shown in the button's drop down menu. More...
 
void setShowNull (bool showNull)
 Sets whether a set to null (clear) option is shown in the button's drop down menu. More...
 
bool showMenu () const
 Returns whether the drop down menu is shown for the button. More...
 
bool showNoColor () const
 Returns whether the "no color" option is shown in the button's drop down menu. More...
 
bool showNull () const
 Returns whether the set to null (clear) option is shown in the button's drop down menu. More...
 
virtual QSize sizeHint () const override
 

Protected Member Functions

void changeEvent (QEvent *e) override
 
void dragEnterEvent (QDragEnterEvent *e) override
 Reimplemented to accept dragged colors. More...
 
void dragLeaveEvent (QDragLeaveEvent *e) override
 Reimplemented to reset button appearance after drag leave. More...
 
void dropEvent (QDropEvent *e) override
 Reimplemented to accept dropped colors. More...
 
bool event (QEvent *e) override
 
void keyPressEvent (QKeyEvent *e) override
 Reimplemented to allow cancelling color pick via keypress, and sample via space bar press. More...
 
void mouseMoveEvent (QMouseEvent *e) override
 Reimplemented to allow dragging colors from button. More...
 
void mousePressEvent (QMouseEvent *e) override
 Reimplemented to detect right mouse button clicks on the color button and allow dragging colors. More...
 
void mouseReleaseEvent (QMouseEvent *e) override
 Reimplemented to allow color picking. More...
 
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. More...
 

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 qgscolorbutton.h.

Member Enumeration Documentation

§ 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 53 of file qgscolorbutton.h.

Constructor & Destructor Documentation

§ QgsColorButton()

QgsColorButton::QgsColorButton ( QWidget *  parent = nullptr,
const QString &  cdt = "",
QgsColorSchemeRegistry registry = nullptr 
)

Construct a new color button.

Parameters
parentThe parent QWidget for the dialog
cdtThe title to show in the color chooser dialog
registrya 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 qgscolorbutton.cpp.

§ ~QgsColorButton()

QgsColorButton::~QgsColorButton ( )
virtual

Definition at line 71 of file qgscolorbutton.cpp.

Member Function Documentation

§ acceptLiveUpdates()

bool QgsColorButton::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 107 of file qgscolorbutton.h.

§ activatePicker

void QgsColorButton::activatePicker ( )
slot

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

Definition at line 667 of file qgscolorbutton.cpp.

§ allowAlpha()

bool QgsColorButton::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 89 of file qgscolorbutton.h.

§ behaviour()

Behaviour QgsColorButton::behaviour ( ) const
inline

Returns the behaviour for when the button is clicked.

Returns
behaviour when button is clicked
See also
setBehaviour

Definition at line 140 of file qgscolorbutton.h.

§ changeEvent()

void QgsColorButton::changeEvent ( QEvent *  e)
overrideprotected

Definition at line 518 of file qgscolorbutton.cpp.

§ color()

QColor QgsColorButton::color ( ) const

Return the currently selected color.

Returns
currently selected color
See also
setColor

§ colorChanged

void QgsColorButton::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
colorNew color

§ colorClicked

void QgsColorButton::colorClicked ( const QColor &  color)
signal

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

Parameters
colorbutton color
See also
setBehaviour
behaviour

§ colorDialogTitle()

QString QgsColorButton::colorDialogTitle ( ) const

Returns the title for the color chooser dialog window.

Returns
title for the color chooser dialog
See also
setColorDialogTitle

§ colorSchemeRegistry()

QgsColorSchemeRegistry* QgsColorButton::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 248 of file qgscolorbutton.h.

§ context()

QString QgsColorButton::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 232 of file qgscolorbutton.h.

§ copyColor

void QgsColorButton::copyColor ( )
slot

Copies the current color to the clipboard.

See also
pasteColor

Definition at line 650 of file qgscolorbutton.cpp.

§ defaultColor()

QColor QgsColorButton::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 156 of file qgscolorbutton.h.

§ dragEnterEvent()

void QgsColorButton::dragEnterEvent ( QDragEnterEvent *  e)
overrideprotected

Reimplemented to accept dragged colors.

Definition at line 335 of file qgscolorbutton.cpp.

§ dragLeaveEvent()

void QgsColorButton::dragLeaveEvent ( QDragLeaveEvent *  e)
overrideprotected

Reimplemented to reset button appearance after drag leave.

Definition at line 349 of file qgscolorbutton.cpp.

§ dropEvent()

void QgsColorButton::dropEvent ( QDropEvent *  e)
overrideprotected

Reimplemented to accept dropped colors.

Definition at line 356 of file qgscolorbutton.cpp.

§ event()

bool QgsColorButton::event ( QEvent *  e)
overrideprotected

Definition at line 171 of file qgscolorbutton.cpp.

§ isNull()

bool QgsColorButton::isNull ( ) const

Returns true if the current color is null.

Note
added in QGIS 2.16
See also
setShowNull()
showNull()

Definition at line 726 of file qgscolorbutton.cpp.

§ keyPressEvent()

void QgsColorButton::keyPressEvent ( QKeyEvent *  e)
overrideprotected

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

Definition at line 322 of file qgscolorbutton.cpp.

§ mouseMoveEvent()

void QgsColorButton::mouseMoveEvent ( QMouseEvent *  e)
overrideprotected

Reimplemented to allow dragging colors from button.

Definition at line 245 of file qgscolorbutton.cpp.

§ mousePressEvent()

void QgsColorButton::mousePressEvent ( QMouseEvent *  e)
overrideprotected

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

Definition at line 199 of file qgscolorbutton.cpp.

§ mouseReleaseEvent()

void QgsColorButton::mouseReleaseEvent ( QMouseEvent *  e)
overrideprotected

Reimplemented to allow color picking.

Definition at line 287 of file qgscolorbutton.cpp.

§ noColorString()

QString QgsColorButton::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 216 of file qgscolorbutton.h.

§ pasteColor

void QgsColorButton::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 656 of file qgscolorbutton.cpp.

§ resizeEvent()

void QgsColorButton::resizeEvent ( QResizeEvent *  event)
overrideprotected

Definition at line 545 of file qgscolorbutton.cpp.

§ setAcceptLiveUpdates()

void QgsColorButton::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
acceptset to true to enable live updates
See also
acceptLiveUpdates

Definition at line 114 of file qgscolorbutton.h.

§ setAllowAlpha()

void QgsColorButton::setAllowAlpha ( const bool  allowAlpha)

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

Defaults to false.

Parameters
allowAlphaset to true to allow alpha modification
See also
allowAlpha

Definition at line 682 of file qgscolorbutton.cpp.

§ setBehaviour()

void QgsColorButton::setBehaviour ( const Behaviour  behaviour)

Sets the behaviour for when the button is clicked.

The default behaviour is to show a color picker dialog.

Parameters
behaviourbehaviour when button is clicked
See also
behaviour

Definition at line 706 of file qgscolorbutton.cpp.

§ setButtonBackground

void QgsColorButton::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
colorColor for button background. If no color is specified, the button's current color will be used

Definition at line 577 of file qgscolorbutton.cpp.

§ setColor

void QgsColorButton::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
colornew color for the button
See also
color

Definition at line 553 of file qgscolorbutton.cpp.

§ setColorDialogTitle()

void QgsColorButton::setColorDialogTitle ( const QString &  title)

Set the title for the color chooser dialog window.

Parameters
titleTitle for the color chooser dialog
See also
colorDialogTitle

Definition at line 687 of file qgscolorbutton.cpp.

§ setColorSchemeRegistry()

void QgsColorButton::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
registrycolor 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 240 of file qgscolorbutton.h.

§ setContext()

void QgsColorButton::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
contextcontext string for the color button's color swatch grids
See also
context

Definition at line 224 of file qgscolorbutton.h.

§ setDefaultColor()

void QgsColorButton::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
colordefault color for the button. Set to an invalid QColor to disable the default color option.
See also
defaultColor

Definition at line 711 of file qgscolorbutton.cpp.

§ setNoColorString()

void QgsColorButton::setNoColorString ( const QString &  noColorString)
inline

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

Parameters
noColorStringstring 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 185 of file qgscolorbutton.h.

§ setShowMenu()

void QgsColorButton::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
showMenuset to false to hide the drop down menu
See also
showMenu

Definition at line 697 of file qgscolorbutton.cpp.

§ setShowNoColor()

void QgsColorButton::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
showNoColorOptionset 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 166 of file qgscolorbutton.h.

§ setShowNull()

void QgsColorButton::setShowNull ( bool  showNull)

Sets whether a set to null (clear) option is shown in the button's drop down menu.

Parameters
showNullset to true to show a null option
Note
added in QGIS 2.16
See also
showNull()
isNull()

Definition at line 716 of file qgscolorbutton.cpp.

§ setToDefaultColor

void QgsColorButton::setToDefaultColor ( )
slot

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

See also
setDefaultColor
defaultColor
setToNull()

Definition at line 156 of file qgscolorbutton.cpp.

§ setToNoColor

void QgsColorButton::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.
See also
setToNull()

Definition at line 189 of file qgscolorbutton.cpp.

§ setToNull

void QgsColorButton::setToNull ( )
slot

Sets color to null.

See also
setToDefaultColor()
setToNoColor()
Note
added in QGIS 2.16

Definition at line 166 of file qgscolorbutton.cpp.

§ showEvent()

void QgsColorButton::showEvent ( QShowEvent *  e)
overrideprotected

Definition at line 539 of file qgscolorbutton.cpp.

§ showMenu()

bool QgsColorButton::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 127 of file qgscolorbutton.h.

§ showNoColor()

bool QgsColorButton::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 176 of file qgscolorbutton.h.

§ showNull()

bool QgsColorButton::showNull ( ) const

Returns whether the set to null (clear) option is shown in the button's drop down menu.

Note
added in QGIS 2.16
See also
setShowNull()
isNull()

Definition at line 721 of file qgscolorbutton.cpp.

§ sizeHint()

QSize QgsColorButton::sizeHint ( ) const
overridevirtual

Definition at line 75 of file qgscolorbutton.cpp.

§ transparentBackground()

const QPixmap & QgsColorButton::transparentBackground ( )
staticprotected

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

Definition at line 85 of file qgscolorbutton.cpp.

Property Documentation

§ acceptLiveUpdates

bool QgsColorButton::acceptLiveUpdates
readwrite

Definition at line 39 of file qgscolorbutton.h.

§ allowAlpha

bool QgsColorButton::allowAlpha
readwrite

Definition at line 41 of file qgscolorbutton.h.

§ behaviour

Behaviour QgsColorButton::behaviour
readwrite

Definition at line 43 of file qgscolorbutton.h.

§ color

QColor QgsColorButton::color
readwrite

Definition at line 40 of file qgscolorbutton.h.

§ colorDialogTitle

QString QgsColorButton::colorDialogTitle
readwrite

Definition at line 38 of file qgscolorbutton.h.

§ context

QString QgsColorButton::context
readwrite

Definition at line 47 of file qgscolorbutton.h.

§ defaultColor

QColor QgsColorButton::defaultColor
readwrite

Definition at line 44 of file qgscolorbutton.h.

§ noColorString

QString QgsColorButton::noColorString
readwrite

Definition at line 46 of file qgscolorbutton.h.

§ showMenu

bool QgsColorButton::showMenu
readwrite

Definition at line 42 of file qgscolorbutton.h.

§ showNoColor

bool QgsColorButton::showNoColor
readwrite

Definition at line 45 of file qgscolorbutton.h.


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