ColorPickerButton Class Reference

#include <colorPickerButton.h>

Inheritance diagram for ColorPickerButton:

Public Types
enum	ColorDialogOption { ShowAlphaChannel = 0x00000001, NoButtons = 0x00000002, DontUseNativeDialog = 0x00000004, UseColorDialog = 0x0000000C }

Public Slots
void	setColor (const QColor &color)
	Set a new current color without opening a dialog.
void	changeColor ()
void	setDisplayColorName (bool displayColorName)

Signals
void	colorChanged (QColor)
void	colorNameChanged (QString)
	This signaled is fired anytime a new color name is set.

Public Member Functions
	ColorPickerButton (QWidget *parent=0)
	By default, the color is black.
	ColorPickerButton (const QString &text, QWidget *parent=0)
	ColorPickerButton (const QColor &color, const QString &text, QWidget *parent=0)
QColor	color () const
	Current selected color.
QString	colorName () const
void	setColorName (const QString &name)
bool	displayColorName () const
	Display the color name after color selection.
void	setDialogOptions (const ColorDialogOptions &options)
const ColorDialogOptions &	dialogOptions () const
virtual QSize	sizeHint () const

Protected Slots
void	onToggled (bool change=true)

Protected Member Functions
virtual void	paintEvent (QPaintEvent *event)

Protected Attributes
QScopedPointer< ColorPickerButtonPrivate >	d_ptr

Properties
QColor	color
QString	colorName
bool	displayColorName
ColorDialogOptions	dialogOptions
	This property controls the properties of the dialog used in changeColor.

Private Member Functions
	Q_DECLARE_PRIVATE (ColorPickerButton)
	Q_DISABLE_COPY (ColorPickerButton)

Detailed Description

ColorPickerButton is a QPushButton that refers to a color. The color and the name of the color (i.e. #FFFFFF) are displayed on the button. When clicked, a color dialog pops up to select a new color for the QPushButton.

Constructor & Destructor Documentation

ColorPickerButton::ColorPickerButton ( const QString &  text, QWidget *  parent = 0  )

explicit

By default, the color is black. The text will be shown on the button if displayColorName is false, otherwise the color name is shown.

See also

QPushButton::setText

ColorPickerButton::ColorPickerButton ( const QColor &  color, const QString &  text, QWidget *  parent = 0  )

explicit

The text will be shown on the button if displayColorName is false, otherwise the color name is shown.

See also

setColor, QPushButton::setText

Member Function Documentation

void ColorPickerButton::changeColor ( )

slot

Opens a color dialog to select a new current color. If the CTK color dialog (UseColorDialog) is used, then the color name is also set if the user selects a named color.

See also

ColorDialog, color, colorName

void ColorPickerButton::colorChanged ( QColor  )

signal

colorChanged is fired anytime a new color is set. Programatically or by the user when choosing a color from the color dialog

QString ColorPickerButton::colorName

(

)

const

Current selected color name. Returns the name of the color in the format "#RRGGBB" or the string set by setColorName().

See also

color(), setColorName()

void ColorPickerButton::setColorName

(

const QString &

name

)

Set the current color name. This allows you to give name other than the default "#RRGGBB" Set an invalid QString to restore the default color names

void ColorPickerButton::setDialogOptions

(

const ColorDialogOptions &

options

)

Set the color dialog options to configure the color dialog.

See also

QColorDialog::setOptions QColorDialog::ColorDialogOption

void ColorPickerButton::setDisplayColorName ( bool  displayColorName )

slot

Toggle the display of the color name after color selection. By default, this is activated.

QSize ColorPickerButton::sizeHint ( ) const

virtual

Reimplemented to return a toolbutton sizehint when no text is displayed in the button.

Property Documentation

QColor ColorPickerButton::color

readwrite

This property controls the name of the color. Black (0,0,0) by default.

QString ColorPickerButton::colorName

readwrite

This property controls the name of the color. If empty (default), the color in the format "#RRGGBB" is displayed in the button if displayColorName is true, otherwise, the color name is used.

bool ColorPickerButton::displayColorName

readwrite

This properties controls whether the name of the color is shown on the button if true or the button text instead. True by default.

See also

colorName, QPushButton::text

---

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

• D:/itom/sources/itom/itomWidgets/colorPickerButton.h
• D:/itom/sources/itom/itomWidgets/colorPickerButton.cpp