KColorDialog Class Reference

#include <kcolordialog.h>

Inheritance diagram for KColorDialog:

Public Slots
void	setColor (const QColor &col)
Public Slots inherited from KDialog
void	delayedDestruct ()
void	enableButton (ButtonCode id, bool state)
void	enableButtonApply (bool state)
void	enableButtonCancel (bool state)
void	enableButtonOk (bool state)
void	enableLinkedHelp (bool state)
bool	isDetailsWidgetVisible () const
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
void	setDetailsWidget (QWidget *detailsWidget)
void	setDetailsWidgetVisible (bool visible)
void	setHelp (const QString &anchor, const QString &appname=QString())
void	setHelpLinkText (const QString &text)
virtual void	setPlainCaption (const QString &caption)

Signals
void	colorSelected (const QColor &col)
Signals inherited from KDialog
void	aboutToShowDetails ()
void	applyClicked ()
void	buttonClicked (KDialog::ButtonCode button)
void	cancelClicked ()
void	closeClicked ()
void	defaultClicked ()
void	finished ()
void	helpClicked ()
void	hidden ()
void	layoutHintChanged ()
void	noClicked ()
void	okClicked ()
void	resetClicked ()
void	tryClicked ()
void	user1Clicked ()
void	user2Clicked ()
void	user3Clicked ()
void	yesClicked ()

Public Member Functions
	KColorDialog (QWidget *parent=0L, bool modal=false)
	~KColorDialog ()
QColor	color () const
QColor	defaultColor () const
bool	isAlphaChannelEnabled () const
void	setAlphaChannelEnabled (bool alpha)
void	setDefaultColor (const QColor &defaultCol)
Public Member Functions inherited from KDialog
	KDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
	~KDialog ()
KPushButton *	button (ButtonCode id) const
KIcon	buttonIcon (ButtonCode id) const
QString	buttonText (ButtonCode id) const
QString	buttonToolTip (ButtonCode id) const
QString	buttonWhatsThis (ButtonCode id) const
ButtonCode	defaultButton () const
QString	helpLinkText () const
void	incrementInitialSize (const QSize &size)
bool	isButtonEnabled (ButtonCode id) const
QWidget *	mainWidget ()
virtual QSize	minimumSizeHint () const
void	restoreDialogSize (const KConfigGroup &config)
void	saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
void	setButtonFocus (ButtonCode id)
void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void	setButtonIcon (ButtonCode id, const KIcon &icon)
void	setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
void	setButtons (ButtonCodes buttonMask)
void	setButtonsOrientation (Qt::Orientation orientation)
void	setButtonText (ButtonCode id, const QString &text)
void	setButtonToolTip (ButtonCode id, const QString &text)
void	setButtonWhatsThis (ButtonCode id, const QString &text)
void	setDefaultButton (ButtonCode id)
void	setEscapeButton (ButtonCode id)
void	setInitialSize (const QSize &size)
void	setMainWidget (QWidget *widget)
void	showButton (ButtonCode id, bool state)
void	showButtonSeparator (bool state)
virtual QSize	sizeHint () const

Static Public Member Functions
static int	getColor (QColor &theColor, QWidget *parent=0L)
static int	getColor (QColor &theColor, const QColor &defaultColor, QWidget *parent=0L)
static QColor	grabColor (const QPoint &p)
Static Public Member Functions inherited from KDialog
static bool	avoidArea (QWidget *widget, const QRect &area, int screen=-1)
static void	centerOnScreen (QWidget *widget, int screen=-1)
static int	groupSpacingHint ()
static QString	makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int	marginHint ()
static void	resizeLayout (QWidget *widget, int margin, int spacing)
static void	resizeLayout (QLayout *lay, int margin, int spacing)
static void	setAllowEmbeddingInGraphicsView (bool allowEmbedding)
static int	spacingHint ()

Protected Member Functions
virtual bool	eventFilter (QObject *obj, QEvent *ev)
virtual void	keyPressEvent (QKeyEvent *)
virtual void	mouseMoveEvent (QMouseEvent *)
virtual void	mouseReleaseEvent (QMouseEvent *)
Protected Member Functions inherited from KDialog
	KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0)
virtual void	closeEvent (QCloseEvent *e)
virtual void	hideEvent (QHideEvent *)

Properties
QColor	color
QColor	defaultColor
bool	isAlphaChannelEnabled

Additional Inherited Members
Public Types inherited from KDialog
enum	ButtonCode {   None = 0x00000000, Help = 0x00000001, Default = 0x00000002, Ok = 0x00000004,   Apply = 0x00000008, Try = 0x00000010, Cancel = 0x00000020, Close = 0x00000040,   No = 0x00000080, Yes = 0x00000100, Reset = 0x00000200, Details = 0x00000400,   User1 = 0x00001000, User2 = 0x00002000, User3 = 0x00004000, NoDefault = 0x00008000 }
enum	ButtonPopupMode { InstantPopup = 0, DelayedPopup = 1 }
enum	CaptionFlag { NoCaptionFlags = 0, AppNameCaption = 1, ModifiedCaption = 2, HIGCompliantCaption = AppNameCaption }
Protected Slots inherited from KDialog
virtual void	slotButtonClicked (int button)
void	updateGeometry ()
Protected Attributes inherited from KDialog
KDialogPrivate *const	d_ptr

Detailed Description

A color selection dialog.

Features:

• Color selection from a wide range of palettes.
• Color selection from a palette of H vs S and V selectors.
• Direct input of HSV or RGB values.
• Saving of custom colors

In most cases, you will want to use the static method KColorDialog::getColor(). This pops up the dialog (with an initial selection provided by you), lets the user choose a color, and returns.

Example:

QColor myColor;
int result = KColorDialog::getColor( myColor );
    if ( result == KColorDialog::Accepted )
       ...

To react to the color selection as it is being selected, the colorSelected() signal can be used. This can be used still in a modal way, for example:

KColorDialog dialog(this);
connect(&dialog, SIGNAL(colorSelected(const QColor &)), this, SLOT(temporarilyChangeColor(const QColor &)));
QColor myColor;
dialog.setColor(myColor);
int result = dialog.exec();

if ( result == KColorDialog::Accepted )
  changeColor( dialog.color() );
else
  temporarilyChangeColor(myColor); //change back to original color

KDE Color Dialog

The color dialog is really a collection of several widgets which can you can also use separately: the quadratic plane in the top left of the dialog is a KXYSelector. Right next to it is a KHSSelector for choosing hue/saturation.

On the right side of the dialog you see a KColorTable showing a number of colors with a combo box which offers several predefined palettes or a palette configured by the user. The small field showing the currently selected color is a KColorPatch.

Definition at line 210 of file kcolordialog.h.

Constructor & Destructor Documentation

KColorDialog::KColorDialog ( QWidget *  parent = 0L, bool  modal = false  )

explicit

Constructs a color selection dialog.

Definition at line 1021 of file kcolordialog.cpp.

KColorDialog::~KColorDialog

(

)

Destroys the color selection dialog.

Definition at line 1315 of file kcolordialog.cpp.

Member Function Documentation

QColor KColorDialog::color

(

)

const

Returns the currently selected color.

void KColorDialog::colorSelected ( const QColor &  col )

signal

Emitted when a color is selected.

Connect to this to monitor the color as it as selected if you are not running modal.

QColor KColorDialog::defaultColor

(

)

const

Returns

the value passed to setDefaultColor

bool KColorDialog::eventFilter ( QObject *  obj, QEvent *  ev  )

protectedvirtual

Definition at line 1325 of file kcolordialog.cpp.

int KColorDialog::getColor ( QColor &  theColor, QWidget *  parent = 0L  )

static

Creates a modal color dialog, let the user choose a color, and returns when the dialog is closed.

The selected color is returned in the argument theColor.

Parameters

theColor

if valid, specifies the color to be initially selected. On return, holds the selected color.

Returns

QDialog::result().

Definition at line 1492 of file kcolordialog.cpp.

int KColorDialog::getColor ( QColor &  theColor, const QColor &  defaultColor, QWidget *  parent = 0L  )

static

Creates a modal color dialog, lets the user choose a color, and returns when the dialog is closed.

The selected color is returned in the argument theColor.

This version takes a defaultColor argument, which sets the color selected by the "default color" checkbox. When this checkbox is checked, the invalid color (QColor()) is returned into theColor.

Parameters

theColor	if valid, specifies the color to be initially selected. On return, holds the selected color.
defaultColor	color selected by the "default color" checkbox

Returns

QDialog::result().

Definition at line 1510 of file kcolordialog.cpp.

QColor KColorDialog::grabColor ( const QPoint &  p )

static

Gets the color from the pixel at point p on the screen.

Definition at line 1759 of file kcolordialog.cpp.

bool KColorDialog::isAlphaChannelEnabled

(

)

const

Returns true when the user can change the alpha channel.

Since

4.5

void KColorDialog::keyPressEvent ( QKeyEvent *  event )

protectedvirtual

Reimplemented from KDialog.

Definition at line 1787 of file kcolordialog.cpp.

void KColorDialog::mouseMoveEvent ( QMouseEvent *  e )

protectedvirtual

Definition at line 1731 of file kcolordialog.cpp.

void KColorDialog::mouseReleaseEvent ( QMouseEvent *  e )

protectedvirtual

Definition at line 1742 of file kcolordialog.cpp.

void KColorDialog::setAlphaChannelEnabled

(

bool

alpha

)

When set to true, the user is allowed to change the alpha component of the color.

The default value is false.

Since

4.5

Definition at line 1376 of file kcolordialog.cpp.

void KColorDialog::setColor ( const QColor &  col )

slot

Preselects a color.

Definition at line 1484 of file kcolordialog.cpp.

void KColorDialog::setDefaultColor

(

const QColor &

defaultCol

)

Call this to make the dialog show a "Default Color" checkbox.

If this checkbox is selected, the dialog will return an "invalid" color (QColor()). This can be used to mean "the default text color", for instance, the one with the KDE text color on screen, but black when printing.

Definition at line 1343 of file kcolordialog.cpp.

Property Documentation

QColor KColorDialog::color

readwrite

Definition at line 215 of file kcolordialog.h.

QColor KColorDialog::defaultColor

readwrite

Definition at line 214 of file kcolordialog.h.

bool KColorDialog::isAlphaChannelEnabled

readwrite

Definition at line 213 of file kcolordialog.h.

---

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

• kcolordialog.h
• kcolordialog.cpp