QColorDialog Class Reference

#include <qcolordialog.h>

Inheritance diagram for QColorDialog:

[legend]Collaboration diagram for QColorDialog:

[legend]List of all members.

---

Detailed Description

The QColorDialog class provides a dialog widget for specifying colors.

The color dialog's function is to allow users to choose colors. For example, you might use this in a drawing program to allow the user to set the brush color.

The static functions provide modal color dialogs. If you require a modeless dialog, use the QColorDialog constructor.

The static getColor() function shows the dialog, and allows the user to specify a color. The getRgba() function does the same, but also allows the user to specify a color with an alpha channel (transparency) value.

The user can store customCount() different custom colors. The custom colors are shared by all color dialogs, and remembered during the execution of the program. Use setCustomColor() to set the custom colors, and use customColor() to get them.

Additional widgets that allow users to pick colors are available as {Qt Solutions}.

The {dialogs/standarddialogs}{Standard Dialogs} example shows how to use QColorDialog as well as other built-in Qt dialogs.

A color dialog in the Plastique widget style.

See also:

QColor, QFileDialog, QPrintDialog, QFontDialog, {Standard Dialogs Example}

Definition at line 37 of file qcolordialog.h.

Static Public Member Functions
static QColor	getColor (const QColor &init=Qt::white, QWidget *parent=0)
static QRgb	getRgba (QRgb, bool *ok=0, QWidget *parent=0)
static int	customCount ()
static QRgb	customColor (int)
static void	setCustomColor (int, QRgb)
static void	setStandardColor (int, QRgb)
Private Member Functions
	~QColorDialog ()
	QColorDialog (QWidget *parent=0, bool modal=false)
void	setColor (const QColor &)
QColor	color () const
bool	selectColor (const QColor &)
void	setSelectedAlpha (int)
int	selectedAlpha () const
void	showCustom (bool=true)
	Q_PRIVATE_SLOT (d_func(), void _q_addCustom()) Q_PRIVATE_SLOT(d_func()
void	_q_newHsv (int h, int s, int v)) Q_PRIVATE_SLOT(d_func()
void void	_q_newColorTypedIn (QRgb rgb)) Q_PRIVATE_SLOT(d_func()
void void void	_q_newCustom (int, int)) Q_PRIVATE_SLOT(d_func()
void void void void	_q_newStandard (int, int)) friend class QColorShower

---

Constructor & Destructor Documentation

QColorDialog::~QColorDialog

(

)

[private]

Destroys the color dialog.

Definition at line 1548 of file qcolordialog.cpp.

References QSettings::beginGroup(), cusrgb, customSet, QSettings::endGroup(), i, QString::number(), QSettings::setValue(), and QSettings::UserScope.

{
#ifndef QT_NO_SETTINGS
    if (!customSet) {
        QSettings settings(QSettings::UserScope, QLatin1String("Trolltech"));
        settings.beginGroup(QLatin1String("Qt"));
        for (int i = 0; i < 2*8; ++i)
            settings.setValue(QLatin1String("customColors/") + QString::number(i), cusrgb[i]);
        settings.endGroup();
    }
#endif
}

Here is the call graph for this function:

QColorDialog::QColorDialog	(	QWidget *	parent = 0,
		bool	modal = false
	)			[explicit, private]

Constructs a default color dialog called name with the given parent. If modal is true the dialog will be modal. Use setColor() to set an initial value.

See also:

getColor()

Definition at line 1437 of file qcolordialog.cpp.

References QSettings::beginGroup(), cusrgb, customSet, d, QSettings::endGroup(), i, QString::number(), QRgb, rgb, QDialog::setModal(), QDialog::setSizeGripEnabled(), QSettings::UserScope, and QSettings::value().

Referenced by getColor(), and getRgba().

                                                      :
    QDialog(*new QColorDialogPrivate, parent, (Qt::Dialog | Qt::WindowTitleHint |
                     Qt::MSWindowsFixedSizeDialogHint | Qt::WindowSystemMenuHint))
{
    Q_D(QColorDialog);
    setModal(modal);
    setSizeGripEnabled(false);
    d->init();

#ifndef QT_NO_SETTINGS
    if (!customSet) {
        QSettings settings(QSettings::UserScope, QLatin1String("Trolltech"));
        settings.beginGroup(QLatin1String("Qt"));
        for (int i = 0; i < 2*8; ++i) {
            QVariant v = settings.value(QLatin1String("customColors/") + QString::number(i));
            if (v.isValid()) {
                QRgb rgb = v.toUInt();
                cusrgb[i] = rgb;
            }
        }
        settings.endGroup(); // Qt
    }
#endif
}

Here is the call graph for this function:

---

Member Function Documentation

QColor QColorDialog::getColor	(	const QColor &	initial = Qt::white,
		QWidget *	parent = 0
	)			[static]

Pops up a modal color dialog, lets the user choose a color, and returns that color. The color is initially set to initial. The dialog is a child of parent. It returns an invalid (see QColor::isValid()) color if the user cancels the dialog. All colors allocated by the dialog will be deallocated before this function returns.

Definition at line 1471 of file qcolordialog.cpp.

References QDialog::Accepted, color(), QDialog::exec(), QObject::parent(), QColorDialog(), QDialog::result(), selectColor(), setColor(), and QWidget::setWindowTitle().

Referenced by MainWindow::brushColor(), ColorButton::changeColor(), qdesigner_internal::StyledButton::onEditor(), MainWindow::penColor(), SpreadSheet::selectColor(), Dialog::setColor(), and TextEdit::textColor().

{
#if defined(Q_WS_MAC)
    return macGetColor(initial, parent);
#endif

    QColorDialog *dlg = new QColorDialog(parent, true);  //modal
    dlg->setWindowTitle(QColorDialog::tr("Select color"));
    dlg->setColor(initial);
    dlg->selectColor(initial);
    int resultCode = dlg->exec();
    QColor result;
    if (resultCode == QDialog::Accepted)
        result = dlg->color();
    delete dlg;
    return result;
}

Here is the call graph for this function:

QRgb QColorDialog::getRgba	(	QRgb	initial,
		bool *	ok = 0,
		QWidget *	parent = 0
	)			[static]

Pops up a modal color dialog to allow the user to choose a color and an alpha channel (transparency) value. The color+alpha is initially set to initial. The dialog is a child of parent.

If ok is non-null, *ok is set to true if the user clicked OK, and to false if the user clicked Cancel.

If the user clicks Cancel, the initial value is returned.

Definition at line 1501 of file qcolordialog.cpp.

References QDialog::Accepted, alpha, c, color(), QDialog::exec(), QObject::parent(), qAlpha(), qBlue(), QColorDialog(), qGreen(), qRed(), QRgb, qRgba(), QDialog::result(), QColor::rgb(), selectColor(), selectedAlpha(), setColor(), setSelectedAlpha(), and QWidget::setWindowTitle().

Referenced by qdesigner_internal::QtColorButtonPrivate::slotEditColor().

{
#if defined(Q_WS_MAC)
    return macGetRgba(initial, ok, parent);
#endif

    QColorDialog *dlg = new QColorDialog(parent, true);  //modal

    dlg->setWindowTitle(QColorDialog::tr("Select color"));
    dlg->setColor(initial);
    dlg->selectColor(initial);
    dlg->setSelectedAlpha(qAlpha(initial));
    int resultCode = dlg->exec();
    QRgb result = initial;
    if (resultCode == QDialog::Accepted) {
        QRgb c = dlg->color().rgb();
        int alpha = dlg->selectedAlpha();
        result = qRgba(qRed(c), qGreen(c), qBlue(c), alpha);
    }
    if (ok)
        *ok = resultCode == QDialog::Accepted;

    delete dlg;
    return result;
}

Here is the call graph for this function:

int QColorDialog::customCount

(

)

[static]

Returns the number of custom colors supported by QColorDialog. All color dialogs share the same custom colors.

Definition at line 453 of file qcolordialog.cpp.

Referenced by customColor(), and setCustomColor().

{
    return 2*8;
}

QRgb QColorDialog::customColor

(

int

i

)

[static]

Returns custom color number i as a QRgb value.

Definition at line 461 of file qcolordialog.cpp.

References cusrgb, customCount(), and initRGB().

{
    initRGB();
    Q_ASSERT(i >= 0 && i < customCount());
    return cusrgb[i];
}

Here is the call graph for this function:

void QColorDialog::setCustomColor	(	int	number,
		QRgb	color
	)			[static]

Sets the custom color number to the QRgb color value.

Definition at line 473 of file qcolordialog.cpp.

References cusrgb, customCount(), customSet, and initRGB().

{
    initRGB();
    Q_ASSERT(i >= 0 && i < customCount());
    customSet = true;
    cusrgb[i] = c;
}

Here is the call graph for this function:

void QColorDialog::setStandardColor	(	int	number,
		QRgb	color
	)			[static]

Sets the standard color number to the QRgb color value given.

Definition at line 487 of file qcolordialog.cpp.

References initRGB(), and stdrgb.

{
    initRGB();
    Q_ASSERT(i >= 0 && i < 6*8);
    stdrgb[i] = c;
}

Here is the call graph for this function:

void QColorDialog::setColor

(

const QColor &

color

)

[private]

Sets the color shown in the dialog to the color given.

See also:

color()

Definition at line 1570 of file qcolordialog.cpp.

References c, and d.

Referenced by getColor(), and getRgba().

{
    Q_D(QColorDialog);
    d->setCurrentColor(c.rgb());
}

QColor QColorDialog::color

(

)

const [private]

Returns the currently selected color in the dialog.

See also:

setColor()

Definition at line 1537 of file qcolordialog.cpp.

References d.

Referenced by getColor(), getRgba(), and selectColor().

{
    Q_D(const QColorDialog);
    return QColor(d->currentColor());
}

bool QColorDialog::selectColor

(

const QColor &

col

)

[private]

Sets focus to the corresponding button, if any.

Definition at line 1607 of file qcolordialog.cpp.

References color(), cusrgb, d, i, j, QRgb, QColor::rgb(), and stdrgb.

Referenced by getColor(), and getRgba().

{
    Q_D(QColorDialog);
    QRgb color = col.rgb();
    int i = 0, j = 0;
    // Check standard colors
    if (d->standard) {
        for (i = 0; i < 6; i++) {
            for (j = 0; j < 8; j++) {
                if (color == stdrgb[i + j*6]) {
                    d->_q_newStandard(i, j);
                    d->standard->setCurrent(i, j);
                    d->standard->setSelected(i, j);
                    d->standard->setFocus();
                    return true;
                }
            }
        }
    }
    // Check custom colors
    if (d->custom) {
        for (i = 0; i < 2; i++) {
            for (j = 0; j < 8; j++) {
                if (color == cusrgb[i + j*2]) {
                    d->_q_newCustom(i, j);
                    d->custom->setCurrent(i, j);
                    d->custom->setSelected(i, j);
                    d->custom->setFocus();
                    return true;
                }
            }
        }
    }
    return false;
}

Here is the call graph for this function:

void QColorDialog::setSelectedAlpha

(

int

alpha

)

[private]

Sets the initial alpha channel value to the alpha value given, and shows the alpha channel entry box.

Definition at line 1586 of file qcolordialog.cpp.

References d.

Referenced by getRgba().

{
    Q_D(QColorDialog);
    d->showAlpha(true);
    d->setCurrentAlpha(a);
}

int QColorDialog::selectedAlpha

(

)

const [private]

Returns the value selected for the alpha channel.

Definition at line 1598 of file qcolordialog.cpp.

References d.

Referenced by getRgba().

{
    Q_D(const QColorDialog);
    return d->currentAlpha();
}

void QColorDialog::showCustom

(

bool

= true

)

[private]

QColorDialog::Q_PRIVATE_SLOT	(	d_func()	,
		void	_q_addCustom()
	)			[private]

Reimplemented from QWidget.

void QColorDialog::_q_newHsv	(	int	h,
		int	s,
		int	v
	)			[private]

void void QColorDialog::_q_newColorTypedIn

(

QRgb

rgb

)

[private]

void void void QColorDialog::_q_newCustom	(	int	,
		int
	)			[private]

void void void void QColorDialog::_q_newStandard	(	int	,
		int
	)			[private]

---

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

• src/gui/dialogs/qcolordialog.h
• src/gui/dialogs/qcolordialog.cpp

---