QComboBox Class Reference
^{[QtGui module]}

Detailed Description

The QComboBox widget is a combined button and popup list.

A QComboBox provides a means of presenting a list of options to the user in a way that takes up the minimum amount of screen space.

A combobox is a selection widget that displays the current item, and can pop up a list of selectable items. A combobox may be editable, allowing the user to modify each item in the list.

Comboboxes can contain pixmaps as well as strings; the insertItem() and changeItem() functions are suitably overloaded. For editable comboboxes, the function clearEdit() is provided, to clear the displayed string without changing the combobox's contents.

There are two signals emitted if the current item of a combobox changes, currentIndexChanged() and activated(). currentIndexChanged() is always emitted regardless if the change was done programmatically or by user interaction, while activated() is only emitted when the change is caused by user interaction. The highlighted() signal is emitted when the user highlights an item in the combobox popup list. All three signals exist in two versions, one with a QString argument and one with an int argument. If the user selectes or highlights a pixmap, only the int signals are emitted. Whenever the text of an editable combobox is changed the editTextChanged() signal is emitted.

When the user enters a new string in an editable combobox, the widget may or may not insert it, and it can insert it in several locations. The default policy is is AtBottom but you can change this using setInsertPolicy().

It is possible to constrain the input to an editable combobox using QValidator; see setValidator(). By default, any input is accepted.

A combobox can be populated using the insert functions, insertStringList() and insertItem() for example. Items can be changed with changeItem(). An item can be removed with removeItem() and all items can be removed with clear(). The text of the current item is returned by currentText(), and the text of a numbered item is returned with text(). The current item can be set with setCurrentIndex(). The number of items in the combobox is returned by count(); the maximum number of items can be set with setMaxCount(). You can allow editing using setEditable(). For editable comboboxes you can set auto-completion using setCompleter() and whether or not the user can add duplicates is set with setDuplicatesEnabled().

QComboBox uses the model/view framework for its popup list and to store its items. By default a QStandardItemModel stores the items and a QListView subclass displays the popuplist. You can access the model and view directly (with model() and view()), but QComboBox also provides functions to set and get item data (e.g., setItemData() and itemText()). You can also set a new model and view (with setModel() and setView()). For the text and icon in the combobox label, the data in the model that has the Qt::DisplayRole and Qt::DecorationRole is used.

See also QLineEdit, QSpinBox, QRadioButton, QButtonGroup, and GUI Design Handbook: Combo Box, Drop-Down List Box.

Member Type Documentation

enum QComboBox::InsertPolicy

This enum specifies what the QComboBox should do when a new string is entered by the user.

enum QComboBox::SizeAdjustPolicy

This enum specifies how the size hint of the QComboBox should adjust when new content is added or content changes.

Property Documentation

count : const int

This property holds the number of items in the combobox.

Access functions:

• int count () const

currentIndex : int

This property holds the index of the current item in the combobox. The index can change when inserting or removing items. Returns -1 if no current item is set or the combobox is empty.

Access functions:

• int currentIndex () const
• void setCurrentIndex ( int index )

currentText : const QString

This property holds the text of the current item.

Access functions:

• QString currentText () const

duplicatesEnabled : bool

This property holds whether the user can enter duplicate items into the combobox.

Note that it is always possible to programatically insert duplicate items into the combobox.

Access functions:

• bool duplicatesEnabled () const
• void setDuplicatesEnabled ( bool enable )

editable : bool

This property holds whether the combobox can be edited by the user.

Access functions:

• bool isEditable () const
• void setEditable ( bool editable )

frame : bool

This property holds whether the combo box draws itself with a frame.

If enabled (the default) the combo box draws itself inside a frame, otherwise the combo box draws itself without any frame.

Access functions:

• bool hasFrame () const
• void setFrame ( bool )

iconSize : QSize

This property holds the size of the icons shown in the combobox.

Unless explicitly set this returns the default value of the current style.

Access functions:

• QSize iconSize () const
• void setIconSize ( const QSize & size )

insertPolicy : InsertPolicy

This property holds the policy used to determine where user-inserted items should appear in the combobox.

The default value is AtBottom, indicating that new items will appear at the bottom of the list of items.

Access functions:

• InsertPolicy insertPolicy () const
• void setInsertPolicy ( InsertPolicy policy )

See also InsertPolicy.

maxCount : int

This property holds the maximum number of items allowed in the combobox.

Note: If you set the maximum number to be less then the current amount of items in the combobox, the extra items will be truncated. This also applies if you have set an external model on the combobox.

Access functions:

• int maxCount () const
• void setMaxCount ( int max )

maxVisibleItems : int

This property holds the maximum allowed size on screen of the combobox.

This property is ignored for non-editable comboboxes in Mac style.

Access functions:

• int maxVisibleItems () const
• void setMaxVisibleItems ( int maxItems )

minimumContentsLength : int

This property holds the minimum number of characters that should fit into the combobox.

The default value is 0.

If this property is set to a positive value, the minimumSizeHint() and sizeHint() take it into account.

Access functions:

• int minimumContentsLength () const
• void setMinimumContentsLength ( int characters )

See also sizeAdjustPolicy.

modelColumn : int

This property holds the column in the model that is visible.

If set prior to populating the combobox, the popup view will not be affected and will show the first column.

Access functions:

• int modelColumn () const
• void setModelColumn ( int visibleColumn )

sizeAdjustPolicy : SizeAdjustPolicy

This property holds the policy describing how the size of the combobox changes when the content changes.

The default value is AdjustToContentsOnFirstShow.

Access functions:

• SizeAdjustPolicy sizeAdjustPolicy () const
• void setSizeAdjustPolicy ( SizeAdjustPolicy policy )

See also SizeAdjustPolicy.

Member Function Documentation

QComboBox::QComboBox ( QWidget * parent = 0 )

Constructs a combobox with the given parent, using the default model QStandardItemModel.

QComboBox::~QComboBox ()

Destroys the combobox.

void QComboBox::activated ( int index )   [signal]

This signal is sent when an item in the combobox is activated by the user. The item's index is given.

void QComboBox::activated ( const QString & text )   [signal]

This is an overloaded member function, provided for convenience.

This signal is sent when an item in the combobox is activated by the user. The item's text is given.

void QComboBox::addItem ( const QString & text, const QVariant & userData = QVariant() )

Adds an item to the combobox with the given text, and containing the specified userData. The item is appended to the list of existing items.

void QComboBox::addItem ( const QIcon & icon, const QString & text, const QVariant & userData = QVariant() )

This is an overloaded member function, provided for convenience.

Adds an item to the combobox with the given icon and text, and containing the specified userData. The item is appended to the list of existing items.

void QComboBox::addItems ( const QStringList & texts )

Adds each of the strings in the given texts to the combobox. Each item is appended to the list of existing items in turn.

void QComboBox::clear ()   [slot]

Clears the combobox, removing all items.

Note: If you have set an external model on the combobox this model will still be cleared when calling this function.

void QComboBox::clearEditText ()   [slot]

Clears the contents of the line edit used for editing in the combobox.

QCompleter * QComboBox::completer () const

Returns the completer that is used to auto complete text input for the combobox.

This function was introduced in Qt 4.2.

See also setCompleter() and editable.

void QComboBox::currentIndexChanged ( int index )   [signal]

This signal is sent whenever the currentIndex in the combobox changes either through user interaction or programmatically. The item's index is given or -1 if the combobox becomes empty or the currentIndex was reset.

This function was introduced in Qt 4.1.

void QComboBox::currentIndexChanged ( const QString & text )   [signal]

This is an overloaded member function, provided for convenience.

This signal is sent whenever the currentIndex in the combobox changes either through user interaction or programmatically. The item's text is given.

This function was introduced in Qt 4.1.

void QComboBox::editTextChanged ( const QString & text )   [signal]

This signal is emitted when the text in the combobox's line edit widget is changed. The new text is specified by text.

int QComboBox::findData ( const QVariant & data, int role = Qt::UserRole, Qt::MatchFlags flags = Qt::MatchExactly | Qt::MatchCaseSensitive ) const

Returns the index of the item containing the given data for the given role; otherwise returns -1.

The flags specify how the items in the combobox are searched.

int QComboBox::findText ( const QString & text, Qt::MatchFlags flags = Qt::MatchExactly | Qt::MatchCaseSensitive ) const

Returns the index of the item containing the given text; otherwise returns -1.

The flags specify how the items in the combobox are searched.

void QComboBox::hidePopup ()   [virtual]

Hides the list of items in the combobox if it is currently visible; otherwise this function does nothing.

void QComboBox::highlighted ( int index )   [signal]

This signal is sent when an item in the combobox popup list is highlighted by the user. The item's index is given.

void QComboBox::highlighted ( const QString & text )   [signal]

This is an overloaded member function, provided for convenience.

This signal is sent when an item in the combobox popup list is highlighted by the user. The item's text is given.

void QComboBox::insertItem ( int index, const QString & text, const QVariant & userData = QVariant() )

Inserts the text and userData into the combobox at the given index.

If the index is equal to or higher than the total number of items, the new item is appended to the list of existing items. If the index is zero or negative, the new item is prepended to the list of existing items.

See also insertItems().

void QComboBox::insertItem ( int index, const QIcon & icon, const QString & text, const QVariant & userData = QVariant() )

This is an overloaded member function, provided for convenience.

Inserts the icon, text and userData into the combobox at the given index.

If the index is equal to or higher than the total number of items, the new item is appended to the list of existing items. If the index is zero or negative, the new item is prepended to the list of existing items.

See also insertItems().

void QComboBox::insertItems ( int index, const QStringList & list )

Inserts the strings from the list into the combobox as separate items, starting at the index specified.

If the index is equal to or higher than the total number of items, the new items are appended to the list of existing items. If the index is zero or negative, the new items are prepended to the list of existing items.

See also insertItem().

QVariant QComboBox::itemData ( int index, int role = Qt::UserRole ) const

Returns the data for the given role in the given index in the combobox, or QVariant::Invalid if there is no data for this role.

See also setItemData().

QAbstractItemDelegate * QComboBox::itemDelegate () const

Returns the item delegate used by the popup list view.

See also setItemDelegate().

QIcon QComboBox::itemIcon ( int index ) const

Returns the icon for the given index in the combobox.

See also setItemIcon().

QString QComboBox::itemText ( int index ) const

Returns the text for the given index in the combobox.

See also setItemText().

QLineEdit * QComboBox::lineEdit () const

Returns the line edit used to edit items in the combobox, or 0 if there is no line edit.

Only editable combo boxes have a line edit.

See also setLineEdit().

QAbstractItemModel * QComboBox::model () const

Returns the model used by the combobox.

See also setModel().

void QComboBox::removeItem ( int index )

Removes the item at the given index from the combobox. This will update the current index if the index is removed.

QModelIndex QComboBox::rootModelIndex () const

Returns the root model item index for the items in the combobox.

See also setRootModelIndex().

void QComboBox::setCompleter ( QCompleter * completer )

Sets the completer to use instead of the current completer. If completer is 0, auto completion is disabled.

By default, for an editable combo box, a QCompleter that performs case insensitive inline completion is automatically created.

This function was introduced in Qt 4.2.

See also completer().

void QComboBox::setEditText ( const QString & text )   [slot]

Sets the text in the combobox's text edit.

void QComboBox::setItemData ( int index, const QVariant & value, int role = Qt::UserRole )

Sets the data role for the item on the given index in the combobox to the specified value.

See also itemData().

void QComboBox::setItemDelegate ( QAbstractItemDelegate * delegate )

Sets the item delegate for the popup list view. The combobox takes ownership of the delegate.

See also itemDelegate().

void QComboBox::setItemIcon ( int index, const QIcon & icon )

Sets the icon for the item on the given index in the combobox.

See also itemIcon().

void QComboBox::setItemText ( int index, const QString & text )

Sets the text for the item on the given index in the combobox.

See also itemText().

void QComboBox::setLineEdit ( QLineEdit * edit )

Sets the line edit to use instead of the current line edit widget.

The combo box takes ownership of the line edit.

See also lineEdit().

void QComboBox::setModel ( QAbstractItemModel * model )

Sets the model to be model. model must not be 0. If you want to clear the contents of a model, call clear().

See also model() and clear().

void QComboBox::setRootModelIndex ( const QModelIndex & index )

Sets the root model item index for the items in the combobox.

See also rootModelIndex().

void QComboBox::setValidator ( const QValidator * validator )

Sets the validator to use instead of the current validator.

See also validator().

void QComboBox::setView ( QAbstractItemView * itemView )

Sets the view to be used in the combobox popup to the given itemView. The combobox takes ownership of the view.

Note: If you want to use the convenience views (like QListWidget, QTableWidget or QTreeWidget), make sure to call setModel() on the combobox with the convenience widgets model before calling this function.

See also view().

void QComboBox::showPopup ()   [virtual]

Displays the list of items in the combobox. If the list is empty then the no items will be shown.

const QValidator * QComboBox::validator () const

Returns the validator that is used to constrain text input for the combobox.

See also setValidator() and editable.

QAbstractItemView * QComboBox::view () const

Returns the list view used for the combobox popup.

See also setView().

Member Type Documentation

typedef QComboBox::Policy

Use QComboBox::InsertPolicy instead.

Member Function Documentation

QComboBox::QComboBox ( QWidget * parent, const char * name )

Use one of the constructors that doesn't take the name argument and then use setObjectName() instead.

QComboBox::QComboBox ( bool rw, QWidget * parent, const char * name = 0 )

Use one of the constructors that doesn't take the name argument and then use setObjectName() instead.

void QComboBox::changeItem ( const QString & text, int index )

Use setItemText() instead.

void QComboBox::changeItem ( const QPixmap & pixmap, int index )

This is an overloaded member function, provided for convenience.

Use setItemIcon() instead, for example, setItemIcon(index, QIcon(pixmap)).

void QComboBox::changeItem ( const QPixmap & pixmap, const QString & text, int index )

This is an overloaded member function, provided for convenience.

Use setItem() instead, for example, setItem(index, QIcon(pixmap),text).

void QComboBox::clearEdit ()

Use clearEditText() instead.

void QComboBox::clearValidator ()

Use setValidator(0) instead.

int QComboBox::currentItem () const

Use currentIndex() instead.

See also setCurrentItem().

bool QComboBox::editable () const

Use isEditable() instead.

See also setEditable().

void QComboBox::insertItem ( const QString & text, int index = -1 )

This is an overloaded member function, provided for convenience.

void QComboBox::insertItem ( const QPixmap & pixmap, int index = -1 )

This is an overloaded member function, provided for convenience.

Use an insertItem() function that takes a QIcon instead, for example, insertItem(index, QIcon(pixmap)).

void QComboBox::insertItem ( const QPixmap & pixmap, const QString & text, int index = -1 )

This is an overloaded member function, provided for convenience.

Use an insertItem() function that takes a QIcon instead, for example, insertItem(index, QIcon(pixmap), text).

See also insertItems().

void QComboBox::insertStringList ( const QStringList & list, int index = -1 )

Use insertItems() instead.

InsertPolicy QComboBox::insertionPolicy () const

Use QComboBox::insertPolicy instead.

See also setInsertionPolicy().

QPixmap QComboBox::pixmap ( int index ) const

Use itemIcon() instead.

void QComboBox::popup ()

Use showPopup() instead.

void QComboBox::setCurrentItem ( int index )

Use setCurrentIndex(int) instead.

See also currentItem().

void QComboBox::setCurrentText ( const QString & text )

Use setItemText() instead.

See also currentText() and currentIndex().

void QComboBox::setInsertionPolicy ( InsertPolicy policy )

Use QComboBox::insertPolicy instead.

See also insertionPolicy().

QString QComboBox::text ( int index ) const

Use itemText() instead.

void QComboBox::textChanged ( const QString & text )   [signal]

Use the editTextChanged(const QString &text) signal instead.