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

#include <qgscolorbuttonv2.h>

Inheritance diagram for QgsColorButtonV2:

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
	QgsColorButtonV2 (QWidget parent=nullptr, const QString &cdt="", QgsColorSchemeRegistry registry=nullptr)
	Construct a new color button. More...

virtual	~QgsColorButtonV2 ()

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

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

Public Member Functions inherited from QToolButton
	QToolButton (QWidget *parent)

	QToolButton (QWidget parent, const char name)

	QToolButton (Qt::ArrowType type, QWidget parent, const char name)

	QToolButton (const QIcon &icon, const QString &textLabel, const QString &statusTip, QObject receiver, const char slot, QWidget parent, const char name)

	~QToolButton ()

Qt::ArrowType	arrowType () const

bool	autoRaise () const

QAction *	defaultAction () const

QIcon	iconSet () const

QIcon	iconSet (bool on) const

QMenu *	menu () const

virtual QSize	minimumSizeHint () const

QIcon	offIconSet () const

QIcon	onIconSet () const

void	openPopup ()

QMenu *	popup () const

int	popupDelay () const

ToolButtonPopupMode	popupMode () const

void	setArrowType (Qt::ArrowType type)

void	setAutoRaise (bool enable)

void	setDefaultAction (QAction *action)

void	setIconSet (const QIcon &icon)

void	setIconSet (const QIcon &set, bool on)

void	setMenu (QMenu *menu)

void	setOffIconSet (const QIcon &set)

void	setOnIconSet (const QIcon &set)

void	setPixmap (const QPixmap &pixmap)

void	setPopup (QMenu *popup)

void	setPopupDelay (int delay)

void	setPopupMode (ToolButtonPopupMode mode)

void	setTextLabel (const QString &text, bool tooltip)

void	setTextPosition (QToolButton::TextPosition pos)

void	setToolButtonStyle (Qt::ToolButtonStyle style)

void	setUsesBigPixmap (bool enable)

void	setUsesTextLabel (bool enable)

void	showMenu ()

QString	textLabel () const

TextPosition	textPosition () const

Qt::ToolButtonStyle	toolButtonStyle () const

void	triggered (QAction *action)

bool	usesBigPixmap () const

bool	usesTextLabel () const

Public Member Functions inherited from QAbstractButton
	QAbstractButton (QWidget *parent)

	QAbstractButton (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QAbstractButton ()

QKeySequence	accel () const

void	animateClick (int msec)

bool	autoExclusive () const

bool	autoRepeat () const

int	autoRepeatDelay () const

int	autoRepeatInterval () const

void	click ()

void	clicked (bool checked)

QButtonGroup *	group () const

QIcon	icon () const

QIcon *	iconSet () const

QSize	iconSize () const

bool	isCheckable () const

bool	isChecked () const

bool	isDown () const

bool	isOn () const

bool	isToggleButton () const

const QPixmap *	pixmap () const

void	pressed ()

void	released ()

void	setAccel (const QKeySequence &key)

void	setAutoExclusive (bool)

void	setAutoRepeat (bool)

void	setAutoRepeatDelay (int)

void	setAutoRepeatInterval (int)

void	setCheckable (bool)

void	setChecked (bool)

void	setDown (bool)

void	setIcon (const QIcon &icon)

void	setIconSet (const QIcon &icon)

void	setIconSize (const QSize &size)

void	setOn (bool b)

void	setPixmap (const QPixmap &p)

void	setShortcut (const QKeySequence &key)

void	setText (const QString &text)

void	setToggleButton (bool b)

QKeySequence	shortcut () const

QString	text () const

void	toggle ()

void	toggled (bool checked)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent, QFlags< Qt::WindowType > f)

	QWidget (QWidget parent, const char name, QFlags< Qt::WindowType > f)

	~QWidget ()

bool	acceptDrops () const

QString	accessibleDescription () const

QString	accessibleName () const

QList< QAction * >	actions () const

void	activateWindow ()

void	addAction (QAction *action)

void	addActions (QList< QAction * > actions)

void	adjustSize ()

bool	autoFillBackground () const

Qt::BackgroundMode	backgroundMode () const

QPoint	backgroundOffset () const

BackgroundOrigin	backgroundOrigin () const

QPalette::ColorRole	backgroundRole () const

QSize	baseSize () const

QString	caption () const

QWidget *	childAt (int x, int y, bool includeThis) const

QWidget *	childAt (const QPoint &p, bool includeThis) const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

QRect	childrenRect () const

QRegion	childrenRegion () const

void	clearFocus ()

void	clearMask ()

bool	close (bool alsoDelete)

bool	close ()

QColorGroup	colorGroup () const

void	constPolish () const

QMargins	contentsMargins () const

QRect	contentsRect () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

QCursor	cursor () const

void	customContextMenuRequested (const QPoint &pos)

void	drawText (const QPoint &p, const QString &s)

void	drawText (int x, int y, const QString &s)

WId	effectiveWinId () const

void	ensurePolished () const

void	erase ()

void	erase (const QRect &rect)

void	erase (const QRegion &rgn)

void	erase (int x, int y, int w, int h)

Qt::FocusPolicy	focusPolicy () const

QWidget *	focusProxy () const

QWidget *	focusWidget () const

const QFont &	font () const

QFontInfo	fontInfo () const

QFontMetrics	fontMetrics () const

QPalette::ColorRole	foregroundRole () const

QRect	frameGeometry () const

QSize	frameSize () const

const QRect &	geometry () const

void	getContentsMargins (int left, int top, int right, int bottom) const

virtual HDC	getDC () const

void	grabGesture (Qt::GestureType gesture, QFlags< Qt::GestureFlag > flags)

void	grabKeyboard ()

void	grabMouse ()

void	grabMouse (const QCursor &cursor)

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)

QGraphicsEffect *	graphicsEffect () const

QGraphicsProxyWidget *	graphicsProxyWidget () const

bool	hasEditFocus () const

bool	hasFocus () const

bool	hasMouse () const

bool	hasMouseTracking () const

int	height () const

virtual int	heightForWidth (int w) const

void	hide ()

const QPixmap *	icon () const

void	iconify ()

QString	iconText () const

QInputContext *	inputContext ()

Qt::InputMethodHints	inputMethodHints () const

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

void	insertAction (QAction before, QAction action)

void	insertActions (QAction before, QList< QAction > actions)

bool	isActiveWindow () const

bool	isAncestorOf (const QWidget *child) const

bool	isDesktop () const

bool	isDialog () const

bool	isEnabled () const

bool	isEnabledTo (QWidget *ancestor) const

bool	isEnabledToTLW () const

bool	isFullScreen () const

bool	isHidden () const

bool	isInputMethodEnabled () const

bool	isMaximized () const

bool	isMinimized () const

bool	isModal () const

bool	isPopup () const

bool	isShown () const

bool	isTopLevel () const

bool	isUpdatesEnabled () const

bool	isVisible () const

bool	isVisibleTo (QWidget *ancestor) const

bool	isVisibleToTLW () const

bool	isWindow () const

bool	isWindowModified () const

QLayout *	layout () const

Qt::LayoutDirection	layoutDirection () const

QLocale	locale () const

void	lower ()

Qt::HANDLE	macCGHandle () const

Qt::HANDLE	macQDHandle () const

QPoint	mapFrom (QWidget *parent, const QPoint &pos) const

QPoint	mapFromGlobal (const QPoint &pos) const

QPoint	mapFromParent (const QPoint &pos) const

QPoint	mapTo (QWidget *parent, const QPoint &pos) const

QPoint	mapToGlobal (const QPoint &pos) const

QPoint	mapToParent (const QPoint &pos) const

QRegion	mask () const

int	maximumHeight () const

QSize	maximumSize () const

int	maximumWidth () const

int	minimumHeight () const

QSize	minimumSize () const

int	minimumWidth () const

void	move (int x, int y)

void	move (const QPoint &)

QWidget *	nativeParentWidget () const

QWidget *	nextInFocusChain () const

QRect	normalGeometry () const

void	overrideWindowFlags (QFlags< Qt::WindowType > flags)

bool	ownCursor () const

bool	ownFont () const

bool	ownPalette () const

virtual QPaintEngine *	paintEngine () const

const QPalette &	palette () const

QWidget *	parentWidget (bool sameWindow) const

QWidget *	parentWidget () const

QPlatformWindow *	platformWindow () const

QPlatformWindowFormat	platformWindowFormat () const

void	polish ()

QPoint	pos () const

QWidget *	previousInFocusChain () const

void	raise ()

void	recreate (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

QRect	rect () const

virtual void	releaseDC (HDC hdc) const

void	releaseKeyboard ()

void	releaseMouse ()

void	releaseShortcut (int id)

void	removeAction (QAction *action)

void	render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QFlags< QWidget::RenderFlag > renderFlags)

void	repaint (int x, int y, int w, int h, bool b)

void	repaint (const QRegion &rgn, bool b)

void	repaint ()

void	repaint (int x, int y, int w, int h)

void	repaint (const QRegion &rgn)

void	repaint (bool b)

void	repaint (const QRect &rect)

void	repaint (const QRect &r, bool b)

void	reparent (QWidget *parent, QFlags< Qt::WindowType > f, const QPoint &p, bool showIt)

void	reparent (QWidget *parent, const QPoint &p, bool showIt)

void	resize (int w, int h)

void	resize (const QSize &)

bool	restoreGeometry (const QByteArray &geometry)

QByteArray	saveGeometry () const

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &r)

void	setAcceptDrops (bool on)

void	setAccessibleDescription (const QString &description)

void	setAccessibleName (const QString &name)

void	setActiveWindow ()

void	setAttribute (Qt::WidgetAttribute attribute, bool on)

void	setAutoFillBackground (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setBackgroundMode (Qt::BackgroundMode widgetBackground, Qt::BackgroundMode paletteBackground)

void	setBackgroundOrigin (BackgroundOrigin background)

void	setBackgroundPixmap (const QPixmap &pixmap)

void	setBackgroundRole (QPalette::ColorRole role)

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setCaption (const QString &c)

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	setCursor (const QCursor &)

void	setDisabled (bool disable)

void	setEditFocus (bool enable)

void	setEnabled (bool)

void	setEraseColor (const QColor &color)

void	setErasePixmap (const QPixmap &pixmap)

void	setFixedHeight (int h)

void	setFixedSize (const QSize &s)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFocus (Qt::FocusReason reason)

void	setFocus ()

void	setFocusPolicy (Qt::FocusPolicy policy)

void	setFocusProxy (QWidget *w)

void	setFont (const QFont &)

void	setFont (const QFont &f, bool b)

void	setForegroundRole (QPalette::ColorRole role)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

void	setGraphicsEffect (QGraphicsEffect *effect)

void	setHidden (bool hidden)

void	setIcon (const QPixmap &i)

void	setIconText (const QString &it)

void	setInputContext (QInputContext *context)

void	setInputMethodEnabled (bool enabled)

void	setInputMethodHints (QFlags< Qt::InputMethodHint > hints)

void	setKeyCompression (bool b)

void	setLayout (QLayout *layout)

void	setLayoutDirection (Qt::LayoutDirection direction)

void	setLocale (const QLocale &locale)

void	setMask (const QBitmap &bitmap)

void	setMask (const QRegion &region)

void	setMaximumHeight (int maxh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMaximumWidth (int maxw)

void	setMinimumHeight (int minh)

void	setMinimumSize (int minw, int minh)

void	setMinimumSize (const QSize &)

void	setMinimumWidth (int minw)

void	setMouseTracking (bool enable)

void	setPalette (const QPalette &)

void	setPalette (const QPalette &p, bool b)

void	setPaletteBackgroundColor (const QColor &color)

void	setPaletteBackgroundPixmap (const QPixmap &pixmap)

void	setPaletteForegroundColor (const QColor &color)

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, QFlags< Qt::WindowType > f)

void	setPlatformWindow (QPlatformWindow *window)

void	setPlatformWindowFormat (const QPlatformWindowFormat &format)

void	setShortcutAutoRepeat (int id, bool enable)

void	setShortcutEnabled (int id, bool enable)

void	setShown (bool shown)

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

void	setSizePolicy (QSizePolicy::Policy hor, QSizePolicy::Policy ver, bool hfw)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

void	setSizePolicy (QSizePolicy)

void	setStatusTip (const QString &)

void	setStyle (QStyle *style)

QStyle *	setStyle (const QString &style)

void	setStyleSheet (const QString &styleSheet)

void	setToolTip (const QString &)

void	setUpdatesEnabled (bool enable)

void	setupUi (QWidget *widget)

virtual void	setVisible (bool visible)

void	setWhatsThis (const QString &)

void	setWindowFilePath (const QString &filePath)

void	setWindowFlags (QFlags< Qt::WindowType > type)

void	setWindowIcon (const QIcon &icon)

void	setWindowIconText (const QString &)

void	setWindowModality (Qt::WindowModality windowModality)

void	setWindowModified (bool)

void	setWindowOpacity (qreal level)

void	setWindowRole (const QString &role)

void	setWindowState (QFlags< Qt::WindowState > windowState)

void	setWindowSurface (QWindowSurface *surface)

void	setWindowTitle (const QString &)

void	show ()

void	showFullScreen ()

void	showMaximized ()

void	showMinimized ()

void	showNormal ()

QSize	size () const

QSize	sizeIncrement () const

QSizePolicy	sizePolicy () const

void	stackUnder (QWidget *w)

QString	statusTip () const

QStyle *	style () const

QString	styleSheet () const

bool	testAttribute (Qt::WidgetAttribute attribute) const

QString	toolTip () const

QWidget *	topLevelWidget () const

bool	underMouse () const

void	ungrabGesture (Qt::GestureType gesture)

void	unsetCursor ()

void	unsetFont ()

void	unsetLayoutDirection ()

void	unsetLocale ()

void	unsetPalette ()

void	update (const QRect &rect)

void	update (const QRegion &rgn)

void	update (int x, int y, int w, int h)

void	update ()

void	updateGeometry ()

bool	updatesEnabled () const

QRect	visibleRect () const

QRegion	visibleRegion () const

QString	whatsThis () const

int	width () const

QWidget *	window () const

QString	windowFilePath () const

Qt::WindowFlags	windowFlags () const

QIcon	windowIcon () const

QString	windowIconText () const

Qt::WindowModality	windowModality () const

qreal	windowOpacity () const

QString	windowRole () const

Qt::WindowStates	windowState () const

QWindowSurface *	windowSurface () const

QString	windowTitle () const

Qt::WindowType	windowType () const

WId	winId () const

int	x () const

const QX11Info &	x11Info () const

Qt::HANDLE	x11PictureHandle () const

int	y () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

int	colorCount () const

int	depth () const

int	height () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	numColors () const

virtual QPaintEngine *	paintEngine () const=0

bool	paintingActive () const

int	physicalDpiX () const

int	physicalDpiY () const

int	width () const

int	widthMM () const

int	x11Cells () const

Qt::HANDLE	x11Colormap () const

bool	x11DefaultColormap () const

bool	x11DefaultVisual () const

int	x11Depth () const

Display *	x11Display () const

int	x11Screen () const

void *	x11Visual () const

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

Protected Member Functions inherited from QToolButton
virtual void	actionEvent (QActionEvent *event)

virtual void	enterEvent (QEvent *e)

virtual bool	hitButton (const QPoint &pos) const

void	initStyleOption (QStyleOptionToolButton *option) const

virtual void	leaveEvent (QEvent *e)

virtual void	nextCheckState ()

virtual void	paintEvent (QPaintEvent *event)

virtual void	timerEvent (QTimerEvent *e)

Protected Member Functions inherited from QAbstractButton
virtual void	checkStateSet ()

virtual void	focusInEvent (QFocusEvent *e)

virtual void	focusOutEvent (QFocusEvent *e)

virtual void	keyReleaseEvent (QKeyEvent *e)

Protected Member Functions inherited from QWidget
virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	create (WId window, bool initializeWindow, bool destroyOldWindow)

void	destroy (bool destroyWindow, bool destroySubWindows)

virtual void	dragMoveEvent (QDragMoveEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	languageChange ()

virtual bool	macEvent (EventHandlerCallRef caller, EventRef event)

virtual int	metric (PaintDeviceMetric m) const

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual bool	qwsEvent (QWSEvent *event)

void	resetInputContext ()

virtual void	tabletEvent (QTabletEvent *event)

void	updateMicroFocus ()

virtual void	wheelEvent (QWheelEvent *event)

virtual bool	winEvent (MSG message, long result)

virtual bool	x11Event (XEvent *event)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

Protected Member Functions inherited from QPaintDevice
	QPaintDevice ()

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

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties
bool	acceptLiveUpdates

bool	allowAlpha

Behaviour	behaviour

QColor	color

QString	colorDialogTitle

QString	context

QColor	defaultColor

QString	noColorString

bool	showMenu

bool	showNoColor

Properties inherited from QToolButton
	arrowType

	autoRaise

	popupMode

	toolButtonStyle

Properties inherited from QAbstractButton
	autoExclusive

	autoRepeat

	autoRepeatDelay

	autoRepeatInterval

	checkable

	checked

	down

	icon

	iconSize

	shortcut

	text

Properties inherited from QWidget
	acceptDrops

	accessibleDescription

	accessibleName

	autoFillBackground

	baseSize

	childrenRect

	childrenRegion

	contextMenuPolicy

	cursor

	enabled

	focus

	focusPolicy

	font

	frameGeometry

	frameSize

	fullScreen

	geometry

	height

	inputMethodHints

	isActiveWindow

	layoutDirection

	locale

	maximized

	maximumHeight

	maximumSize

	maximumWidth

	minimized

	minimumHeight

	minimumSize

	minimumSizeHint

	minimumWidth

	modal

	mouseTracking

	normalGeometry

	palette

	pos

	rect

	size

	sizeHint

	sizeIncrement

	sizePolicy

	statusTip

	styleSheet

	toolTip

	updatesEnabled

	visible

	whatsThis

	width

	windowFilePath

	windowFlags

	windowIcon

	windowIconText

	windowModality

	windowModified

	windowOpacity

	windowTitle

	x

	y

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QWidget
QWidget *	find (WId id)

QWidget *	keyboardGrabber ()

QWidget *	mouseGrabber ()

void	setTabOrder (QWidget first, QWidget second)

QWidgetMapper *	wmapper ()

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Public Member Functions inherited from QPaintDevice
int	x11AppCells (int screen)

Qt::HANDLE	x11AppColormap (int screen)

bool	x11AppDefaultColormap (int screen)

bool	x11AppDefaultVisual (int screen)

int	x11AppDepth (int screen)

Display *	x11AppDisplay ()

int	x11AppDpiX (int screen)

int	x11AppDpiY (int screen)

Qt::HANDLE	x11AppRootWindow (int screen)

int	x11AppScreen ()

void *	x11AppVisual (int screen)

void	x11SetAppDpiX (int dpi, int screen)

void	x11SetAppDpiY (int dpi, int screen)

Public Attributes inherited from QWidget
typedef	RenderFlags

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 35 of file qgscolorbuttonv2.h.

Member Enumeration Documentation

◆ Behaviour

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 54 of file qgscolorbuttonv2.h.

Constructor & Destructor Documentation

◆ QgsColorButtonV2()

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

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::~QgsColorButtonV2 ( )

virtual

Definition at line 71 of file qgscolorbuttonv2.cpp.

Member Function Documentation

◆ acceptLiveUpdates()

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 108 of file qgscolorbuttonv2.h.

◆ activatePicker

void QgsColorButtonV2::activatePicker ( )

slot

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

Definition at line 688 of file qgscolorbuttonv2.cpp.

◆ allowAlpha()

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 90 of file qgscolorbuttonv2.h.

◆ behaviour()

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 141 of file qgscolorbuttonv2.h.

◆ changeEvent()

void QgsColorButtonV2::changeEvent ( QEvent * e )

overrideprotectedvirtual

Reimplemented from QToolButton.

Definition at line 539 of file qgscolorbuttonv2.cpp.

◆ color()

QColor QgsColorButtonV2::color ( ) const

Return the currently selected color.

Returns: currently selected color

See also: setColor

◆ colorChanged

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

◆ colorClicked

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

◆ colorDialogTitle()

QString QgsColorButtonV2::colorDialogTitle ( ) const

Returns the title for the color chooser dialog window.

Returns: title for the color chooser dialog

See also: setColorDialogTitle

◆ colorSchemeRegistry()

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 249 of file qgscolorbuttonv2.h.

◆ context()

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 233 of file qgscolorbuttonv2.h.

◆ copyColor

void QgsColorButtonV2::copyColor ( )

slot

Copies the current color to the clipboard.

See also: pasteColor

Definition at line 671 of file qgscolorbuttonv2.cpp.

◆ defaultColor()

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 157 of file qgscolorbuttonv2.h.

◆ dragEnterEvent()

void QgsColorButtonV2::dragEnterEvent ( QDragEnterEvent * e )

overrideprotectedvirtual

Reimplemented to accept dragged colors.

Reimplemented from QWidget.

Definition at line 347 of file qgscolorbuttonv2.cpp.

◆ dragLeaveEvent()

void QgsColorButtonV2::dragLeaveEvent ( QDragLeaveEvent * e )

overrideprotectedvirtual

Reimplemented to reset button appearance after drag leave.

Reimplemented from QWidget.

Definition at line 361 of file qgscolorbuttonv2.cpp.

◆ dropEvent()

void QgsColorButtonV2::dropEvent ( QDropEvent * e )

overrideprotectedvirtual

Reimplemented to accept dropped colors.

Reimplemented from QWidget.

Definition at line 368 of file qgscolorbuttonv2.cpp.

◆ event()

bool QgsColorButtonV2::event ( QEvent * e )

overrideprotectedvirtual

Reimplemented from QToolButton.

Definition at line 183 of file qgscolorbuttonv2.cpp.

◆ isNull()

bool QgsColorButtonV2::isNull ( ) const

Returns true if the current color is null.

Note: added in QGIS 2.16

See also: setShowNull(); showNull()

Definition at line 747 of file qgscolorbuttonv2.cpp.

◆ keyPressEvent()

void QgsColorButtonV2::keyPressEvent ( QKeyEvent * e )

overrideprotectedvirtual

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

Reimplemented from QAbstractButton.

Definition at line 334 of file qgscolorbuttonv2.cpp.

◆ mouseMoveEvent()

void QgsColorButtonV2::mouseMoveEvent ( QMouseEvent * e )

overrideprotectedvirtual

Reimplemented to allow dragging colors from button.

Reimplemented from QAbstractButton.

Definition at line 257 of file qgscolorbuttonv2.cpp.

◆ mousePressEvent()

void QgsColorButtonV2::mousePressEvent ( QMouseEvent * e )

overrideprotectedvirtual

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

Reimplemented from QToolButton.

Definition at line 211 of file qgscolorbuttonv2.cpp.

◆ mouseReleaseEvent()

void QgsColorButtonV2::mouseReleaseEvent ( QMouseEvent * e )

overrideprotectedvirtual

Reimplemented to allow color picking.

Reimplemented from QToolButton.

Definition at line 299 of file qgscolorbuttonv2.cpp.

◆ noColorString()

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 217 of file qgscolorbuttonv2.h.

◆ pasteColor

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 677 of file qgscolorbuttonv2.cpp.

◆ resizeEvent()

void QgsColorButtonV2::resizeEvent ( QResizeEvent * event )

overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 566 of file qgscolorbuttonv2.cpp.

◆ setAcceptLiveUpdates()

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 115 of file qgscolorbuttonv2.h.

◆ setAllowAlpha()

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 703 of file qgscolorbuttonv2.cpp.

◆ setBehaviour()

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 727 of file qgscolorbuttonv2.cpp.

◆ setButtonBackground

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 598 of file qgscolorbuttonv2.cpp.

◆ setColor

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 574 of file qgscolorbuttonv2.cpp.

◆ setColorDialogTitle()

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 708 of file qgscolorbuttonv2.cpp.

◆ setColorSchemeRegistry()

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 241 of file qgscolorbuttonv2.h.

◆ setContext()

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 225 of file qgscolorbuttonv2.h.

◆ setDefaultColor()

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 732 of file qgscolorbuttonv2.cpp.

◆ setNoColorString()

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 186 of file qgscolorbuttonv2.h.

◆ setShowMenu()

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 718 of file qgscolorbuttonv2.cpp.

◆ setShowNoColor()

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 167 of file qgscolorbuttonv2.h.

◆ setShowNull()

void QgsColorButtonV2::setShowNull ( bool showNull )

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

Parameters

showNull set to true to show a null option

Note: added in QGIS 2.16

See also: showNull(); isNull()

Definition at line 737 of file qgscolorbuttonv2.cpp.

◆ setToDefaultColor

void QgsColorButtonV2::setToDefaultColor ( )

slot

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

See also: setDefaultColor; defaultColor; setToNull()

Definition at line 168 of file qgscolorbuttonv2.cpp.

◆ setToNoColor

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.

See also: setToNull()

Definition at line 201 of file qgscolorbuttonv2.cpp.

◆ setToNull

void QgsColorButtonV2::setToNull ( )

slot

Sets color to null.

See also: setToDefaultColor(); setToNoColor()

Note: added in QGIS 2.16

Definition at line 178 of file qgscolorbuttonv2.cpp.

◆ showEvent()

void QgsColorButtonV2::showEvent ( QShowEvent * e )

overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 560 of file qgscolorbuttonv2.cpp.

◆ showMenu()

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 128 of file qgscolorbuttonv2.h.

◆ showNoColor()

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 177 of file qgscolorbuttonv2.h.

◆ showNull()

bool QgsColorButtonV2::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 742 of file qgscolorbuttonv2.cpp.

◆ sizeHint()

QSize QgsColorButtonV2::sizeHint ( ) const

overridevirtual

Reimplemented from QToolButton.

Definition at line 75 of file qgscolorbuttonv2.cpp.

◆ transparentBackground()

const QPixmap & QgsColorButtonV2::transparentBackground ( )

staticprotected

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

Definition at line 85 of file qgscolorbuttonv2.cpp.

Property Documentation

◆ acceptLiveUpdates

bool QgsColorButtonV2::acceptLiveUpdates

readwrite

Definition at line 40 of file qgscolorbuttonv2.h.

◆ allowAlpha

bool QgsColorButtonV2::allowAlpha

readwrite

Definition at line 42 of file qgscolorbuttonv2.h.

◆ behaviour

Behaviour QgsColorButtonV2::behaviour

readwrite

Definition at line 44 of file qgscolorbuttonv2.h.

◆ color

QColor QgsColorButtonV2::color

readwrite

Definition at line 41 of file qgscolorbuttonv2.h.

◆ colorDialogTitle

QString QgsColorButtonV2::colorDialogTitle

readwrite

Definition at line 39 of file qgscolorbuttonv2.h.

◆ context

QString QgsColorButtonV2::context

readwrite

Definition at line 48 of file qgscolorbuttonv2.h.

◆ defaultColor

QColor QgsColorButtonV2::defaultColor

readwrite

Definition at line 45 of file qgscolorbuttonv2.h.

◆ noColorString

QString QgsColorButtonV2::noColorString

readwrite

Definition at line 47 of file qgscolorbuttonv2.h.

◆ showMenu

bool QgsColorButtonV2::showMenu

readwrite

Definition at line 43 of file qgscolorbuttonv2.h.

◆ showNoColor

bool QgsColorButtonV2::showNoColor

readwrite

Definition at line 46 of file qgscolorbuttonv2.h.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/gui/qgscolorbuttonv2.h
/tmp/buildd/qgis-2.18.21+99unstable/src/gui/qgscolorbuttonv2.cpp

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Behaviour

Constructor & Destructor Documentation

◆ QgsColorButtonV2()

◆ ~QgsColorButtonV2()

Member Function Documentation

◆ acceptLiveUpdates()

◆ activatePicker

◆ allowAlpha()

◆ behaviour()

◆ changeEvent()

◆ color()

◆ colorChanged

◆ colorClicked

◆ colorDialogTitle()

◆ colorSchemeRegistry()

◆ context()

◆ copyColor

◆ defaultColor()

◆ dragEnterEvent()

◆ dragLeaveEvent()

◆ dropEvent()

◆ event()

◆ isNull()

◆ keyPressEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ noColorString()

◆ pasteColor

◆ resizeEvent()

◆ setAcceptLiveUpdates()

◆ setAllowAlpha()

◆ setBehaviour()

◆ setButtonBackground

◆ setColor

◆ setColorDialogTitle()

◆ setColorSchemeRegistry()

◆ setContext()

◆ setDefaultColor()

◆ setNoColorString()

◆ setShowMenu()

◆ setShowNoColor()

◆ setShowNull()

◆ setToDefaultColor

◆ setToNoColor

◆ setToNull

◆ showEvent()

◆ showMenu()

◆ showNoColor()

◆ showNull()

◆ sizeHint()

◆ transparentBackground()

Property Documentation

◆ acceptLiveUpdates

◆ allowAlpha

◆ behaviour

◆ color

◆ colorDialogTitle

◆ context

◆ defaultColor

◆ noColorString

◆ showMenu

◆ showNoColor