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]

Public Slots
void	setButtonBackground (QColor color=QColor())
	Sets the background pixmap for the button based upon 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=nullptr, const QString &cdt="", const QColorDialog::ColorDialogOptions &cdo=nullptr)
	Construct a new color button. More...

	~QgsColorButton ()

bool	acceptLiveUpdates ()
	Whether the button accepts live updates from QColorDialog. More...

QColor	color () const
	Return the currently selected color. More...

QColorDialog::ColorDialogOptions	colorDialogOptions ()
	Returns the options for the color chooser dialog. More...

QString	colorDialogTitle ()
	Returns the title, which the color chooser dialog shows. More...

void	setAcceptLiveUpdates (bool accept)
	Sets whether the button accepts live updates from QColorDialog. More...

void	setColor (const QColor &color)
	Specify the current color. More...

void	setColorDialogOptions (const QColorDialog::ColorDialogOptions &cdo)
	Specify the options for the color chooser dialog (e.g. More...

void	setColorDialogTitle (const QString &cdt)
	Set the title, which the color chooser dialog will show. More...

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

	QPushButton (const QString &text, QWidget *parent)

	QPushButton (QWidget parent, const char name)

	QPushButton (const QString &text, QWidget parent, const char name)

	QPushButton (const QIcon &icon, const QString &text, QWidget parent, const char name)

	QPushButton (const QIcon &icon, const QString &text, QWidget *parent)

	~QPushButton ()

bool	autoDefault () const

bool	isDefault () const

bool	isFlat () const

bool	isMenuButton () const

QMenu *	menu () const

virtual QSize	minimumSizeHint () const

void	openPopup ()

QMenu *	popup () const

void	setAutoDefault (bool)

void	setDefault (bool)

void	setFlat (bool)

void	setMenu (QMenu *menu)

void	setPopup (QMenu *popup)

void	showMenu ()

virtual QSize	sizeHint () 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	dropEvent (QDropEvent *e) override
	Reimplemented to accept dropped colors. More...

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	showEvent (QShowEvent *e) override

Protected Member Functions inherited from QPushButton
virtual bool	event (QEvent *e)

virtual void	focusInEvent (QFocusEvent *e)

virtual void	focusOutEvent (QFocusEvent *e)

virtual bool	hitButton (const QPoint &pos) const

void	initStyleOption (QStyleOptionButton *option) const

virtual void	paintEvent (QPaintEvent *)

Protected Member Functions inherited from QAbstractButton
virtual void	checkStateSet ()

virtual void	keyReleaseEvent (QKeyEvent *e)

virtual void	nextCheckState ()

virtual void	paintEvent (QPaintEvent *e)=0

virtual void	timerEvent (QTimerEvent *e)

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

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	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

virtual void	enterEvent (QEvent *event)

bool	focusNextChild ()

virtual bool	focusNextPrevChild (bool next)

bool	focusPreviousChild ()

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual void	languageChange ()

virtual void	leaveEvent (QEvent *event)

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	resizeEvent (QResizeEvent *event)

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 &	transpBkgrd ()

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

Properties
bool	acceptLiveUpdates

QColor	color

QColorDialog::ColorDialogOptions	colorDialogOptions

QString	colorDialogTitle

Properties inherited from QPushButton
	autoDefault

	default

	flat

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.

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::QgsColorButton	(	QWidget *	parent = `nullptr`,
		const QString &	cdt = `""`,
		const QColorDialog::ColorDialogOptions &	cdo = `nullptr`
	)

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

◆ ~QgsColorButton()

QgsColorButton::~QgsColorButton ( )

Definition at line 81 of file qgscolorbutton.cpp.

Member Function Documentation

◆ acceptLiveUpdates()

bool QgsColorButton::acceptLiveUpdates ( )

inline

Whether the button accepts live updates from QColorDialog.

Definition at line 96 of file qgscolorbutton.h.

◆ changeEvent()

void QgsColorButton::changeEvent ( QEvent * e )

overrideprotectedvirtual

Reimplemented from QAbstractButton.

Definition at line 396 of file qgscolorbutton.cpp.

◆ color()

QColor QgsColorButton::color ( ) const

Return the currently selected color.

Returns: the currently selected color

◆ colorChanged

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

◆ colorDialogOptions()

QColorDialog::ColorDialogOptions QgsColorButton::colorDialogOptions ( )

Returns the options for the color chooser dialog.

Returns: Options for the color chooser dialog

◆ colorDialogTitle()

QString QgsColorButton::colorDialogTitle ( )

Returns the title, which the color chooser dialog shows.

Returns: Title for the color chooser dialog

◆ dragEnterEvent()

void QgsColorButton::dragEnterEvent ( QDragEnterEvent * e )

overrideprotectedvirtual

Reimplemented to accept dragged colors.

Reimplemented from QWidget.

Definition at line 316 of file qgscolorbutton.cpp.

◆ dropEvent()

void QgsColorButton::dropEvent ( QDropEvent * e )

overrideprotectedvirtual

Reimplemented to accept dropped colors.

Reimplemented from QWidget.

Definition at line 326 of file qgscolorbutton.cpp.

◆ keyPressEvent()

void QgsColorButton::keyPressEvent ( QKeyEvent * e )

overrideprotectedvirtual

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

Reimplemented from QPushButton.

Definition at line 303 of file qgscolorbutton.cpp.

◆ mouseMoveEvent()

void QgsColorButton::mouseMoveEvent ( QMouseEvent * e )

overrideprotectedvirtual

Reimplemented to allow dragging colors from button.

Reimplemented from QAbstractButton.

Definition at line 216 of file qgscolorbutton.cpp.

◆ mousePressEvent()

void QgsColorButton::mousePressEvent ( QMouseEvent * e )

overrideprotectedvirtual

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

Reimplemented from QAbstractButton.

Definition at line 149 of file qgscolorbutton.cpp.

◆ mouseReleaseEvent()

void QgsColorButton::mouseReleaseEvent ( QMouseEvent * e )

overrideprotectedvirtual

Reimplemented to allow color picking.

Reimplemented from QAbstractButton.

Definition at line 270 of file qgscolorbutton.cpp.

◆ setAcceptLiveUpdates()

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.

Definition at line 102 of file qgscolorbutton.h.

◆ setButtonBackground

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

Definition at line 446 of file qgscolorbutton.cpp.

◆ setColor()

void QgsColorButton::setColor ( const QColor & color )

Specify the current color.

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

Parameters

color the new color

Definition at line 423 of file qgscolorbutton.cpp.

◆ setColorDialogOptions()

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

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

alpha).

Parameters

cdo	Options for the color chooser dialog

Definition at line 581 of file qgscolorbutton.cpp.

◆ setColorDialogTitle()

void QgsColorButton::setColorDialogTitle ( const QString & cdt )

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

Parameters

cdt	Title for the color chooser dialog

Definition at line 591 of file qgscolorbutton.cpp.

◆ showEvent()

void QgsColorButton::showEvent ( QShowEvent * e )

overrideprotectedvirtual

Reimplemented from QWidget.

Definition at line 417 of file qgscolorbutton.cpp.

◆ transpBkgrd()

const QPixmap & QgsColorButton::transpBkgrd ( )

staticprotected

Definition at line 87 of file qgscolorbutton.cpp.

Property Documentation

◆ acceptLiveUpdates

bool QgsColorButton::acceptLiveUpdates

readwrite

Definition at line 35 of file qgscolorbutton.h.

◆ color

QColor QgsColorButton::color

readwrite

Definition at line 36 of file qgscolorbutton.h.

◆ colorDialogOptions

QColorDialog::ColorDialogOptions QgsColorButton::colorDialogOptions

readwrite

Definition at line 38 of file qgscolorbutton.h.

◆ colorDialogTitle

QString QgsColorButton::colorDialogTitle

readwrite

Definition at line 34 of file qgscolorbutton.h.

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

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

Public Slots

Signals

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsColorButton()

◆ ~QgsColorButton()

Member Function Documentation

◆ acceptLiveUpdates()

◆ changeEvent()

◆ color()

◆ colorChanged

◆ colorDialogOptions()

◆ colorDialogTitle()

◆ dragEnterEvent()

◆ dropEvent()

◆ keyPressEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ setAcceptLiveUpdates()

◆ setButtonBackground

◆ setColor()

◆ setColorDialogOptions()

◆ setColorDialogTitle()

◆ showEvent()

◆ transpBkgrd()

Property Documentation

◆ acceptLiveUpdates

◆ color

◆ colorDialogOptions

◆ colorDialogTitle