The QtxColorButton class implements a widget for color preference items editing. More...

#include <QtxColorButton.h>

Inheritance diagram for QtxColorButton:

Signals
void	clicked (QColor)
	This signal is emitted when the widget button is clicked by the user. More...

void	changed (QColor)
	This signal is emitted when the current color is changed. More...

Public Member Functions
	QtxColorButton (QWidget *=0)
	Constructor. More...

virtual	~QtxColorButton ()
	Destructor. More...

QColor	color () const
	Get currently selected color. More...

void	setColor (const QColor &)
	Set color. More...

bool	eventFilter (QObject , QEvent )
	Filter events for the child widgets. More...

bool	isAutoEnabled () const
	Returns the status of "auto" color button in popup widget. More...

void	setAutoEnabled (bool)
	Enable/disable the "auto" color button in popup widget. More...

QString	autoText () const
	Returns text of the "auto" color button in popup widget. More...

void	setAutoText (const QString &)
	Sets text of the "auto" color button in popup widget. More...

QSize	sizeHint () const
	Get size hint for this widget. More...

Protected Member Functions
virtual void	paintEvent (QPaintEvent *)
	Customize paint event for the widget. More...

Private Types
typedef QMap< const QToolButton *, QColor >	ColorMap

Private Slots
void	onClicked (bool)
	Called when the button is clicked by the user. More...

void	onToggled (bool)
	Called when any color selection button from popup menu is clicked. More...

void	onAboutToShow ()
	Called when the popup menu is about to show. More...

void	onAutoClicked (bool)
	Called the "Auto" child button from popup menu is clicked. More...

void	onDialogClicked (bool)
	Called the "Other colors" child button from popup menu is clicked. More...

Private Member Functions
QList< QColor >	colorsList () const
	Get predefined list of colors to be used in the popup menu. More...

void	updateState ()
	Update widget state. More...

void	updateButton (QToolButton *)
	Update child button state. More...

QPixmap	buttonIcon (const QColor &) const
	Generate (if necessary) or get the icon for the button. More...

void	drawColor (QPaintDevice *, const QColor &, const QColor &=Qt::black, const int=1) const
	Draw pixmap. More...

Private Attributes
ColorMap	myColors

QToolButton *	myAutoButton

Detailed Description

The color preference item is represented as the colored button with assocoiated popup menu whihc is called when the user presses the small arrow button near it. The popup menu allows selecting of the color from the predefined set. In addition it contains the button which invokes standard "Select color" dialog box.

Initial color value can be set with setColor() method. Chosen color can be retrieved with the color() method.

Member Typedef Documentation

typedef QMap<const QToolButton*, QColor> QtxColorButton::ColorMap

private

Constructor & Destructor Documentation

QtxColorButton::QtxColorButton ( QWidget * parent = 0 )

Parameters

parent parent widget

References clicked(), colorsList(), myAutoButton, myColors, onAboutToShow(), onAutoClicked(), onClicked(), onDialogClicked(), onToggled(), and updateButton().

QtxColorButton::~QtxColorButton ( )

virtual

Member Function Documentation

QString QtxColorButton::autoText ( ) const

References myAutoButton.

QPixmap QtxColorButton::buttonIcon ( const QColor & c ) const

private

Parameters

c	color to be used for the icon

Returns: icon pixmap for the button

References drawColor().

void QtxColorButton::changed ( QColor color )

signal

Parameters

color new current color

void QtxColorButton::clicked ( QColor color )

signal

Parameters

color current color

QColor QtxColorButton::color ( ) const

Returns null QColor if no color is selected.

Returns: selected color

See Also: setColor()

References myColors.

QList< QColor > QtxColorButton::colorsList ( ) const

private

Returns: list of colors

void QtxColorButton::drawColor	(	QPaintDevice *	pd,
		const QColor &	c,
		const QColor &	bc = `Qt::black`,
		const int	m = `1`
	)		const

private

Parameters

pd	paint device
c	color
m	margin

bool QtxColorButton::eventFilter	(	QObject *	o,
		QEvent *	e
	)

Parameters

o	event receiver object
e	event

Returns: true if the event should be filtered

References updateButton().

bool QtxColorButton::isAutoEnabled ( ) const

Returns: true if the "auto" button is enabled

References myAutoButton.

void QtxColorButton::onAboutToShow ( )

privateslot

Updates the menu and child widgets state.

References updateState().

void QtxColorButton::onAutoClicked ( bool )

privateslot

Sets the undefined (auto) color as current.

Parameters

on	(not used)

References setColor().

void QtxColorButton::onClicked ( bool )

privateslot

Emits the signal clicked( QColor ).

Parameters

on	button state (not used)

References clicked(), and color().

void QtxColorButton::onDialogClicked ( bool )

privateslot

Invokes standard "Select color" dialog box allowing user to select custom color. If the current color is changed by the user, emits the signal changed( QColor ).

Parameters