QtxColorButton Class Reference

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.
void	changed (QColor)
	This signal is emitted when the current color is changed.
Public Member Functions
	QtxColorButton (QWidget *=0)
	Constructor.
virtual	~QtxColorButton ()
	Destructor.
QColor	color () const
	Get currently selected color.
void	setColor (const QColor &)
	Set color.
bool	eventFilter (QObject *, QEvent *)
	Filter events for the child widgets.
bool	isAutoEnabled () const
	Returns the status of "auto" color button in popup widget.
void	setAutoEnabled (bool)
	Enable/disable the "auto" color button in popup widget.
QString	autoText () const
	Returns text of the "auto" color button in popup widget.
void	setAutoText (const QString &)
	Sets text of the "auto" color button in popup widget.
Protected Member Functions
virtual void	paintEvent (QPaintEvent *)
	Customize paint event for the widget.
Private Types
typedef QMap< const QToolButton *, QColor >	ColorMap
Private Slots
void	onClicked (bool)
	Called when the button is clicked by the user.
void	onToggled (bool)
	Called when any color selection button from popup menu is clicked.
void	onAboutToShow ()
	Called when the popup menu is about to show.
void	onAutoClicked (bool)
	Called the "Auto" child button from popup menu is clicked.
void	onDialogClicked (bool)
	Called the "Other colors" child button from popup menu is clicked.
Private Member Functions
QList< QColor >	colorsList () const
	Get predefined list of colors to be used in the popup menu.
void	updateState ()
	Update widget state.
void	updateButton (QToolButton *)
	Update child button state.
QPixmap	buttonIcon (const QColor &) const
	Generate (if necessary) or get the icon for the button.
void	drawColor (QPaintDevice *, const QColor &, const int=1) const
	Draw pixmap.
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 test_table.c, clicked(), colorsList(), myAutoButton, myColors, onAboutToShow(), onAutoClicked(), onClicked(), onDialogClicked(), onToggled(), and updateButton().

QtxColorButton::~QtxColorButton

(

)

[virtual]

---

Member Function Documentation

QColor QtxColorButton::color

(

)

const

Returns null QColor if no color is selected.

Returns:

selected color

See also:

setColor()

References myColors.

void QtxColorButton::setColor

(

const QColor &

c

)

Parameters:

c	color to be set as current

See also:

color()

References myColors, updateButton(), and updateState().

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::setAutoEnabled

(

bool

on

)

Parameters:

on	enable/disable state

References myAutoButton.

QString QtxColorButton::autoText

(

)

const

References myAutoButton.

void QtxColorButton::setAutoText

(

const QString &

txt

)

Parameters:

txt	new button text

References myAutoButton.

void QtxColorButton::clicked

(

QColor

color

)

[signal]

Parameters:

color

current color

void QtxColorButton::changed

(

QColor

color

)

[signal]

Parameters:

color

new current color

void QtxColorButton::onClicked

(

bool

)

[private, slot]

Emits the signal clicked( QColor ).

Parameters:

on	button state (not used)

References clicked(), and color().

void QtxColorButton::onToggled

(

bool

on

)

[private, slot]

Changes the currently selected color and emits the signal changed( QColor ).

Parameters:

on	button state

References changed(), color(), myColors, updateButton(), and updateState().

void QtxColorButton::onAboutToShow

(

)

[private, slot]

Updates the menu and child widgets state.

References updateState().

void QtxColorButton::onAutoClicked

(

bool

)

[private, slot]

Sets the undefined (auto) color as current.

Parameters:

on	(not used)

References setColor().

void QtxColorButton::onDialogClicked

(

bool

)

[private, slot]

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:

on	(not used)

References test_table.c, changed(), color(), and setColor().

void QtxColorButton::paintEvent

(

QPaintEvent *

e

)

[protected, virtual]

Parameters:

e	paint event

References color(), and drawColor().

QList< QColor > QtxColorButton::colorsList

(

)

const [private]

Returns:

list of colors

void QtxColorButton::updateState

(

)

[private]

References updateButton().

void QtxColorButton::updateButton

(

QToolButton *

btn

)

[private]

Parameters:

btn	child button

References buttonIcon(), test_table.c, color(), and myColors.

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::drawColor	(	QPaintDevice *	pd,
		const QColor &	c,
		const int	m = 1
	)		const [private]

Parameters:

pd	paint device
c	color
m	margin

---

Field Documentation

ColorMap QtxColorButton.myColors [private]

QToolButton* QtxColorButton.myAutoButton [private]