QColorDialog Class Reference

 #include <QColorDialog>

Member Function Documentation

QColorDialog::QColorDialog ( QWidget * parent = 0 )

Constructs a color dialog with the given parent.

This function was introduced in Qt 4.5.

QColorDialog::QColorDialog ( const QColor & initial, QWidget * parent = 0 )

Constructs a color dialog with the given parent and specified initial color.

This function was introduced in Qt 4.5.

QColorDialog::~QColorDialog ()

Destroys the color dialog.

void QColorDialog::changeEvent ( QEvent * e ) [virtual protected]

Reimplemented from QWidget::changeEvent().

void QColorDialog::colorSelected ( const QColor & color ) [signal]

This signal is emitted just after the user has clicked OK to select a color to use. The chosen color is specified by color.

See also color and currentColorChanged().

void QColorDialog::currentColorChanged ( const QColor & color ) [signal]

This signal is emitted whenever the current color changes in the dialog. The current color is specified by color.

See also color and colorSelected().

QRgb QColorDialog::customColor ( int index ) [static]

Returns the custom color at the given index as a QRgb value.

This function was introduced in Qt 4.5.

See also setCustomColor().

int QColorDialog::customCount () [static]

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

void QColorDialog::done ( int result ) [virtual protected]

Reimplemented from QDialog::done().

Closes the dialog and sets its result code to result. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return result.

See also QDialog::done().

QColor QColorDialog::getColor ( const QColor & initial, QWidget * parent, const QString & title, ColorDialogOptions options = 0 ) [static]

Pops up a modal color dialog with the given window title (or "Select Color" if none is specified), 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.

The options argument allows you to customize the dialog.

On Symbian, this static function will use the native color dialog and not a QColorDialog. On Symbian the parameters title and parent has no relevance and the options parameter is only used to define if the native color dialog is used or not.

This function was introduced in Qt 4.5.

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.

On Symbian, this static function will use the native color dialog and not a QColorDialog.

void QColorDialog::open ()

Shows the dialog as a window modal dialog, returning immediately.

This function was introduced in Qt 4.5.

See also QDialog::open().

void QColorDialog::open ( QObject * receiver, const char * member )

This is an overloaded function.

Opens the dialog and connects its colorSelected() signal to the slot specified by receiver and member.

The signal will be disconnected from the slot when the dialog is closed.

This function was introduced in Qt 4.5.

QColor QColorDialog::selectedColor () const

Returns the color that the user selected by clicking the OK or equivalent button.

Note: This color is not always the same as the color held by the currentColor property since the user can choose different colors before finally selecting the one to use.

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

Sets the custom color at index to the QRgb color value.

Note: This function does not apply to the Native Color Dialog on the Mac OS X platform. If you still require this function, use the QColorDialog::DontUseNativeDialog option.

See also customColor().

void QColorDialog::setOption ( ColorDialogOption option, bool on = true )

Sets the given option to be enabled if on is true; otherwise, clears the given option.

See also options and testOption().

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

Sets the standard color at index to the QRgb color value.

Note: This function does not apply to the Native Color Dialog on the Mac OS X platform. If you still require this function, use the QColorDialog::DontUseNativeDialog option.

void QColorDialog::setVisible ( bool visible ) [virtual]

Reimplemented from QWidget::setVisible().

Changes the visibility of the dialog. If visible is true, the dialog is shown; otherwise, it is hidden.

bool QColorDialog::testOption ( ColorDialogOption option ) const

Returns true if the given option is enabled; otherwise, returns false.

This function was introduced in Qt 4.5.

See also options and setOption().