Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QComboBox Class Reference

The QComboBox widget combines a button with a dropdown list. More...

#include <qcombobox.h>

+ Inheritance diagram for QComboBox:
+ Collaboration diagram for QComboBox:

Public Types

enum  InsertPolicy {
  NoInsert , InsertAtTop , InsertAtCurrent , InsertAtBottom ,
  InsertAfterCurrent , InsertBeforeCurrent , InsertAlphabetically
}
 This enum specifies what the QComboBox should do when a new string is entered by the user. More...
 
enum  SizeAdjustPolicy { AdjustToContents , AdjustToContentsOnFirstShow , AdjustToMinimumContentsLengthWithIcon }
 This enum specifies how the size hint of the QComboBox should adjust when new content is added or content changes. More...
 
enum class  LabelDrawingMode { UseStyle , UseDelegate }
 
- Public Types inherited from QWidget
enum  RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
 This enum describes how to render the widget when calling QWidget::render(). More...
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric {
  PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM ,
  PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY ,
  PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled ,
  PdmDevicePixelRatioF_EncodedA , PdmDevicePixelRatioF_EncodedB
}
 

Public Slots

void clear ()
 Clears the combobox, removing all items.
 
void clearEditText ()
 Clears the contents of the line edit used for editing in the combobox.
 
void setEditText (const QString &text)
 Sets the text in the combobox's text edit.
 
void setCurrentIndex (int index)
 
void setCurrentText (const QString &text)
 
- Public Slots inherited from QWidget
void setEnabled (bool)
 
void setDisabled (bool)
 Disables widget input events if disable is true; otherwise enables input events.
 
void setWindowModified (bool)
 
void setWindowTitle (const QString &)
 
void setStyleSheet (const QString &styleSheet)
 
void setFocus ()
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.
 
void update ()
 Updates the widget unless updates are disabled or the widget is hidden.
 
void repaint ()
 Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.
 
virtual void setVisible (bool visible)
 
void setHidden (bool hidden)
 Convenience function, equivalent to setVisible(!hidden).
 
void show ()
 Shows the widget and its child widgets.
 
void hide ()
 Hides the widget.
 
void showMinimized ()
 Shows the widget minimized, as an icon.
 
void showMaximized ()
 Shows the widget maximized.
 
void showFullScreen ()
 Shows the widget in full-screen mode.
 
void showNormal ()
 Restores the widget after it has been maximized or minimized.
 
bool close ()
 Closes this widget.
 
void raise ()
 Raises this widget to the top of the parent widget's stack.
 
void lower ()
 Lowers the widget to the bottom of the parent widget's stack.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void editTextChanged (const QString &)
 This signal is emitted when the text in the combobox's line edit widget is changed.
 
void activated (int index)
 This signal is sent when the user chooses an item in the combobox.
 
void textActivated (const QString &)
 
void highlighted (int index)
 This signal is sent when an item in the combobox popup list is highlighted by the user.
 
void textHighlighted (const QString &)
 
void currentIndexChanged (int index)
 
void currentTextChanged (const QString &)
 
- Signals inherited from QWidget
void windowTitleChanged (const QString &title)
 This signal is emitted when the window's title has changed, with the new title as an argument.
 
void windowIconChanged (const QIcon &icon)
 This signal is emitted when the window's icon has changed, with the new icon as an argument.
 
void windowIconTextChanged (const QString &iconText)
 This signal is emitted when the window's icon text has changed, with the new iconText as an argument.
 
void customContextMenuRequested (const QPoint &pos)
 This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QComboBox (QWidget *parent=nullptr)
 Constructs a combobox with the given parent, using the default model QStandardItemModel.
 
 ~QComboBox ()
 Destroys the combobox.
 
int maxVisibleItems () const
 
void setMaxVisibleItems (int maxItems)
 
int count () const
 
void setMaxCount (int max)
 
int maxCount () const
 
bool duplicatesEnabled () const
 
void setDuplicatesEnabled (bool enable)
 
void setFrame (bool)
 
bool hasFrame () const
 
int findText (const QString &text, Qt::MatchFlags flags=static_cast< Qt::MatchFlags >(Qt::MatchExactly|Qt::MatchCaseSensitive)) const
 Returns the index of the item containing the given text; otherwise returns -1.
 
int findData (const QVariant &data, int role=Qt::UserRole, Qt::MatchFlags flags=static_cast< Qt::MatchFlags >(Qt::MatchExactly|Qt::MatchCaseSensitive)) const
 Returns the index of the item containing the given data for the given role; otherwise returns -1.
 
InsertPolicy insertPolicy () const
 
void setInsertPolicy (InsertPolicy policy)
 
SizeAdjustPolicy sizeAdjustPolicy () const
 
void setSizeAdjustPolicy (SizeAdjustPolicy policy)
 
int minimumContentsLength () const
 
void setMinimumContentsLength (int characters)
 
QSize iconSize () const
 
void setIconSize (const QSize &size)
 
void setPlaceholderText (const QString &placeholderText)
 
QString placeholderText () const
 
bool isEditable () const
 
void setEditable (bool editable)
 
void setLineEdit (QLineEdit *edit)
 Sets the line edit to use instead of the current line edit widget.
 
QLineEditlineEdit () const
 Returns the line edit used to edit items in the combobox, or \nullptr if there is no line edit.
 
void setValidator (const QValidator *v)
 Sets the validator to use instead of the current validator.
 
const QValidatorvalidator () const
 Returns the validator that is used to constrain text input for the combobox.
 
QAbstractItemDelegateitemDelegate () const
 Returns the item delegate used by the popup list view.
 
void setItemDelegate (QAbstractItemDelegate *delegate)
 Sets the item delegate for the popup list view.
 
QAbstractItemModelmodel () const
 Returns the model used by the combobox.
 
virtual void setModel (QAbstractItemModel *model)
 Sets the model to be model.
 
QModelIndex rootModelIndex () const
 Returns the root model item index for the items in the combobox.
 
void setRootModelIndex (const QModelIndex &index)
 Sets the root model item index for the items in the combobox.
 
int modelColumn () const
 
void setModelColumn (int visibleColumn)
 
LabelDrawingMode labelDrawingMode () const
 
void setLabelDrawingMode (LabelDrawingMode labelDrawing)
 
int currentIndex () const
 
QString currentText () const
 
QVariant currentData (int role=Qt::UserRole) const
 
QString itemText (int index) const
 Returns the text for the given index in the combobox.
 
QIcon itemIcon (int index) const
 Returns the icon for the given index in the combobox.
 
QVariant itemData (int index, int role=Qt::UserRole) const
 Returns the data for the given role in the given index in the combobox, or an invalid QVariant if there is no data for this role.
 
void addItem (const QString &text, const QVariant &userData=QVariant())
 Adds an item to the combobox with the given text, and containing the specified userData (stored in the Qt::UserRole).
 
void addItem (const QIcon &icon, const QString &text, const QVariant &userData=QVariant())
 Adds an item to the combobox with the given icon and text, and containing the specified userData (stored in the Qt::UserRole).
 
void addItems (const QStringList &texts)
 Adds each of the strings in the given texts to the combobox.
 
void insertItem (int index, const QString &text, const QVariant &userData=QVariant())
 Inserts the text and userData (stored in the Qt::UserRole) into the combobox at the given index.
 
void insertItem (int index, const QIcon &icon, const QString &text, const QVariant &userData=QVariant())
 Inserts the icon, text and userData (stored in the Qt::UserRole) into the combobox at the given index.
 
void insertItems (int index, const QStringList &texts)
 Inserts the strings from the list into the combobox as separate items, starting at the index specified.
 
void insertSeparator (int index)
 
void removeItem (int index)
 Removes the item at the given index from the combobox.
 
void setItemText (int index, const QString &text)
 Sets the text for the item on the given index in the combobox.
 
void setItemIcon (int index, const QIcon &icon)
 Sets the icon for the item on the given index in the combobox.
 
void 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.
 
QAbstractItemViewview () const
 Returns the list view used for the combobox popup.
 
void setView (QAbstractItemView *itemView)
 Sets the view to be used in the combobox popup to the given itemView.
 
QSize sizeHint () const override
 \reimp
 
QSize minimumSizeHint () const override
 \reimp
 
virtual void showPopup ()
 Displays the list of items in the combobox.
 
virtual void hidePopup ()
 Hides the list of items in the combobox if it is currently visible and resets the internal state, so that if the custom pop-up was shown inside the reimplemented showPopup(), then you also need to reimplement the hidePopup() function to hide your custom pop-up and call the base class implementation to reset the internal state whenever your custom pop-up widget is hidden.
 
bool event (QEvent *event) override
 \reimp
 
QVariant inputMethodQuery (Qt::InputMethodQuery) const override
 \reimp
 
Q_INVOKABLE QVariant inputMethodQuery (Qt::InputMethodQuery query, const QVariant &argument) const
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
 Constructs a widget which is a child of parent, with widget flags set to f.
 
 ~QWidget ()
 Destroys the widget.
 
int devType () const override
 
WId winId () const
 Returns the window system identifier of the widget.
 
void createWinId ()
 
WId internalWinId () const
 
WId effectiveWinId () const
 
QStylestyle () const
 
void setStyle (QStyle *)
 Sets the widget's GUI style to style.
 
bool isWindow () const
 Returns true if the widget is an independent window, otherwise returns false.
 
bool isModal () const
 
Qt::WindowModality windowModality () const
 
void setWindowModality (Qt::WindowModality windowModality)
 
bool isEnabled () const
 
bool isEnabledTo (const QWidget *) const
 Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false.
 
QRect frameGeometry () const
 
const QRectgeometry () const
 
QRect normalGeometry () const
 
int x () const
 
int y () const
 
QPoint pos () const
 
QSize frameSize () const
 
QSize size () const
 
int width () const
 
int height () const
 
QRect rect () const
 
QRect childrenRect () const
 
QRegion childrenRegion () const
 
QSize minimumSize () const
 
QSize maximumSize () const
 
int minimumWidth () const
 
int minimumHeight () const
 
int maximumWidth () const
 
int maximumHeight () const
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)).
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, maxh)).
 
void setMinimumWidth (int minw)
 
void setMinimumHeight (int minh)
 
void setMaximumWidth (int maxw)
 
void setMaximumHeight (int maxh)
 
QSize sizeIncrement () const
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h.
 
QSize baseSize () const
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)).
 
void setFixedSize (const QSize &)
 Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.
 
void setFixedSize (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h.
 
void setFixedWidth (int w)
 Sets both the minimum and maximum width of the widget to w without changing the heights.
 
void setFixedHeight (int h)
 Sets both the minimum and maximum heights of the widget to h without changing the widths.
 
QPointF mapToGlobal (const QPointF &) const
 Translates the widget coordinate pos to global screen coordinates.
 
QPoint mapToGlobal (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFromGlobal (const QPointF &) const
 Translates the global screen coordinate pos to widget coordinates.
 
QPoint mapFromGlobal (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapToParent (const QPointF &) const
 Translates the widget coordinate pos to a coordinate in the parent widget.
 
QPoint mapToParent (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFromParent (const QPointF &) const
 Translates the parent widget coordinate pos to widget coordinates.
 
QPoint mapFromParent (const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapTo (const QWidget *, const QPointF &) const
 Translates the widget coordinate pos to the coordinate system of parent.
 
QPoint mapTo (const QWidget *, const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QPointF mapFrom (const QWidget *, const QPointF &) const
 Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system.
 
QPoint mapFrom (const QWidget *, const QPoint &) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QWidgetwindow () const
 Returns the window for this widget, i.e.
 
QWidgetnativeParentWidget () const
 
QWidgettopLevelWidget () const
 
const QPalettepalette () const
 
void setPalette (const QPalette &)
 
void setBackgroundRole (QPalette::ColorRole)
 Sets the background role of the widget to role.
 
QPalette::ColorRole backgroundRole () const
 Returns the background role of the widget.
 
void setForegroundRole (QPalette::ColorRole)
 Sets the foreground role of the widget to role.
 
QPalette::ColorRole foregroundRole () const
 Returns the foreground role.
 
const QFontfont () const
 
void setFont (const QFont &)
 
QFontMetrics fontMetrics () const
 Returns the font metrics for the widget's current font.
 
QFontInfo fontInfo () const
 Returns the font info for the widget's current font.
 
QCursor cursor () const
 
void setCursor (const QCursor &)
 
void unsetCursor ()
 
void setMouseTracking (bool enable)
 
bool hasMouseTracking () const
 
bool underMouse () const
 Returns true if the widget is under the mouse cursor; otherwise returns false.
 
void setTabletTracking (bool enable)
 
bool hasTabletTracking () const
 
void setMask (const QBitmap &)
 Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible.
 
void setMask (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible.
 
QRegion mask () const
 Returns the mask currently set on a widget.
 
void clearMask ()
 Removes any mask set by setMask().
 
void render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 
void render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren))
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device().
 
Q_INVOKABLE QPixmap grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))
 
void grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
 Subscribes the widget to a given gesture with specific flags.
 
void ungrabGesture (Qt::GestureType type)
 Unsubscribes the widget from a given gesture type.
 
QString styleSheet () const
 
QString windowTitle () const
 
void setWindowIcon (const QIcon &icon)
 
QIcon windowIcon () const
 
void setWindowIconText (const QString &)
 
QString windowIconText () const
 
void setWindowRole (const QString &)
 Sets the window's role to role.
 
QString windowRole () const
 Returns the window's role, or an empty string.
 
void setWindowFilePath (const QString &filePath)
 
QString windowFilePath () const
 
void setWindowOpacity (qreal level)
 
qreal windowOpacity () const
 
bool isWindowModified () const
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
Qt::LayoutDirection layoutDirection () const
 
void unsetLayoutDirection ()
 
void setLocale (const QLocale &locale)
 
QLocale locale () const
 
void unsetLocale ()
 
bool isRightToLeft () const
 
bool isLeftToRight () const
 
bool isActiveWindow () const
 
void activateWindow ()
 Sets the top-level widget containing this widget to be the active window.
 
void clearFocus ()
 Takes keyboard input focus from the widget.
 
void setFocus (Qt::FocusReason reason)
 Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.
 
Qt::FocusPolicy focusPolicy () const
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
bool hasFocus () const
 
void setFocusProxy (QWidget *)
 Sets the widget's focus proxy to widget w.
 
QWidgetfocusProxy () const
 Returns the focus proxy, or \nullptr if there is no focus proxy.
 
Qt::ContextMenuPolicy contextMenuPolicy () const
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void grabMouse ()
 Grabs the mouse input.
 
void grabMouse (const QCursor &)
 
void releaseMouse ()
 Releases the mouse grab.
 
void grabKeyboard ()
 Grabs the keyboard input.
 
void releaseKeyboard ()
 Releases the keyboard grab.
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
 Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context.
 
void releaseShortcut (int id)
 Removes the shortcut with the given id from Qt's shortcut system.
 
void setShortcutEnabled (int id, bool enable=true)
 If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.
 
void setShortcutAutoRepeat (int id, bool enable=true)
 
bool updatesEnabled () const
 
void setUpdatesEnabled (bool enable)
 
void update (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget.
 
void update (const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget.
 
void update (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.
 
void repaint (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget.
 
void repaint (const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget.
 
void repaint (const QRegion &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.
 
void stackUnder (QWidget *)
 Places the widget under w in the parent widget's stack.
 
void move (int x, int y)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)).
 
void move (const QPoint &)
 
void resize (int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)).
 
void resize (const QSize &)
 
void setGeometry (int x, int y, int w, int h)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)).
 
void setGeometry (const QRect &)
 
QByteArray saveGeometry () const
 
bool restoreGeometry (const QByteArray &geometry)
 
void adjustSize ()
 Adjusts the size of the widget to fit its contents.
 
bool isVisible () const
 
bool isVisibleTo (const QWidget *) const
 Returns true if this widget would become visible if ancestor is shown; otherwise returns false.
 
bool isHidden () const
 Returns true if the widget is hidden, otherwise returns false.
 
bool isMinimized () const
 
bool isMaximized () const
 
bool isFullScreen () const
 
Qt::WindowStates windowState () const
 Returns the current window state.
 
void setWindowState (Qt::WindowStates state)
 Sets the window state to windowState.
 
void overrideWindowState (Qt::WindowStates state)
 
QSizePolicy sizePolicy () const
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width.
 
virtual int heightForWidth (int) const
 Returns the preferred height for this widget, given the width w.
 
virtual bool hasHeightForWidth () const
 
QRegion visibleRegion () const
 Returns the unobscured region where paint events can occur.
 
void setContentsMargins (int left, int top, int right, int bottom)
 Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom.
 
void setContentsMargins (const QMargins &margins)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QMargins contentsMargins () const
 The contentsMargins function returns the widget's contents margins.
 
QRect contentsRect () const
 Returns the area inside the widget's margins.
 
QLayoutlayout () const
 Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed.
 
void setLayout (QLayout *)
 Sets the layout manager for this widget to layout.
 
void updateGeometry ()
 Notifies the layout system that this widget has changed and may need to change geometry.
 
void setParent (QWidget *parent)
 Sets the parent of the widget to parent, and resets the window flags.
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument.
 
void scroll (int dx, int dy)
 Scrolls the widget including its children dx pixels to the right and dy downward.
 
void scroll (int dx, int dy, const QRect &)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget.
 
QWidgetfocusWidget () const
 Returns the last child of this widget that setFocus had been called on.
 
QWidgetnextInFocusChain () const
 Returns the next widget in this widget's focus chain.
 
QWidgetpreviousInFocusChain () const
 The previousInFocusChain function returns the previous widget in this widget's focus chain.
 
bool acceptDrops () const
 
void setAcceptDrops (bool on)
 
void addAction (QAction *action)
 Appends the action action to this widget's list of actions.
 
void addActions (const QList< QAction * > &actions)
 Appends the actions actions to this widget's list of actions.
 
void insertActions (QAction *before, const QList< QAction * > &actions)
 Inserts the actions actions to this widget's list of actions, before the action before.
 
void insertAction (QAction *before, QAction *action)
 Inserts the action action to this widget's list of actions, before the action before.
 
void removeAction (QAction *action)
 Removes the action action from this widget's list of actions.
 
QList< QAction * > actions () const
 Returns the (possibly empty) list of this widget's actions.
 
QActionaddAction (const QString &text)
 
QActionaddAction (const QIcon &icon, const QString &text)
 
QActionaddAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection)
 
QActionaddAction (const QIcon &icon, const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename... Args, typename = compatible_action_slot_args<Args...>>
QActionaddAction (const QString &text, Args &&...args)
 
template<typename... Args, typename = compatible_action_slot_args<Args...>>
QActionaddAction (const QIcon &icon, const QString &text, Args &&...args)
 
QWidgetparentWidget () const
 Returns the parent of this widget, or \nullptr if it does not have any parent widget.
 
void setWindowFlags (Qt::WindowFlags type)
 
Qt::WindowFlags windowFlags () const
 Window flags are a combination of a type (e.g.
 
void setWindowFlag (Qt::WindowType, bool on=true)
 
void overrideWindowFlags (Qt::WindowFlags type)
 Sets the window flags for the widget to flags, without telling the window system.
 
Qt::WindowType windowType () const
 Returns the window type of this widget.
 
QWidgetchildAt (int x, int y) const
 Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system.
 
QWidgetchildAt (const QPoint &p) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system.
 
QWidgetchildAt (const QPointF &p) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void setAttribute (Qt::WidgetAttribute, bool on=true)
 Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.
 
bool testAttribute (Qt::WidgetAttribute) const
 Returns true if attribute attribute is set on this widget; otherwise returns false.
 
QPaintEnginepaintEngine () const override
 Returns the widget's paint engine.
 
void ensurePolished () const
 Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).
 
bool isAncestorOf (const QWidget *child) const
 Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false.
 
bool autoFillBackground () const
 
void setAutoFillBackground (bool enabled)
 
QBackingStorebackingStore () const
 
QWindowwindowHandle () const
 If this is a native widget, return the associated QWindow.
 
QScreenscreen () const
 Returns the screen the widget is on.
 
void setScreen (QScreen *)
 Sets the screen on which the widget should be shown to screen.
 
Qt::InputMethodHints inputMethodHints () const
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QPaintDevice
virtual ~QPaintDevice ()
 
bool paintingActive () const
 
int width () const
 
int height () const
 
int widthMM () const
 
int heightMM () const
 
int logicalDpiX () const
 
int logicalDpiY () const
 
int physicalDpiX () const
 
int physicalDpiY () const
 
qreal devicePixelRatio () const
 
qreal devicePixelRatioF () const
 
int colorCount () const
 
int depth () const
 

Protected Member Functions

void focusInEvent (QFocusEvent *e) override
 \reimp
 
void focusOutEvent (QFocusEvent *e) override
 \reimp
 
void changeEvent (QEvent *e) override
 \reimp
 
void resizeEvent (QResizeEvent *e) override
 \reimp
 
void paintEvent (QPaintEvent *e) override
 \reimp
 
void showEvent (QShowEvent *e) override
 \reimp
 
void hideEvent (QHideEvent *e) override
 \reimp
 
void mousePressEvent (QMouseEvent *e) override
 \reimp
 
void mouseReleaseEvent (QMouseEvent *e) override
 \reimp
 
void keyPressEvent (QKeyEvent *e) override
 \reimp
 
void keyReleaseEvent (QKeyEvent *e) override
 \reimp
 
void contextMenuEvent (QContextMenuEvent *e) override
 \reimp
 
void inputMethodEvent (QInputMethodEvent *) override
 \reimp
 
virtual void initStyleOption (QStyleOptionComboBox *option) const
 Initialize option with the values from this QComboBox.
 
 QComboBox (QComboBoxPrivate &, QWidget *)
 
- Protected Member Functions inherited from QWidget
bool event (QEvent *event) override
 This is the main event handler; it handles event event.
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget.
 
virtual void mouseMoveEvent (QMouseEvent *event)
 This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget.
 
virtual void enterEvent (QEnterEvent *event)
 This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.
 
virtual void leaveEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.
 
virtual void moveEvent (QMoveEvent *event)
 This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter.
 
virtual void closeEvent (QCloseEvent *event)
 This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system.
 
virtual void actionEvent (QActionEvent *event)
 This event handler is called with the given event whenever the widget's actions are changed.
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, qintptr *result)
 This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.
 
int metric (PaintDeviceMetric) const override
 Internal implementation of the virtual QPaintDevice::metric() function.
 
void initPainter (QPainter *painter) const override
 Initializes the painter pen, background and font to the same as the given widget's.
 
QPaintDeviceredirected (QPoint *offset) const override
 
QPaintersharedPainter () const override
 
void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
 Creates a new widget window.
 
void destroy (bool destroyWindow=true, bool destroySubWindows=true)
 Frees up window system resources.
 
virtual bool focusNextPrevChild (bool next)
 Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget, or false if it can't.
 
bool focusNextChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns true if it can find a new widget, or false if it can't.
 
bool focusPreviousChild ()
 Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns true if it can find a new widget, or false if it can't.
 
 QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QPaintDevice
 QPaintDevice () noexcept
 
double getDecodedMetricF (PaintDeviceMetric metricA, PaintDeviceMetric metricB) const
 

Properties

bool editable
 whether the combo box can be edited by the user.
 
int count
 the number of items in the combobox.
 
QString currentText
 the current text
 
int currentIndex
 the index of the current item in the combobox.
 
QVariant currentData
 the data for the current item
 
int maxVisibleItems
 the maximum allowed size on screen of the combo box, measured in items
 
int maxCount
 the maximum number of items allowed in the combobox.
 
InsertPolicy insertPolicy
 the policy used to determine where user-inserted items should appear in the combobox.
 
SizeAdjustPolicy sizeAdjustPolicy
 the policy describing how the size of the combobox changes when the content changes.
 
int minimumContentsLength
 the minimum number of characters that should fit into the combobox.
 
QSize iconSize
 the size of the icons shown in the combobox.
 
QString placeholderText
 Sets a placeholderText text shown when no valid index is set.
 
bool duplicatesEnabled
 whether the user can enter duplicate items into the combobox.
 
bool frame
 whether the combo box draws itself with a frame.
 
int modelColumn
 the column in the model that is visible.
 
LabelDrawingMode labelDrawingMode
 the mode used by the combobox to draw its label.
 
- Properties inherited from QWidget
bool modal
 whether the widget is a modal widget
 
Qt::WindowModality windowModality
 which windows are blocked by the modal widget
 
bool enabled
 whether the widget is enabled
 
QRect geometry
 the geometry of the widget relative to its parent and excluding the window frame
 
QRect frameGeometry
 geometry of the widget relative to its parent including any window frame
 
QRect normalGeometry
 the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget
 
int x
 the x coordinate of the widget relative to its parent including any window frame
 
int y
 the y coordinate of the widget relative to its parent and including any window frame
 
QPoint pos
 the position of the widget within its parent widget
 
QSize frameSize
 the size of the widget including any window frame
 
QSize size
 the size of the widget excluding any window frame
 
int width
 the width of the widget excluding any window frame
 
int height
 the height of the widget excluding any window frame
 
QRect rect
 the internal geometry of the widget excluding any window frame
 
QRect childrenRect
 the bounding rectangle of the widget's children
 
QRegion childrenRegion
 the combined region occupied by the widget's children
 
QSizePolicy sizePolicy
 the default layout behavior of the widget
 
QSize minimumSize
 the widget's minimum size
 
QSize maximumSize
 the widget's maximum size in pixels
 
int minimumWidth
 the widget's minimum width in pixels
 
int minimumHeight
 the widget's minimum height in pixels
 
int maximumWidth
 the widget's maximum width in pixels
 
int maximumHeight
 the widget's maximum height in pixels
 
QSize sizeIncrement
 the size increment of the widget
 
QSize baseSize
 the base size of the widget
 
QPalette palette
 the widget's palette
 
QFont font
 the font currently set for the widget
 
QCursor cursor
 the cursor shape for this widget
 
bool mouseTracking
 whether mouse tracking is enabled for the widget
 
bool tabletTracking
 whether tablet tracking is enabled for the widget
 
bool isActiveWindow
 whether this widget's window is the active window
 
Qt::FocusPolicy focusPolicy
 the way the widget accepts keyboard focus
 
bool focus
 whether this widget (or its focus proxy) has the keyboard input focus
 
Qt::ContextMenuPolicy contextMenuPolicy
 how the widget shows a context menu
 
bool updatesEnabled
 whether updates are enabled
 
bool visible
 whether the widget is visible
 
bool minimized
 whether this widget is minimized (iconified)
 
bool maximized
 whether this widget is maximized
 
bool fullScreen
 whether the widget is shown in full screen mode
 
QSize sizeHint
 the recommended size for the widget
 
QSize minimumSizeHint
 the recommended minimum size for the widget
 
bool acceptDrops
 whether drop events are enabled for this widget
 
QString windowTitle
 the window title (caption)
 
QIcon windowIcon
 the widget's icon
 
QString windowIconText
 the text to be displayed on the icon of a minimized window
 
double windowOpacity
 The level of opacity for the window.
 
bool windowModified
 whether the document shown in the window has unsaved changes
 
Qt::LayoutDirection layoutDirection
 the layout direction for this widget.
 
bool autoFillBackground
 whether the widget background is filled automatically
 
QString styleSheet
 the widget's style sheet
 
QLocale locale
 the widget's locale
 
QString windowFilePath
 the file path associated with a widget
 
Qt::InputMethodHints inputMethodHints
 What input method specific hints the widget has.
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Static Public Member Functions inherited from QWidget
static void setTabOrder (QWidget *, QWidget *)
 Puts the second widget after the first widget in the focus order.
 
static void setTabOrder (std::initializer_list< QWidget * > widgets)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
static QWidgetmouseGrabber ()
 Returns the widget that is currently grabbing the mouse input.
 
static QWidgetkeyboardGrabber ()
 Returns the widget that is currently grabbing the keyboard input.
 
static QWidgetfind (WId)
 Returns a pointer to the widget with window identifier/handle id.
 
static QWidgetcreateWindowContainer (QWindow *window, QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
 Creates a QWidget that makes it possible to embed window into a QWidget-based application.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Static Public Member Functions inherited from QPaintDevice
static qreal devicePixelRatioFScale ()
 
static int encodeMetricF (PaintDeviceMetric metric, double value)
 
- Protected Slots inherited from QWidget
void updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)
 Updates the widget's micro focus and informs input methods that the state specified by query has changed.
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Protected Attributes inherited from QPaintDevice
ushort painters
 

Detailed Description

The QComboBox widget combines a button with a dropdown list.

\inmodule QtWidgets

\table \row

  • \inlineimage collapsed_combobox.png \caption Collapsed QCombobox
  • \inlineimage expanded_combobox.png \caption Expanded QCombobox \endtable

Definition at line 23 of file qcombobox.h.

Member Enumeration Documentation

◆ InsertPolicy

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

\value NoInsert The string will not be inserted into the combobox. \value InsertAtTop The string will be inserted as the first item in the combobox. \value InsertAtCurrent The current item will be replaced by the string. \value InsertAtBottom The string will be inserted after the last item in the combobox. \value InsertAfterCurrent The string is inserted after the current item in the combobox. \value InsertBeforeCurrent The string is inserted before the current item in the combobox. \value InsertAlphabetically The string is inserted in the alphabetic order in the combobox.

Enumerator
NoInsert 
InsertAtTop 
InsertAtCurrent 
InsertAtBottom 
InsertAfterCurrent 
InsertBeforeCurrent 
InsertAlphabetically 

Definition at line 68 of file qcombobox.h.

◆ LabelDrawingMode

enum class QComboBox::LabelDrawingMode
strong
Since
6.9

This enum specifies how the combobox draws its label.

\value UseStyle The combobox uses the \l{QStyle}{style} to draw its label. \value UseDelegate The combobox uses the \l{itemDelegate()}{item delegate} to draw the label. Set a suitable item delegate when using this mode.

See also
labelDrawingMode, {Books}{Books example}
Enumerator
UseStyle 
UseDelegate 

Definition at line 89 of file qcombobox.h.

◆ SizeAdjustPolicy

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

\value AdjustToContents The combobox will always adjust to the contents \value AdjustToContentsOnFirstShow The combobox will adjust to its contents the first time it is shown. \value AdjustToMinimumContentsLengthWithIcon The combobox will adjust to \l minimumContentsLength plus space for an icon. For performance reasons use this policy on large models.

Enumerator
AdjustToContents 
AdjustToContentsOnFirstShow 
AdjustToMinimumContentsLengthWithIcon 

Definition at line 82 of file qcombobox.h.

Constructor & Destructor Documentation

◆ QComboBox() [1/2]

QComboBox::QComboBox ( QWidget * parent = nullptr)
explicit

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

Definition at line 939 of file qcombobox.cpp.

◆ ~QComboBox()

QComboBox::~QComboBox ( )

Destroys the combobox.

Definition at line 1464 of file qcombobox.cpp.

◆ QComboBox() [2/2]

QComboBox::QComboBox ( QComboBoxPrivate & dd,
QWidget * parent )
protected

Definition at line 949 of file qcombobox.cpp.

Member Function Documentation

◆ activated

void QComboBox::activated ( int index)
signal

This signal is sent when the user chooses an item in the combobox.

The item's index is passed. Note that this signal is sent even when the choice is not changed. If you need to know when the choice actually changes, use signal currentIndexChanged() or currentTextChanged().

◆ addItem() [1/2]

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

Adds an item to the combobox with the given icon and text, and containing the specified userData (stored in the Qt::UserRole).

The item is appended to the list of existing items.

Definition at line 221 of file qcombobox.h.

◆ addItem() [2/2]

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

Adds an item to the combobox with the given text, and containing the specified userData (stored in the Qt::UserRole).

The item is appended to the list of existing items.

Definition at line 219 of file qcombobox.h.

◆ addItems()

void QComboBox::addItems ( const QStringList & texts)
inline

Adds each of the strings in the given texts to the combobox.

Each item is appended to the list of existing items in turn.

Definition at line 145 of file qcombobox.h.

◆ changeEvent()

void QComboBox::changeEvent ( QEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3017 of file qcombobox.cpp.

◆ clear

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.

Definition at line 2951 of file qcombobox.cpp.

◆ clearEditText

void QComboBox::clearEditText ( )
slot

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

Definition at line 2964 of file qcombobox.cpp.

◆ contextMenuEvent()

void QComboBox::contextMenuEvent ( QContextMenuEvent * e)
overrideprotectedvirtual

\reimp

\reimp

Reimplemented from QWidget.

Definition at line 3443 of file qcombobox.cpp.

◆ count()

int QComboBox::count ( ) const

Definition at line 1511 of file qcombobox.cpp.

◆ currentData()

QVariant QComboBox::currentData ( int role = Qt::UserRole) const

Definition at line 2259 of file qcombobox.cpp.

◆ currentIndex()

int QComboBox::currentIndex ( ) const

Definition at line 2160 of file qcombobox.cpp.

◆ currentIndexChanged

void QComboBox::currentIndexChanged ( int index)
signal
Since
4.1

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

◆ currentText()

QString QComboBox::currentText ( ) const

Definition at line 2241 of file qcombobox.cpp.

◆ currentTextChanged

void QComboBox::currentTextChanged ( const QString & text)
signal
Since
5.0

This signal is emitted whenever currentText changes. The new value is passed as text.

Note
It is not emitted, if currentText remains the same, even if currentIndex changes.

◆ duplicatesEnabled()

bool QComboBox::duplicatesEnabled ( ) const

Definition at line 1559 of file qcombobox.cpp.

◆ editTextChanged

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.

◆ event()

bool QComboBox::event ( QEvent * event)
overridevirtual

\reimp

Reimplemented from QObject.

Reimplemented in QFontComboBox.

Definition at line 3138 of file qcombobox.cpp.

◆ findData()

int QComboBox::findData ( const QVariant & data,
int role = Qt::UserRole,
Qt::MatchFlags flags = static_cast<Qt::MatchFlags>(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.

Definition at line 1585 of file qcombobox.cpp.

◆ findText()

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

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

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

Definition at line 62 of file qcombobox.h.

◆ focusInEvent()

void QComboBox::focusInEvent ( QFocusEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 2992 of file qcombobox.cpp.

◆ focusOutEvent()

void QComboBox::focusOutEvent ( QFocusEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3008 of file qcombobox.cpp.

◆ hasFrame()

bool QComboBox::hasFrame ( ) const

Definition at line 3555 of file qcombobox.cpp.

◆ hideEvent()

void QComboBox::hideEvent ( QHideEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3130 of file qcombobox.cpp.

◆ hidePopup()

void QComboBox::hidePopup ( )
virtual

Hides the list of items in the combobox if it is currently visible and resets the internal state, so that if the custom pop-up was shown inside the reimplemented showPopup(), then you also need to reimplement the hidePopup() function to hide your custom pop-up and call the base class implementation to reset the internal state whenever your custom pop-up widget is hidden.

See also
showPopup()

Definition at line 2882 of file qcombobox.cpp.

◆ highlighted

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 passed.

◆ iconSize()

QSize QComboBox::iconSize ( ) const

Definition at line 1688 of file qcombobox.cpp.

◆ initStyleOption()

void QComboBox::initStyleOption ( QStyleOptionComboBox * option) const
protectedvirtual

Initialize option with the values from this QComboBox.

This method is useful for subclasses when they need a QStyleOptionComboBox, but don't want to fill in all the information themselves.

See also
QStyleOption::initFrom()

Definition at line 1238 of file qcombobox.cpp.

◆ inputMethodEvent()

void QComboBox::inputMethodEvent ( QInputMethodEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3482 of file qcombobox.cpp.

◆ inputMethodQuery() [1/2]

QVariant QComboBox::inputMethodQuery ( Qt::InputMethodQuery query,
const QVariant & argument ) const

Definition at line 3508 of file qcombobox.cpp.

◆ inputMethodQuery() [2/2]

QVariant QComboBox::inputMethodQuery ( Qt::InputMethodQuery query) const
overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 3498 of file qcombobox.cpp.

◆ insertItem() [1/2]

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

Inserts the icon, text and userData (stored in the Qt::UserRole) 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()

Definition at line 2322 of file qcombobox.cpp.

◆ insertItem() [2/2]

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

Inserts the text and userData (stored in the Qt::UserRole) 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()

Definition at line 225 of file qcombobox.h.

◆ 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()

Definition at line 2373 of file qcombobox.cpp.

◆ insertPolicy()

QComboBox::InsertPolicy QComboBox::insertPolicy ( ) const

Definition at line 1606 of file qcombobox.cpp.

◆ insertSeparator()

void QComboBox::insertSeparator ( int index)
Since
4.4

Inserts a separator item 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
insertItem()

Definition at line 2422 of file qcombobox.cpp.

◆ isEditable()

bool QComboBox::isEditable ( ) const

Definition at line 1761 of file qcombobox.cpp.

◆ itemData()

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 an invalid QVariant if there is no data for this role.

Definition at line 2289 of file qcombobox.cpp.

◆ itemDelegate()

QAbstractItemDelegate * QComboBox::itemDelegate ( ) const

Returns the item delegate used by the popup list view.

See also
setItemDelegate()

Definition at line 2002 of file qcombobox.cpp.

◆ itemIcon()

QIcon QComboBox::itemIcon ( int index) const

Returns the icon for the given index in the combobox.

Definition at line 2278 of file qcombobox.cpp.

◆ itemText()

QString QComboBox::itemText ( int index) const

Returns the text for the given index in the combobox.

Definition at line 2268 of file qcombobox.cpp.

◆ keyPressEvent()

void QComboBox::keyPressEvent ( QKeyEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3242 of file qcombobox.cpp.

◆ keyReleaseEvent()

void QComboBox::keyReleaseEvent ( QKeyEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3396 of file qcombobox.cpp.

◆ labelDrawingMode()

QComboBox::LabelDrawingMode QComboBox::labelDrawingMode ( ) const

Definition at line 3629 of file qcombobox.cpp.

◆ lineEdit()

QLineEdit * QComboBox::lineEdit ( ) const

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

Only editable combo boxes have a line edit.

Definition at line 1915 of file qcombobox.cpp.

◆ maxCount()

int QComboBox::maxCount ( ) const

Definition at line 1544 of file qcombobox.cpp.

◆ maxVisibleItems()

int QComboBox::maxVisibleItems ( ) const

Definition at line 1488 of file qcombobox.cpp.

◆ minimumContentsLength()

int QComboBox::minimumContentsLength ( ) const

Definition at line 1657 of file qcombobox.cpp.

◆ minimumSizeHint()

QSize QComboBox::minimumSizeHint ( ) const
overridevirtual

\reimp

Reimplemented from QWidget.

Definition at line 2521 of file qcombobox.cpp.

◆ model()

QAbstractItemModel * QComboBox::model ( ) const

Returns the model used by the combobox.

Definition at line 2035 of file qcombobox.cpp.

◆ modelColumn()

int QComboBox::modelColumn ( ) const

Definition at line 3583 of file qcombobox.cpp.

◆ mousePressEvent()

void QComboBox::mousePressEvent ( QMouseEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3176 of file qcombobox.cpp.

◆ mouseReleaseEvent()

void QComboBox::mouseReleaseEvent ( QMouseEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3231 of file qcombobox.cpp.

◆ paintEvent()

void QComboBox::paintEvent ( QPaintEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QFileDialogComboBox.

Definition at line 3084 of file qcombobox.cpp.

◆ placeholderText()

QString QComboBox::placeholderText ( ) const

Definition at line 1743 of file qcombobox.cpp.

◆ removeItem()

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.

This function does nothing if index is out of range.

Definition at line 2439 of file qcombobox.cpp.

◆ resizeEvent()

void QComboBox::resizeEvent ( QResizeEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3075 of file qcombobox.cpp.

◆ rootModelIndex()

QModelIndex QComboBox::rootModelIndex ( ) const

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

See also
setRootModelIndex()

Definition at line 2130 of file qcombobox.cpp.

◆ setCurrentIndex

void QComboBox::setCurrentIndex ( int index)
slot

Definition at line 2166 of file qcombobox.cpp.

◆ setCurrentText

void QComboBox::setCurrentText ( const QString & text)
slot

Definition at line 2173 of file qcombobox.cpp.

◆ setDuplicatesEnabled()

void QComboBox::setDuplicatesEnabled ( bool enable)

Definition at line 1565 of file qcombobox.cpp.

◆ setEditable()

void QComboBox::setEditable ( bool editable)

Definition at line 1799 of file qcombobox.cpp.

◆ setEditText

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

Sets the text in the combobox's text edit.

Definition at line 2978 of file qcombobox.cpp.

◆ setFrame()

void QComboBox::setFrame ( bool enable)

Definition at line 3562 of file qcombobox.cpp.

◆ setIconSize()

void QComboBox::setIconSize ( const QSize & size)

Definition at line 1698 of file qcombobox.cpp.

◆ setInsertPolicy()

void QComboBox::setInsertPolicy ( InsertPolicy policy)

Definition at line 1612 of file qcombobox.cpp.

◆ setItemData()

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.

Definition at line 2475 of file qcombobox.cpp.

◆ setItemDelegate()

void QComboBox::setItemDelegate ( QAbstractItemDelegate * delegate)

Sets the item delegate for the popup list view.

The combobox takes ownership of the delegate.

Any existing delegate will be removed, but not deleted. QComboBox does not take ownership of delegate.

Warning
You should not share the same instance of a delegate between comboboxes, widget mappers or views. Doing so can cause incorrect or unintuitive editing behavior since each view connected to a given delegate may receive the \l{QAbstractItemDelegate::}{closeEditor()} signal, and attempt to access, modify or close an editor that has already been closed.
See also
itemDelegate()

Definition at line 2022 of file qcombobox.cpp.

◆ setItemIcon()

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

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

Definition at line 2462 of file qcombobox.cpp.

◆ setItemText()

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

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

Definition at line 2450 of file qcombobox.cpp.

◆ setLabelDrawingMode()

void QComboBox::setLabelDrawingMode ( LabelDrawingMode labelDrawing)

Definition at line 3635 of file qcombobox.cpp.

◆ setLineEdit()

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.

Note
Since the combobox's line edit owns the QCompleter, any previous call to setCompleter() will no longer have any effect.

Definition at line 1842 of file qcombobox.cpp.

◆ setMaxCount()

void QComboBox::setMaxCount ( int max)

Definition at line 1529 of file qcombobox.cpp.

◆ setMaxVisibleItems()

void QComboBox::setMaxVisibleItems ( int maxItems)

Definition at line 1494 of file qcombobox.cpp.

◆ setMinimumContentsLength()

void QComboBox::setMinimumContentsLength ( int characters)

Definition at line 1663 of file qcombobox.cpp.

◆ setModel()

void QComboBox::setModel ( QAbstractItemModel * model)
virtual

Sets the model to be model.

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

Note
If the combobox is editable, then the model will also be set on the completer of the line edit.
See also
clear() setCompleter()

Definition at line 2054 of file qcombobox.cpp.

◆ setModelColumn()

void QComboBox::setModelColumn ( int visibleColumn)

Definition at line 3589 of file qcombobox.cpp.

◆ setPlaceholderText()

void QComboBox::setPlaceholderText ( const QString & placeholderText)

Definition at line 1726 of file qcombobox.cpp.

◆ setRootModelIndex()

void QComboBox::setRootModelIndex ( const QModelIndex & index)

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

See also
rootModelIndex()

Definition at line 2141 of file qcombobox.cpp.

◆ setSizeAdjustPolicy()

void QComboBox::setSizeAdjustPolicy ( QComboBox::SizeAdjustPolicy policy)

Definition at line 1634 of file qcombobox.cpp.

◆ setValidator()

void QComboBox::setValidator ( const QValidator * validator)

Sets the validator to use instead of the current validator.

Note
The validator is removed when the \l editable property becomes false.

Definition at line 1930 of file qcombobox.cpp.

◆ setView()

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.

Definition at line 2502 of file qcombobox.cpp.

◆ showEvent()

void QComboBox::showEvent ( QShowEvent * e)
overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Definition at line 3116 of file qcombobox.cpp.

◆ showPopup()

void QComboBox::showPopup ( )
virtual

Displays the list of items in the combobox.

If the list is empty then no items will be shown.

If you reimplement this function to show a custom pop-up, make sure you call hidePopup() to reset the internal state.

See also
hidePopup()

Reimplemented in QFileDialogComboBox.

Definition at line 2637 of file qcombobox.cpp.

◆ sizeAdjustPolicy()

QComboBox::SizeAdjustPolicy QComboBox::sizeAdjustPolicy ( ) const

Definition at line 1628 of file qcombobox.cpp.

◆ sizeHint()

QSize QComboBox::sizeHint ( ) const
overridevirtual

\reimp

This implementation caches the size hint to avoid resizing when the contents change dynamically. To invalidate the cached value change the \l sizeAdjustPolicy.

Reimplemented from QWidget.

Reimplemented in QFontComboBox.

Definition at line 2534 of file qcombobox.cpp.

◆ textActivated

void QComboBox::textActivated ( const QString & text)
signal
Since
5.14

This signal is sent when the user chooses an item in the combobox. The item's text is passed. Note that this signal is sent even when the choice is not changed. If you need to know when the choice actually changes, use signal currentIndexChanged() or currentTextChanged().

◆ textHighlighted

void QComboBox::textHighlighted ( const QString & text)
signal
Since
5.14

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

◆ validator()

const QValidator * QComboBox::validator ( ) const

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

See also
editable

Definition at line 1943 of file qcombobox.cpp.

◆ view()

QAbstractItemView * QComboBox::view ( ) const

Returns the list view used for the combobox popup.

Definition at line 2487 of file qcombobox.cpp.

Property Documentation

◆ count

int QComboBox::count
read

the number of items in the combobox.

By default, for an empty combo box, this property has a value of 0.

Definition at line 28 of file qcombobox.h.

◆ currentData

QVariant QComboBox::currentData
read

the data for the current item

Since
5.2

By default, for an empty combo box or a combo box in which no current item is set, this property contains an invalid QVariant.

Definition at line 32 of file qcombobox.h.

◆ currentIndex

int QComboBox::currentIndex
readwrite

the index of the current item in the combobox.

The current index can change when inserting or removing items.

By default, for an empty combo box or a combo box in which no current item is set, this property has a value of -1.

Definition at line 31 of file qcombobox.h.

◆ currentText

QString QComboBox::currentText
readwrite

the current text

If the combo box is editable, the current text is the value displayed by the line edit. Otherwise, it is the value of the current item or an empty string if the combo box is empty or no current item is set.

The setter setCurrentText() simply calls setEditText() if the combo box is editable. Otherwise, if there is a matching text in the list, currentIndex is set to the corresponding index.

See also
editable, setEditText()

Definition at line 29 of file qcombobox.h.

◆ duplicatesEnabled

bool QComboBox::duplicatesEnabled
readwrite

whether the user can enter duplicate items into the combobox.

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

By default, this property is false (duplicates are not allowed).

Definition at line 40 of file qcombobox.h.

◆ editable

bool QComboBox::editable
readwrite

whether the combo box can be edited by the user.

By default, this property is false. The effect of editing depends on the insert policy.

Note
When disabling the editable state, the validator and completer are removed.
See also
InsertPolicy

Definition at line 27 of file qcombobox.h.

◆ frame

bool QComboBox::frame
readwrite

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.

Definition at line 41 of file qcombobox.h.

◆ iconSize

QSize QComboBox::iconSize
readwrite

the size of the icons shown in the combobox.

Unless explicitly set this returns the default value of the current style. This size is the maximum size that icons can have; icons of smaller size are not scaled up.

Definition at line 38 of file qcombobox.h.

◆ insertPolicy

InsertPolicy QComboBox::insertPolicy
readwrite

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

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

See also
InsertPolicy

Definition at line 35 of file qcombobox.h.

◆ labelDrawingMode

LabelDrawingMode QComboBox::labelDrawingMode
readwrite

the mode used by the combobox to draw its label.

Since
6.9

The default value is \l{QComboBox::}{UseStyle}. When changing this property to UseDelegate, make sure to also set a suitable \l{itemDelegate()}{item delegate}. The default delegate depends on the style and might not be suitable for drawing the label.

See also
{Books}{Books example}

Definition at line 43 of file qcombobox.h.

◆ maxCount

int QComboBox::maxCount
readwrite

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.

By default, this property's value is derived from the highest signed integer available (typically 2147483647).

Definition at line 34 of file qcombobox.h.

◆ maxVisibleItems

int QComboBox::maxVisibleItems
readwrite

the maximum allowed size on screen of the combo box, measured in items

By default, this property has a value of 10.

Note
This property is ignored for non-editable comboboxes in styles that returns true for QStyle::SH_ComboBox_Popup such as the Mac style or the Gtk+ Style.

Definition at line 33 of file qcombobox.h.

◆ minimumContentsLength

int QComboBox::minimumContentsLength
readwrite

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.

See also
sizeAdjustPolicy

Definition at line 37 of file qcombobox.h.

◆ modelColumn

int QComboBox::modelColumn
readwrite

the column in the model that is visible.

If set prior to populating the combo box, the pop-up view will not be affected and will show the first column (using this property's default value).

By default, this property has a value of 0.

Note
In an editable combobox, the visible column will also become the \l{QCompleter::completionColumn}{completion column}.

Definition at line 42 of file qcombobox.h.

◆ placeholderText

QString QComboBox::placeholderText
readwrite

Sets a placeholderText text shown when no valid index is set.

The placeholderText will be shown when an invalid index is set. The text is not accessible in the dropdown list. When this function is called before items are added the placeholder text will be shown, otherwise you have to call setCurrentIndex(-1) programmatically if you want to show the placeholder text. Set an empty placeholder text to reset the setting.

When the QComboBox is editable, use QLineEdit::setPlaceholderText() instead.

Since
5.15

Definition at line 39 of file qcombobox.h.

◆ sizeAdjustPolicy

SizeAdjustPolicy QComboBox::sizeAdjustPolicy
readwrite

the policy describing how the size of the combobox changes when the content changes.

The default value is \l AdjustToContentsOnFirstShow.

See also
SizeAdjustPolicy

Definition at line 36 of file qcombobox.h.


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