Home

QtColorComboBox Class Reference

The QtColorComboBox class provides a combobox with colors and texts. More...

 #include <QtColorComboBox>

Inherits QComboBox.

• List of all members, including inherited members

Public Functions

• QtColorComboBox ( QWidget * parent = 0, const char * name = 0 )
• void addColor ( const QColor & color, const QString & name )
• QColor color ( int index ) const
• int colorCount () const
• QColor currentColor () const
• void insertColor ( int index, const QColor & color, const QString & name )
• bool isColorDialogEnabled () const
• void setColorDialogEnabled ( bool enabled = true )
• void setCurrentColor ( const QColor & color )
• void setStandardColors ()

• 55 public functions inherited from QComboBox
• 207 public functions inherited from QWidget
• 12 public functions inherited from QPaintDevice
• 29 public functions inherited from QObject

Signals

• void activated ( const QColor & color )
• void highlighted ( const QColor & color )

• 7 signals inherited from QComboBox
• 1 signal inherited from QWidget
• 1 signal inherited from QObject

Additional Inherited Members

• 13 properties inherited from QComboBox
• 57 properties inherited from QWidget
• 1 property inherited from QObject
• 4 public slots inherited from QComboBox
• 19 public slots inherited from QWidget
• 1 public slot inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QWidget
• 4 static public members inherited from QObject
• 1 protected function inherited from QComboBox
• 37 protected functions inherited from QWidget
• 1 protected function inherited from QPaintDevice
• 7 protected functions inherited from QObject
• 1 protected slot inherited from QWidget
• 1 protected type inherited from QPaintDevice
• 2 protected variables inherited from QObject

Detailed Description

The QtColorComboBox class provides a combobox with colors and texts.

Colors are inserted with insertColor(), which takes a color, a text, and an optional index position. The combobox can also be populated with a standard set of colors using setStandardColors(). Users can add their own colors if the color dialog is enabled (see setColorDialogEnabled()).

When a color is highlighted (for example when the mouse moves over it after the combobox has been dropped down), the highlighted() signal is emitted. When a color is activated (for example, clicked), the activated() signal is emitted. If the color dialog is enabled and the item clicked is the "More..." item at the end, the color dialog is popped up and if the user chooses a color the activated signal is emitted after the dialog closes.

Use color() to get the color at a certain index position, and currentColor() to get the color that is currently selected.

Member Function Documentation

QtColorComboBox::QtColorComboBox ( QWidget * parent = 0, const char * name = 0 )

Constructs a QtColorComboBox with the color dialog disabled. The parent and name arguments are passed to the QComboBox's constructor.

void QtColorComboBox::activated ( const QColor & color )   [signal]

This signal is emitted when the color color has been activated.

void QtColorComboBox::addColor ( const QColor & color, const QString & name )

Appends the color color with the text name to the combobox.

QColor QtColorComboBox::color ( int index ) const

Returns the color at position index.

int QtColorComboBox::colorCount () const

This function returns the number of colours in the combobox. (excluding the "More...")

QColor QtColorComboBox::currentColor () const

Returns the current color.

See also setCurrentColor().

void QtColorComboBox::highlighted ( const QColor & color )   [signal]

This signal is emitted when the color color has been highlighted on the popup color grid.

void QtColorComboBox::insertColor ( int index, const QColor & color, const QString & name )

Inserts the color color with the text name at position index.

If index is -1, then color is prepended to the beginning end of the list.

bool QtColorComboBox::isColorDialogEnabled () const

Returns true if the color dialog button is enabled; otherwise returns false.

void QtColorComboBox::setColorDialogEnabled ( bool enabled = true )

Enables the color dialog if enabled is true; otherwise disables it.

When the color dialog is enabled, an extra item is available at the bottom of the list of colors in the combobox with the translatable text "More...". Selecting this item will pop up the color dialog, allowing the user to add new colors to the list. The new colors will be called "User color 1", "User color 2", and so on; the names can be changed by translating "User color %1".

See also isColorDialogEnabled() and insertColor().

void QtColorComboBox::setCurrentColor ( const QColor & color )

Sets color to be the current color if color is one of the combobox's colors; otherwise does nothing.

See also currentColor() and insertColor().

void QtColorComboBox::setStandardColors ()

Adds the 17 predefined colors from the Qt namespace.

(The names given to the colors, "Black", "White", "Red", etc., are all translatable.)

See also insertColor().