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
QQuickComboBox Class Reference

#include <qquickcombobox_p.h>

Inheritance diagram for QQuickComboBox:
Collaboration diagram for QQuickComboBox:

Public Types

enum  ImplicitContentWidthPolicy { ContentItemImplicitWidth , WidestText , WidestTextWhenCompleted }
Public Types inherited from QQuickItem
enum  Flag {
  ItemClipsChildrenToShape = 0x01 , ItemIsFocusScope = 0x04 , ItemHasContents = 0x08 , ItemAcceptsDrops = 0x10 ,
  ItemIsViewport = 0x20 , ItemObservesViewport = 0x40
}
 \qmltype Item \nativetype QQuickItem \inherits QtObject \inqmlmodule QtQuick More...
enum  ItemChange {
  ItemChildAddedChange , ItemChildRemovedChange , ItemSceneChange , ItemVisibleHasChanged ,
  ItemParentHasChanged , ItemOpacityHasChanged , ItemActiveFocusHasChanged , ItemRotationHasChanged ,
  ItemAntialiasingHasChanged , ItemDevicePixelRatioHasChanged , ItemEnabledHasChanged , ItemScaleHasChanged ,
  ItemTransformHasChanged
}
 Used in conjunction with QQuickItem::itemChange() to notify the item about certain types of changes. More...
enum  TransformOrigin {
  TopLeft , Top , TopRight , Left ,
  Center , Right , BottomLeft , Bottom ,
  BottomRight
}
 \variable QQuickItem::ItemChangeData::realValue The numeric value that has changed: \l {QQuickItem::opacity()}{opacity}, \l {QQuickItem::rotation()}{rotation}, or \l {QQuickItem::scale()}{scale}, or \l {QScreen::devicePixelRatio}{device pixel ratio}. More...

Public Slots

void incrementCurrentIndex ()
 \qmlmethod void QtQuick.Controls::ComboBox::incrementCurrentIndex()
void decrementCurrentIndex ()
 \qmlmethod void QtQuick.Controls::ComboBox::decrementCurrentIndex()
 Q_REVISION (2, 2) void selectAll()
Public Slots inherited from QQuickItem
void update ()
 Schedules a call to updatePaintNode() for this item.
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe

Signals

void activated (int index)
void highlighted (int index)
void countChanged ()
void modelChanged ()
void delegateModelChanged ()
void pressedChanged ()
void highlightedIndexChanged ()
void currentIndexChanged ()
void currentTextChanged ()
void displayTextChanged ()
void textRoleChanged ()
void delegateChanged ()
void indicatorChanged ()
void popupChanged ()
 Q_REVISION (2, 1) void flatChanged()
 Q_REVISION (2, 2) void accepted()
 Q_REVISION (2, 2) void downChanged()
 Q_REVISION (2, 2) void editableChanged()
 Q_REVISION (2, 2) void editTextChanged()
 Q_REVISION (2, 2) void inputMethodHintsChanged()
 Q_REVISION (2, 2) void inputMethodComposingChanged()
 Q_REVISION (2, 2) void acceptableInputChanged()
 Q_REVISION (2, 5) void implicitIndicatorWidthChanged()
 Q_REVISION (2, 5) void implicitIndicatorHeightChanged()
 Q_REVISION (2, 14) void valueRoleChanged()
 Q_REVISION (2, 14) void currentValueChanged()
 Q_REVISION (2, 15) void selectTextByMouseChanged()
 Q_REVISION (6, 0) void implicitContentWidthPolicyChanged()
Signals inherited from QQuickControl
void fontChanged ()
void availableWidthChanged ()
void availableHeightChanged ()
void paddingChanged ()
void topPaddingChanged ()
void leftPaddingChanged ()
void rightPaddingChanged ()
void bottomPaddingChanged ()
void spacingChanged ()
void localeChanged ()
void focusReasonChanged ()
void mirroredChanged ()
void visualFocusChanged ()
void hoveredChanged ()
void hoverEnabledChanged ()
void wheelEnabledChanged ()
void backgroundChanged ()
void contentItemChanged ()
void baselineOffsetChanged ()
 Q_REVISION (2, 5) void horizontalPaddingChanged()
 Q_REVISION (2, 5) void verticalPaddingChanged()
 Q_REVISION (2, 5) void implicitContentWidthChanged()
 Q_REVISION (2, 5) void implicitContentHeightChanged()
 Q_REVISION (2, 5) void implicitBackgroundWidthChanged()
 Q_REVISION (2, 5) void implicitBackgroundHeightChanged()
 Q_REVISION (2, 5) void topInsetChanged()
 Q_REVISION (2, 5) void leftInsetChanged()
 Q_REVISION (2, 5) void rightInsetChanged()
 Q_REVISION (2, 5) void bottomInsetChanged()
Signals inherited from QQuickItem
void childrenRectChanged (const QRectF &)
void baselineOffsetChanged (qreal)
void stateChanged (const QString &)
void focusChanged (bool)
void activeFocusChanged (bool)
Q_REVISION(6, 7) void focusPolicyChanged(Qt Q_REVISION (2, 1) void activeFocusOnTabChanged(bool)
void parentChanged (QQuickItem *)
void transformOriginChanged (TransformOrigin)
void smoothChanged (bool)
void antialiasingChanged (bool)
void clipChanged (bool)
 Q_REVISION (2, 1) void windowChanged(QQuickWindow *window)
void childrenChanged ()
void opacityChanged ()
void enabledChanged ()
void visibleChanged ()
void visibleChildrenChanged ()
void rotationChanged ()
void scaleChanged ()
void xChanged ()
void yChanged ()
void widthChanged ()
void heightChanged ()
void zChanged ()
void implicitWidthChanged ()
void implicitHeightChanged ()
 Q_REVISION (2, 11) void containmentMaskChanged()
 Q_REVISION (6, 0) void paletteChanged()
 Q_REVISION (6, 0) void paletteCreated()
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

 QQuickComboBox (QQuickItem *parent=nullptr)
 ~QQuickComboBox ()
int count () const
 \readonly \qmlproperty int QtQuick.Controls::ComboBox::count
QVariant model () const
 \qmlproperty model QtQuick.Controls::ComboBox::model
void setModel (const QVariant &model)
QQmlInstanceModeldelegateModel () const
 \readonly \qmlproperty model QtQuick.Controls::ComboBox::delegateModel
bool isPressed () const
 \readonly \qmlproperty bool QtQuick.Controls::ComboBox::pressed
void setPressed (bool pressed)
int highlightedIndex () const
 \readonly \qmlproperty int QtQuick.Controls::ComboBox::highlightedIndex
int currentIndex () const
 \qmlproperty int QtQuick.Controls::ComboBox::currentIndex
void setCurrentIndex (int index)
QString currentText () const
 \readonly \qmlproperty string QtQuick.Controls::ComboBox::currentText
QString displayText () const
 \qmlproperty string QtQuick.Controls::ComboBox::displayText
void setDisplayText (const QString &text)
void resetDisplayText ()
QString textRole () const
 \qmlproperty string QtQuick.Controls::ComboBox::textRole
void setTextRole (const QString &role)
QString valueRole () const
void setValueRole (const QString &role)
QQmlComponentdelegate () const
 \qmlproperty Component QtQuick.Controls::ComboBox::delegate
void setDelegate (QQmlComponent *delegate)
QQuickItemindicator () const
 \qmlproperty Item QtQuick.Controls::ComboBox::indicator
void setIndicator (QQuickItem *indicator)
QQuickPopuppopup () const
 \qmlproperty Popup QtQuick.Controls::ComboBox::popup
void setPopup (QQuickPopup *popup)
Q_INVOKABLE QString textAt (int index) const
 \qmlmethod string QtQuick.Controls::ComboBox::textAt(int index)
Q_INVOKABLE int find (const QString &text, Qt::MatchFlags flags=Qt::MatchExactly) const
 \qmlmethod int QtQuick.Controls::ComboBox::find(string text, enumeration flags)
bool isFlat () const
void setFlat (bool flat)
bool isDown () const
void setDown (bool down)
void resetDown ()
bool isEditable () const
void setEditable (bool editable)
QString editText () const
void setEditText (const QString &text)
void resetEditText ()
Qt::InputMethodHints inputMethodHints () const
void setInputMethodHints (Qt::InputMethodHints hints)
bool isInputMethodComposing () const
bool hasAcceptableInput () const
qreal implicitIndicatorWidth () const
qreal implicitIndicatorHeight () const
QVariant currentValue () const
 Q_REVISION (6, 10) void setCurrentValue(const QVariant &value)
 Q_REVISION (2, 14) Q_INVOKABLE QVariant valueAt(int index) const
 Q_REVISION (2, 14) Q_INVOKABLE int indexOfValue(const QVariant &value) const
bool selectTextByMouse () const
void setSelectTextByMouse (bool canSelect)
ImplicitContentWidthPolicy implicitContentWidthPolicy () const
void setImplicitContentWidthPolicy (ImplicitContentWidthPolicy policy)
Public Member Functions inherited from QQuickControl
 QQuickControl (QQuickItem *parent=nullptr)
 ~QQuickControl ()
QFont font () const
 \qmlproperty font QtQuick.Controls::Control::font
void setFont (const QFont &font)
void resetFont ()
qreal availableWidth () const
 \qmlproperty real QtQuick.Controls::Control::availableWidth \readonly
qreal availableHeight () const
 \qmlproperty real QtQuick.Controls::Control::availableHeight \readonly
qreal padding () const
 \qmlproperty real QtQuick.Controls::Control::padding
void setPadding (qreal padding)
void resetPadding ()
qreal topPadding () const
 \qmlproperty real QtQuick.Controls::Control::topPadding
void setTopPadding (qreal padding)
void resetTopPadding ()
qreal leftPadding () const
 \qmlproperty real QtQuick.Controls::Control::leftPadding
void setLeftPadding (qreal padding)
void resetLeftPadding ()
qreal rightPadding () const
 \qmlproperty real QtQuick.Controls::Control::rightPadding
void setRightPadding (qreal padding)
void resetRightPadding ()
qreal bottomPadding () const
 \qmlproperty real QtQuick.Controls::Control::bottomPadding
void setBottomPadding (qreal padding)
void resetBottomPadding ()
qreal spacing () const
 \qmlproperty real QtQuick.Controls::Control::spacing
void setSpacing (qreal spacing)
void resetSpacing ()
QLocale locale () const
 \qmlproperty Locale QtQuick.Controls::Control::locale
void setLocale (const QLocale &locale)
void resetLocale ()
bool isMirrored () const
 \qmlproperty bool QtQuick.Controls::Control::mirrored \readonly
Qt::FocusReason focusReason () const
 \qmlproperty enumeration QtQuick.Controls::Control::focusReason
void setFocusReason (Qt::FocusReason reason)
bool hasVisualFocus () const
 \qmlproperty bool QtQuick.Controls::Control::visualFocus \readonly
bool isHovered () const
 \qmlproperty bool QtQuick.Controls::Control::hovered \readonly
void setHovered (bool hovered)
bool isHoverEnabled () const
 \qmlproperty bool QtQuick.Controls::Control::hoverEnabled
void setHoverEnabled (bool enabled)
void resetHoverEnabled ()
bool isWheelEnabled () const
 \qmlproperty bool QtQuick.Controls::Control::wheelEnabled
void setWheelEnabled (bool enabled)
QQuickItembackground () const
 \qmlproperty Item QtQuick.Controls::Control::background
void setBackground (QQuickItem *background)
QQuickItemcontentItem () const
 \qmlproperty Item QtQuick.Controls::Control::contentItem
void setContentItem (QQuickItem *item)
qreal baselineOffset () const
void setBaselineOffset (qreal offset)
void resetBaselineOffset ()
qreal horizontalPadding () const
void setHorizontalPadding (qreal padding)
void resetHorizontalPadding ()
qreal verticalPadding () const
void setVerticalPadding (qreal padding)
void resetVerticalPadding ()
qreal implicitContentWidth () const
qreal implicitContentHeight () const
qreal implicitBackgroundWidth () const
qreal implicitBackgroundHeight () const
qreal topInset () const
void setTopInset (qreal inset)
void resetTopInset ()
qreal leftInset () const
void setLeftInset (qreal inset)
void resetLeftInset ()
qreal rightInset () const
void setRightInset (qreal inset)
void resetRightInset ()
qreal bottomInset () const
void setBottomInset (qreal inset)
void resetBottomInset ()
Public Member Functions inherited from QQuickItem
 QQuickItem (QQuickItem *parent=nullptr)
 Constructs a QQuickItem with the given parent.
 ~QQuickItem () override
 Destroys the QQuickItem.
QQuickWindowwindow () const
 Returns the window in which this item is rendered.
QQuickItemparentItem () const
void setParentItem (QQuickItem *parent)
void stackBefore (const QQuickItem *)
 Moves this item to the index before the specified sibling item within the list of children.
void stackAfter (const QQuickItem *)
 Moves this item to the index after the specified sibling item within the list of children.
QRectF childrenRect ()
 \qmlpropertygroup QtQuick::Item::childrenRect \qmlproperty real QtQuick::Item::childrenRect.x \qmlproperty real QtQuick::Item::childrenRect.y \qmlproperty real QtQuick::Item::childrenRect.width \qmlproperty real QtQuick::Item::childrenRect.height \readonly
QList< QQuickItem * > childItems () const
 Returns the children of this item.
bool clip () const
 \qmlproperty bool QtQuick::Item::clip This property holds whether clipping is enabled.
void setClip (bool)
QString state () const
 \qmlproperty string QtQuick::Item::state
void setState (const QString &)
qreal baselineOffset () const
 \qmlproperty int QtQuick::Item::baselineOffset
void setBaselineOffset (qreal)
QQmlListProperty< QQuickTransformtransform ()
qreal x () const
qreal y () const
QPointF position () const
void setX (qreal)
void setY (qreal)
void setPosition (const QPointF &)
QBindable< qrealbindableX ()
QBindable< qrealbindableY ()
qreal width () const
void setWidth (qreal)
void resetWidth ()
void setImplicitWidth (qreal)
qreal implicitWidth () const
 Returns the width of the item that is implied by other properties that determine the content.
QBindable< qrealbindableWidth ()
qreal height () const
void setHeight (qreal)
void resetHeight ()
void setImplicitHeight (qreal)
qreal implicitHeight () const
QBindable< qrealbindableHeight ()
QSizeF size () const
void setSize (const QSizeF &size)
TransformOrigin transformOrigin () const
void setTransformOrigin (TransformOrigin)
QPointF transformOriginPoint () const
void setTransformOriginPoint (const QPointF &)
qreal z () const
void setZ (qreal)
qreal rotation () const
void setRotation (qreal)
qreal scale () const
void setScale (qreal)
qreal opacity () const
void setOpacity (qreal)
bool isVisible () const
void setVisible (bool)
bool isEnabled () const
void setEnabled (bool)
bool smooth () const
void setSmooth (bool)
bool activeFocusOnTab () const
 \qmlproperty bool QtQuick::Item::activeFocusOnTab
void setActiveFocusOnTab (bool)
bool antialiasing () const
void setAntialiasing (bool)
void resetAntialiasing ()
Flags flags () const
 Returns the item flags for this item.
void setFlag (Flag flag, bool enabled=true)
 Enables the specified flag for this item if enabled is true; if enabled is false, the flag is disabled.
void setFlags (Flags flags)
 Enables the specified flags for this item.
virtual QRectF boundingRect () const
 Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
virtual QRectF clipRect () const
 Returns the rectangular area within this item that is currently visible in \l viewportItem(), if there is a viewport and the \l ItemObservesViewport flag is set; otherwise, the extents of this item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
QQuickItemviewportItem () const
 If the \l ItemObservesViewport flag is set, returns the nearest parent with the \l ItemIsViewport flag.
bool hasActiveFocus () const
bool hasFocus () const
void setFocus (bool)
void setFocus (bool focus, Qt::FocusReason reason)
bool isFocusScope () const
 Returns true if this item is a focus scope, and false otherwise.
QQuickItemscopedFocusItem () const
 If this item is a focus scope, this returns the item in its focus chain that currently has focus.
Qt::FocusPolicy focusPolicy () const
void setFocusPolicy (Qt::FocusPolicy policy)
 Sets the focus policy of this item to policy.
bool isAncestorOf (const QQuickItem *child) const
 Returns true if this item is an ancestor of child (i.e., if this item is child's parent, or one of child's parent's ancestors).
Qt::MouseButtons acceptedMouseButtons () const
 Returns the mouse buttons accepted by this item.
void setAcceptedMouseButtons (Qt::MouseButtons buttons)
 Sets the mouse buttons accepted by this item to buttons.
bool acceptHoverEvents () const
 Returns whether hover events are accepted by this item.
void setAcceptHoverEvents (bool enabled)
 If enabled is true, this sets the item to accept hover events; otherwise, hover events are not accepted by this item.
bool acceptTouchEvents () const
 Returns whether touch events are accepted by this item.
void setAcceptTouchEvents (bool accept)
 If enabled is true, this sets the item to accept touch events; otherwise, touch events are not accepted by this item.
bool isUnderMouse () const
void grabMouse ()
void ungrabMouse ()
bool keepMouseGrab () const
 Returns whether mouse input should exclusively remain with this item.
void setKeepMouseGrab (bool)
 Sets whether the mouse input should remain exclusively with this item.
bool filtersChildMouseEvents () const
 Returns whether pointer events intended for this item's children should be filtered through this item.
void setFiltersChildMouseEvents (bool filter)
 Sets whether pointer events intended for this item's children should be filtered through this item.
void grabTouchPoints (const QList< int > &ids)
void ungrabTouchPoints ()
bool keepTouchGrab () const
 Returns whether the touch points grabbed by this item should exclusively remain with this item.
void setKeepTouchGrab (bool)
 Sets whether the touch points grabbed by this item should remain exclusively with this item.
 Q_REVISION (2, 4) Q_INVOKABLE bool grabToImage(const QJSValue &callback
QSharedPointer< QQuickItemGrabResultgrabToImage (const QSize &targetSize=QSize())
 Grabs the item into an in-memory image.
virtual Q_INVOKABLE bool contains (const QPointF &point) const
 \qmlmethod bool QtQuick::Item::contains(point point)
QObjectcontainmentMask () const
void setContainmentMask (QObject *mask)
QTransform itemTransform (QQuickItem *, bool *) const
 \qmlmethod point QtQuick::Item::mapFromItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapFromItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, rect r)
QPointF mapToScene (const QPointF &point) const
 Maps the given point in this item's coordinate system to the equivalent point within the scene's coordinate system, and returns the mapped coordinate.
QRectF mapRectToItem (const QQuickItem *item, const QRectF &rect) const
 Maps the given rect in this item's coordinate system to the equivalent rectangular area within item's coordinate system, and returns the mapped rectangle value.
QRectF mapRectToScene (const QRectF &rect) const
 Maps the given rect in this item's coordinate system to the equivalent rectangular area within the scene's coordinate system, and returns the mapped rectangle value.
QPointF mapFromScene (const QPointF &point) const
 Maps the given point in the scene's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.
QRectF mapRectFromItem (const QQuickItem *item, const QRectF &rect) const
 Maps the given rect in item's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.
QRectF mapRectFromScene (const QRectF &rect) const
 Maps the given rect in the scene's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.
void polish ()
 Schedules a polish event for this item.
Q_INVOKABLE QPointF mapFromItem (const QQuickItem *item, const QPointF &point) const
 Maps the given point in item's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.
Q_INVOKABLE QPointF mapFromItem (const QQuickItem *item, qreal x, qreal y)
Q_INVOKABLE QRectF mapFromItem (const QQuickItem *item, const QRectF &rect) const
Q_INVOKABLE QRectF mapFromItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const
Q_INVOKABLE QPointF mapToItem (const QQuickItem *item, const QPointF &point) const
 Maps the given point in this item's coordinate system to the equivalent point within item's coordinate system, and returns the mapped coordinate.
Q_INVOKABLE QPointF mapToItem (const QQuickItem *item, qreal x, qreal y)
Q_INVOKABLE QRectF mapToItem (const QQuickItem *item, const QRectF &rect) const
Q_INVOKABLE QRectF mapToItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(qreal x
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(const QPointF &point) const
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(qreal x
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(const QPointF &point) const
Q_INVOKABLE void forceActiveFocus ()
 \qmlmethod point QtQuick::Item::mapToItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapToItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapToItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapToItem(Item item, rect r)
Q_INVOKABLE void forceActiveFocus (Qt::FocusReason reason)
 \qmlmethod QtQuick::Item::forceActiveFocus(Qt::FocusReason reason) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Forces active focus on the item with the given reason.
 Q_REVISION (2, 1) Q_INVOKABLE QQuickItem *nextItemInFocusChain(bool forward
Q_INVOKABLE QQuickItemchildAt (qreal x, qreal y) const
 \qmlmethod Item QtQuick::Item::childAt(real x, real y)
 Q_REVISION (6, 3) Q_INVOKABLE void ensurePolished()
 Q_REVISION (6, 3) Q_INVOKABLE void dumpItemTree() const
virtual bool isTextureProvider () const
 Returns true if this item is a texture provider.
virtual QSGTextureProvidertextureProvider () const
 Returns the texture provider for an item.
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.
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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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 QQmlParserStatus
 QQmlParserStatus ()
virtual ~QQmlParserStatus ()

Protected Member Functions

bool eventFilter (QObject *object, QEvent *event) override
 Filters events if this object has been installed as an event filter for the watched object.
void focusInEvent (QFocusEvent *event) override
 This event handler can be reimplemented in a subclass to receive focus-in events for an item.
void focusOutEvent (QFocusEvent *event) override
 This event handler can be reimplemented in a subclass to receive focus-out events for an item.
void keyPressEvent (QKeyEvent *event) override
 This event handler can be reimplemented in a subclass to receive key press events for an item.
void keyReleaseEvent (QKeyEvent *event) override
 This event handler can be reimplemented in a subclass to receive key release events for an item.
bool event (QEvent *e) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
void itemChange (ItemChange change, const ItemChangeData &value) override
 Called when change occurs for this item.
void fontChange (const QFont &newFont, const QFont &oldFont) override
void contentItemChange (QQuickItem *newItem, QQuickItem *oldItem) override
void localeChange (const QLocale &newLocale, const QLocale &oldLocale) override
QFont defaultFont () const override
Protected Member Functions inherited from QQuickControl
 QQuickControl (QQuickControlPrivate &dd, QQuickItem *parent)
void classBegin () override
 Invoked after class creation, but before any properties have been set.
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
void itemChange (ItemChange change, const ItemChangeData &value) override
 Called when change occurs for this item.
void focusInEvent (QFocusEvent *event) override
 This event handler can be reimplemented in a subclass to receive focus-in events for an item.
void focusOutEvent (QFocusEvent *event) override
 This event handler can be reimplemented in a subclass to receive focus-out events for an item.
void mousePressEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse press events for an item.
void mouseMoveEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse move events for an item.
void mouseReleaseEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse release events for an item.
void mouseUngrabEvent () override
 This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.
void geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override
virtual void mirrorChange ()
virtual void spacingChange (qreal newSpacing, qreal oldSpacing)
virtual void paddingChange (const QMarginsF &newPadding, const QMarginsF &oldPadding)
virtual void insetChange (const QMarginsF &newInset, const QMarginsF &oldInset)
virtual void enabledChange ()
QString accessibleName () const
void maybeSetAccessibleName (const QString &name)
QVariant accessibleProperty (const char *propertyName)
bool setAccessibleProperty (const char *propertyName, const QVariant &value)
Protected Member Functions inherited from QQuickItem
bool event (QEvent *) override
 \reimp
bool isComponentComplete () const
 Returns true if construction of the QML component is complete; otherwise returns false.
bool widthValid () const
 Returns whether the width property has been set explicitly.
bool heightValid () const
 Returns whether the height property has been set explicitly.
void setImplicitSize (qreal, qreal)
void classBegin () override
 \reimp Derived classes should call the base class method before adding their own action to perform at classBegin.
void componentComplete () override
 \reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 This event handler can be reimplemented in a subclass to receive mouse double-click events for an item.
virtual void touchUngrabEvent ()
 This event handler can be reimplemented in a subclass to be notified when a touch ungrab event has occurred on this item.
virtual void touchEvent (QTouchEvent *event)
 This event handler can be reimplemented in a subclass to receive touch events for an item.
virtual void hoverEnterEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-enter events for an item.
virtual void hoverMoveEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-move events for an item.
virtual void hoverLeaveEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-leave events for an item.
virtual bool childMouseEventFilter (QQuickItem *, QEvent *)
 Reimplement this method to filter the pointer events that are received by this item's children.
virtual bool contextMenuEvent (QContextMenuEvent *event)
virtual QSGNodeupdatePaintNode (QSGNode *, UpdatePaintNodeData *)
 Called on the render thread when it is time to sync the state of the item with the scene graph.
virtual void releaseResources ()
 This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode().
virtual void updatePolish ()
 This function should perform any layout as required for this item.
 QQuickItem (QQuickItemPrivate &dd, QQuickItem *parent=nullptr)
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)

Properties

int count
QVariant model
QQmlInstanceModeldelegateModel
bool pressed
int highlightedIndex
int currentIndex
QString currentText
QString displayText
QString textRole
QQmlComponentdelegate
QQuickItemindicator
QQuickPopuppopup
bool flat
bool down
bool editable
QString editText
Qt::InputMethodHints inputMethodHints
bool inputMethodComposing
bool acceptableInput
qreal implicitIndicatorWidth
qreal implicitIndicatorHeight
QVariant currentValue
QString valueRole
bool selectTextByMouse
ImplicitContentWidthPolicy implicitContentWidthPolicy
Properties inherited from QQuickControl
QFont font
qreal availableWidth
qreal availableHeight
qreal padding
qreal topPadding
qreal leftPadding
qreal rightPadding
qreal bottomPadding
qreal spacing
QLocale locale
bool mirrored
Qt::FocusReason focusReason
bool visualFocus
bool hovered
bool hoverEnabled
bool wheelEnabled
QQuickItembackground
QQuickItemcontentItem
qreal baselineOffset
qreal horizontalPadding
qreal verticalPadding
qreal implicitContentWidth
qreal implicitContentHeight
qreal implicitBackgroundWidth
qreal implicitBackgroundHeight
qreal topInset
qreal leftInset
qreal rightInset
qreal bottomInset
Properties inherited from QQuickItem
QQuickItemparent
 \qmlproperty Item QtQuick::Item::parent This property holds the visual parent of the item.
qreal x
 \qmlproperty real QtQuick::Item::x \qmlproperty real QtQuick::Item::y \qmlproperty real QtQuick::Item::width \qmlproperty real QtQuick::Item::height
qreal y
 Defines the item's y position relative to its parent.
qreal z
 \qmlproperty real QtQuick::Item::z
qreal width
 This property holds the width of this item.
qreal height
 This property holds the height of this item.
qreal opacity
 \qmlproperty real QtQuick::Item::opacity
bool enabled
 \qmlproperty bool QtQuick::Item::enabled
bool visible
 \qmlproperty bool QtQuick::Item::visible
Qt::FocusPolicy focusPolicy
 \qmlproperty enumeration QtQuick::Item::focusPolicy
qreal rotation
 \qmlproperty real QtQuick::Item::rotation This property holds the rotation of the item in degrees clockwise around its transformOrigin.
qreal scale
 \qmlproperty real QtQuick::Item::scale This property holds the scale factor for this item.
TransformOrigin transformOrigin
 \qmlproperty enumeration QtQuick::Item::transformOrigin This property holds the origin point around which scale and rotation transform.
QPointF transformOriginPoint
QQmlListProperty< QQuickTransformtransform
 \qmlproperty list<Transform> QtQuick::Item::transform
bool smooth
 \qmlproperty bool QtQuick::Item::smooth
bool antialiasing
 \qmlproperty bool QtQuick::Item::antialiasing
qreal implicitWidth
qreal implicitHeight
QObjectcontainmentMask
 \qmlproperty QObject* QtQuick::Item::containmentMask
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

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)
Public Attributes inherited from QQuickItem
const QSizetargetSize = QSize())
qreal y const
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Detailed Description

Definition at line 35 of file qquickcombobox_p.h.

Member Enumeration Documentation

◆ ImplicitContentWidthPolicy

Enumerator
ContentItemImplicitWidth 
WidestText 
WidestTextWhenCompleted 

Definition at line 161 of file qquickcombobox_p.h.

Constructor & Destructor Documentation

◆ QQuickComboBox()

QQuickComboBox::QQuickComboBox ( QQuickItem * parent = nullptr)
explicit

Definition at line 1042 of file qquickcombobox.cpp.

◆ ~QQuickComboBox()

QQuickComboBox::~QQuickComboBox ( )

Definition at line 1056 of file qquickcombobox.cpp.

Member Function Documentation

◆ activated

void QQuickComboBox::activated ( int index)
signal

◆ componentComplete()

void QQuickComboBox::componentComplete ( )
overrideprotectedvirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 2295 of file qquickcombobox.cpp.

◆ contentItemChange()

void QQuickComboBox::contentItemChange ( QQuickItem * newItem,
QQuickItem * oldItem )
overrideprotectedvirtual

Reimplemented from QQuickControl.

Definition at line 2336 of file qquickcombobox.cpp.

◆ count()

int QQuickComboBox::count ( ) const

\readonly \qmlproperty int QtQuick.Controls::ComboBox::count

This property holds the number of items in the combo box.

Definition at line 1075 of file qquickcombobox.cpp.

◆ countChanged

void QQuickComboBox::countChanged ( )
signal

◆ currentIndex()

int QQuickComboBox::currentIndex ( ) const

\qmlproperty int QtQuick.Controls::ComboBox::currentIndex

This property holds the index of the current item in the combo box.

The default value is -1 when \l count is 0, and 0 otherwise.

See also
activated(), currentText, highlightedIndex

Definition at line 1230 of file qquickcombobox.cpp.

◆ currentIndexChanged

void QQuickComboBox::currentIndexChanged ( )
signal

◆ currentText()

QString QQuickComboBox::currentText ( ) const

\readonly \qmlproperty string QtQuick.Controls::ComboBox::currentText

This property holds the text of the current item in the combo box.

See also
currentIndex, displayText, textRole, editText

Definition at line 1251 of file qquickcombobox.cpp.

◆ currentTextChanged

void QQuickComboBox::currentTextChanged ( )
signal

◆ currentValue()

QVariant QQuickComboBox::currentValue ( ) const
Since
QtQuick.Controls 2.14 (Qt 5.14) \qmlproperty var QtQuick.Controls::ComboBox::currentValue

This property holds the value of the current item in the combo box. Setting this property will set \l currentIndex to the item with the corresponding value or -1 if it is not found. Setting both \l currentIndex and currentValue declaratively will result in undefined behavior. Setting this property with a value that is not unique is not supported.

For an example of how to use this property, see \l {ComboBox Model Roles}.

See also
currentIndex, currentText, valueRole

Definition at line 1821 of file qquickcombobox.cpp.

◆ decrementCurrentIndex

void QQuickComboBox::decrementCurrentIndex ( )
slot

\qmlmethod void QtQuick.Controls::ComboBox::decrementCurrentIndex()

Decrements the current index of the combo box, or the highlighted index if the popup list is visible.

See also
currentIndex, highlightedIndex

Definition at line 2050 of file qquickcombobox.cpp.

◆ defaultFont()

QFont QQuickComboBox::defaultFont ( ) const
overrideprotectedvirtual

Reimplemented from QQuickControl.

Definition at line 2373 of file qquickcombobox.cpp.

◆ delegate()

QQmlComponent * QQuickComboBox::delegate ( ) const

\qmlproperty Component QtQuick.Controls::ComboBox::delegate

This property holds a delegate that presents an item in the combo box popup.

It is recommended to use \l ItemDelegate (or any other \l AbstractButton derivatives) as the delegate. This ensures that the interaction works as expected, and the popup will automatically close when appropriate. When other types are used as the delegate, the popup must be closed manually. For example, if \l MouseArea is used:

// ...
MouseArea {
// ...
onClicked: comboBox.popup.close()
}
}
QQmlComponent * delegate

{no-ownership-since-6.11} {ComboBox}

See also
ItemDelegate, {Customizing ComboBox}

Definition at line 1387 of file qquickcombobox.cpp.

◆ delegateChanged

void QQuickComboBox::delegateChanged ( )
signal

◆ delegateModel()

QQmlInstanceModel * QQuickComboBox::delegateModel ( ) const

\readonly \qmlproperty model QtQuick.Controls::ComboBox::delegateModel

This property holds the model that provides delegate instances for the combo box.

It is typically assigned to a \l ListView in the \l {Popup::}{contentItem} of the \l popup.

See also
{Customizing ComboBox}

Definition at line 1166 of file qquickcombobox.cpp.

◆ delegateModelChanged

void QQuickComboBox::delegateModelChanged ( )
signal

◆ displayText()

QString QQuickComboBox::displayText ( ) const

\qmlproperty string QtQuick.Controls::ComboBox::displayText

This property holds the text that is displayed on the combo box button.

By default, the display text presents the current selection. That is, it follows the text of the current item. However, the default display text can be overridden with a custom value.

ComboBox {
model: ["S", "M", "L"]
}
See also
currentText, textRole

Definition at line 1276 of file qquickcombobox.cpp.

◆ displayTextChanged

void QQuickComboBox::displayTextChanged ( )
signal

◆ editText()

QString QQuickComboBox::editText ( ) const
Since
QtQuick.Controls 2.2 (Qt 5.9) \qmlproperty string QtQuick.Controls::ComboBox::editText

This property holds the text in the text field of an editable combo box.

See also
editable, currentText, displayText

Definition at line 1632 of file qquickcombobox.cpp.

◆ event()

bool QQuickComboBox::event ( QEvent * e)
overrideprotectedvirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
public:
MyClass(QWidget *parent = nullptr);
~MyClass();
bool event(QEvent* ev) override
{
if (ev->type() == QEvent::PolishRequest) {
// overwrite handling of PolishRequest if any
return true;
} else if (ev->type() == QEvent::Show) {
// complement handling of Show if any
return true;
}
// Make sure the rest of events are handled
return QWidget::event(ev);
}
};
See also
installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 2287 of file qquickcombobox.cpp.

◆ eventFilter()

bool QQuickComboBox::eventFilter ( QObject * watched,
QEvent * event )
overrideprotectedvirtual

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

class MainWindow : public QMainWindow
{
public:
protected:
bool eventFilter(QObject *obj, QEvent *ev) override;
private:
QTextEdit *textEdit;
};
{
textEdit = new QTextEdit;
setCentralWidget(textEdit);
textEdit->installEventFilter(this);
}
{
if (obj == textEdit) {
if (event->type() == QEvent::KeyPress) {
QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
qDebug() << "Ate key press" << keyEvent->key();
return true;
} else {
return false;
}
} else {
// pass the event on to the parent class
}
}

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Some events, such as \l QEvent::ShortcutOverride must be explicitly accepted (by calling \l {QEvent::}{accept()} on them) in order to prevent propagation.

Warning
If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.
See also
installEventFilter()

Reimplemented from QObject.

Definition at line 2073 of file qquickcombobox.cpp.

◆ find()

int QQuickComboBox::find ( const QString & text,
Qt::MatchFlags flags = Qt::MatchExactly ) const

\qmlmethod int QtQuick.Controls::ComboBox::find(string text, enumeration flags)

Returns the index of the specified text, or -1 if no match is found.

The way the search is performed is defined by the specified match flags. By default, combo box performs case sensitive exact matching (Qt.MatchExactly). All other match types are case-insensitive unless the Qt.MatchCaseSensitive flag is also specified.

\value Qt.MatchExactly The search term matches exactly (default). \value Qt.MatchRegularExpression The search term matches as a regular expression. \value Qt.MatchWildcard The search term matches using wildcards. \value Qt.MatchFixedString The search term matches as a fixed string. \value Qt.MatchStartsWith The search term matches the start of the item. \value Qt.MatchEndsWith The search term matches the end of the item. \value Qt.MatchContains The search term is contained in the item. \value Qt.MatchCaseSensitive The search is case sensitive.

functions-after-component-completion For example:

ComboBox {
model: ListModel {
ListElement { text: "Banana" }
ListElement { text: "Apple" }
ListElement { text: "Coconut" }
}
Component.onCompleted: currentIndex = find("Coconut")
}
See also
textRole

Definition at line 2022 of file qquickcombobox.cpp.

◆ focusInEvent()

void QQuickComboBox::focusInEvent ( QFocusEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive focus-in events for an item.

The event information is provided by the event parameter.

\input item.qdocinc accepting-events

If you do reimplement this function, you should call the base class implementation.

Reimplemented from QQuickItem.

Definition at line 2121 of file qquickcombobox.cpp.

◆ focusOutEvent()

void QQuickComboBox::focusOutEvent ( QFocusEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive focus-out events for an item.

The event information is provided by the event parameter.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 2133 of file qquickcombobox.cpp.

◆ fontChange()

void QQuickComboBox::fontChange ( const QFont & newFont,
const QFont & oldFont )
overrideprotectedvirtual

Reimplemented from QQuickControl.

Definition at line 2329 of file qquickcombobox.cpp.

◆ hasAcceptableInput()

bool QQuickComboBox::hasAcceptableInput ( ) const
Since
QtQuick.Controls 2.2 (Qt 5.9) \qmlproperty bool QtQuick.Controls::ComboBox::acceptableInput \readonly

This property holds whether the combo box contains acceptable text in the editable text field.

If a validator has been set, the value is true only if the current text is acceptable to the validator as a final string (not as an intermediate string).

See also
validator, accepted

Definition at line 1756 of file qquickcombobox.cpp.

◆ highlighted

void QQuickComboBox::highlighted ( int index)
signal

◆ highlightedIndex()

int QQuickComboBox::highlightedIndex ( ) const

\readonly \qmlproperty int QtQuick.Controls::ComboBox::highlightedIndex

This property holds the index of the highlighted item in the combo box popup list.

When a highlighted item is activated, the popup is closed, \l currentIndex is set to highlightedIndex, and the value of this property is reset to -1, as there is no longer a highlighted item.

See also
highlighted(), currentIndex

Definition at line 1215 of file qquickcombobox.cpp.

◆ highlightedIndexChanged

void QQuickComboBox::highlightedIndexChanged ( )
signal

◆ implicitContentWidthPolicy()

QQuickComboBox::ImplicitContentWidthPolicy QQuickComboBox::implicitContentWidthPolicy ( ) const
Since
QtQuick.Controls 6.0 (Qt 6.0) \qmlproperty enumeration QtQuick.Controls::ComboBox::implicitContentWidthPolicy

This property controls how the \l{Control::}{implicitContentWidth} of the ComboBox is calculated.

When the width of a ComboBox is not large enough to display text, that text is elided. Depending on which parts of the text are elided, this can make selecting an item difficult for the end user. An efficient way of ensuring that a ComboBox is wide enough to avoid text being elided is to set a width that is known to be large enough:

width: 300
implicitContentWidthPolicy: ComboBox.ContentItemImplicitWidth
ImplicitContentWidthPolicy implicitContentWidthPolicy
qreal width
This property holds the width of this item.
Definition qquickitem.h:76

However, it is often not possible to know whether or not a hard-coded value will be large enough, as the size of text depends on many factors, such as font family, font size, translations, and so on.

implicitContentWidthPolicy provides an easy way to control how the implicitContentWidth is calculated, which in turn affects the \l{Item::}{implicitWidth} of the ComboBox and ensures that text will not be elided.

The available values are:

\value ContentItemImplicitWidth The implicitContentWidth will default to that of the \l{Control::}{contentItem}. This is the most efficient option, as no extra text layout is done. \value WidestText The implicitContentWidth will be set to the implicit width of the the largest text for the given \l textRole every time the model changes. This option should be used with smaller models, as it can be expensive. \value WidestTextWhenCompleted The implicitContentWidth will be set to the implicit width of the the largest text for the given \l textRole once after \l {QQmlParserStatus::componentComplete()}{component completion}. This option should be used with smaller models, as it can be expensive.

The default value is ContentItemImplicitWidth.

As this property only affects the implicitWidth of the ComboBox, setting an explicit \l{Item::}{width} can still result in eliding.

Note
This feature requires the contentItem to be a type derived from \l TextInput.
This feature requires text to be laid out, and can therefore be expensive for large models or models whose contents are updated frequently.

Definition at line 1961 of file qquickcombobox.cpp.

◆ implicitIndicatorHeight()

qreal QQuickComboBox::implicitIndicatorHeight ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::ComboBox::implicitIndicatorHeight \readonly

This property holds the implicit indicator height.

The value is equal to {indicator ? indicator.implicitHeight : 0}.

This is typically used, together with \l {Control::}{implicitContentHeight} and \l {Control::}{implicitBackgroundHeight}, to calculate the \l {Item::}{implicitHeight}.

See also
implicitIndicatorWidth

Definition at line 1798 of file qquickcombobox.cpp.

◆ implicitIndicatorWidth()

qreal QQuickComboBox::implicitIndicatorWidth ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::ComboBox::implicitIndicatorWidth \readonly

This property holds the implicit indicator width.

The value is equal to {indicator ? indicator.implicitWidth : 0}.

This is typically used, together with \l {Control::}{implicitContentWidth} and \l {Control::}{implicitBackgroundWidth}, to calculate the \l {Item::}{implicitWidth}.

See also
implicitIndicatorHeight

Definition at line 1776 of file qquickcombobox.cpp.

◆ incrementCurrentIndex

void QQuickComboBox::incrementCurrentIndex ( )
slot

\qmlmethod void QtQuick.Controls::ComboBox::incrementCurrentIndex()

Increments the current index of the combo box, or the highlighted index if the popup list is visible.

See also
currentIndex, highlightedIndex

Definition at line 2036 of file qquickcombobox.cpp.

◆ indicator()

QQuickItem * QQuickComboBox::indicator ( ) const

\qmlproperty Item QtQuick.Controls::ComboBox::indicator

This property holds the drop indicator item.

See also
{Customizing ComboBox}

Definition at line 1413 of file qquickcombobox.cpp.

◆ indicatorChanged

void QQuickComboBox::indicatorChanged ( )
signal

◆ inputMethodHints()

Qt::InputMethodHints QQuickComboBox::inputMethodHints ( ) const
Since
QtQuick.Controls 2.2 (Qt 5.9) \qmlproperty flags QtQuick.Controls::ComboBox::inputMethodHints

Provides hints to the input method about the expected content of the combo box and how it should operate.

The default value is Qt.ImhNoPredictiveText.

Definition at line 1715 of file qquickcombobox.cpp.

◆ isDown()

bool QQuickComboBox::isDown ( ) const
Since
QtQuick.Controls 2.2 (Qt 5.9) \qmlproperty bool QtQuick.Controls::ComboBox::down

This property holds whether the combo box button is visually down.

Unless explicitly set, this property is true when either pressed or popup.visible is true. To return to the default value, set this property to undefined.

See also
pressed, popup

Definition at line 1547 of file qquickcombobox.cpp.

◆ isEditable()

bool QQuickComboBox::isEditable ( ) const
Since
QtQuick.Controls 2.2 (Qt 5.9) \qmlproperty bool QtQuick.Controls::ComboBox::editable

This property holds whether the combo box is editable.

The default value is false.

See also
validator

Definition at line 1585 of file qquickcombobox.cpp.

◆ isFlat()

bool QQuickComboBox::isFlat ( ) const
Since
QtQuick.Controls 2.1 (Qt 5.8) \qmlproperty bool QtQuick.Controls::ComboBox::flat

This property holds whether the combo box button is flat.

A flat combo box button does not draw a background unless it is interacted with. In comparison to normal combo boxes, flat combo boxes provide looks that make them stand out less from the rest of the UI. For instance, when placing a combo box into a tool bar, it may be desirable to make the combo box flat so it matches better with the flat looks of tool buttons.

The default value is false.

Definition at line 1519 of file qquickcombobox.cpp.

◆ isInputMethodComposing()

bool QQuickComboBox::isInputMethodComposing ( ) const
Since
QtQuick.Controls 2.2 (Qt 5.9) \qmlproperty bool QtQuick.Controls::ComboBox::inputMethodComposing \readonly

This property holds whether an editable combo box has partial text input from an input method.

While it is composing, an input method may rely on mouse or key events from the combo box to edit or commit the partial text. This property can be used to determine when to disable event handlers that may interfere with the correct operation of an input method.

Definition at line 1738 of file qquickcombobox.cpp.

◆ isPressed()

bool QQuickComboBox::isPressed ( ) const

\readonly \qmlproperty bool QtQuick.Controls::ComboBox::pressed

This property holds whether the combo box button is physically pressed. A button can be pressed by either touch or key events.

See also
down

Definition at line 1182 of file qquickcombobox.cpp.

◆ itemChange()

void QQuickComboBox::itemChange ( QQuickItem::ItemChange change,
const ItemChangeData & value )
overrideprotectedvirtual

Called when change occurs for this item.

value contains extra information relating to the change, when applicable.

If you re-implement this method in a subclass, be sure to call

virtual void itemChange(ItemChange, const ItemChangeData &)
Called when change occurs for this item.
EGLOutputLayerEXT EGLint EGLAttrib value
[3]

typically at the end of your implementation, to ensure the \l windowChanged() signal will be emitted.

Reimplemented from QQuickItem.

Definition at line 2319 of file qquickcombobox.cpp.

◆ keyPressEvent()

void QQuickComboBox::keyPressEvent ( QKeyEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive key press events for an item.

The event information is provided by the event parameter.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 2161 of file qquickcombobox.cpp.

◆ keyReleaseEvent()

void QQuickComboBox::keyReleaseEvent ( QKeyEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive key release events for an item.

The event information is provided by the event parameter.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 2229 of file qquickcombobox.cpp.

◆ localeChange()

void QQuickComboBox::localeChange ( const QLocale & newLocale,
const QLocale & oldLocale )
overrideprotectedvirtual

Reimplemented from QQuickControl.

Definition at line 2364 of file qquickcombobox.cpp.

◆ model()

QVariant QQuickComboBox::model ( ) const

\qmlproperty model QtQuick.Controls::ComboBox::model

This property holds the model providing data for the combo box.

ComboBox {
textRole: "key"
ListElement { key: "First"; value: 123 }
ListElement { key: "Second"; value: 456 }
ListElement { key: "Third"; value: 789 }
}
}
GLuint64 key
See also
textRole, {qml-data-models}{Data Models}

Definition at line 1099 of file qquickcombobox.cpp.

◆ modelChanged

void QQuickComboBox::modelChanged ( )
signal

◆ popup()

QQuickPopup * QQuickComboBox::popup ( ) const

\qmlproperty Popup QtQuick.Controls::ComboBox::popup

This property holds the popup.

The popup can be opened or closed manually, if necessary:

onSpecialEvent: comboBox.popup.close()
See also
{Customizing ComboBox}

Definition at line 1465 of file qquickcombobox.cpp.

◆ popupChanged

void QQuickComboBox::popupChanged ( )
signal

◆ pressedChanged

void QQuickComboBox::pressedChanged ( )
signal

◆ Q_REVISION [1/18]

QQuickComboBox::Q_REVISION ( 2 ,
1  )
signal

◆ Q_REVISION() [2/18]

QQuickComboBox::Q_REVISION ( 2 ,
14  ) const &

◆ Q_REVISION() [3/18]

QQuickComboBox::Q_REVISION ( 2 ,
14  ) const

◆ Q_REVISION [4/18]

QQuickComboBox::Q_REVISION ( 2 ,
14  )
signal

◆ Q_REVISION [5/18]

QQuickComboBox::Q_REVISION ( 2 ,
14  )
signal

◆ Q_REVISION [6/18]

QQuickComboBox::Q_REVISION ( 2 ,
15  )
signal

◆ Q_REVISION [7/18]

QQuickComboBox::Q_REVISION ( 2 ,
2  )
signal

◆ Q_REVISION [8/18]

QQuickComboBox::Q_REVISION ( 2 ,
2  )
signal

◆ Q_REVISION [9/18]

QQuickComboBox::Q_REVISION ( 2 ,
2  )
signal

◆ Q_REVISION [10/18]

QQuickComboBox::Q_REVISION ( 2 ,
2  )
signal

◆ Q_REVISION [11/18]

QQuickComboBox::Q_REVISION ( 2 ,
2  )
signal

◆ Q_REVISION [12/18]

QQuickComboBox::Q_REVISION ( 2 ,
2  )
signal

◆ Q_REVISION [13/18]

QQuickComboBox::Q_REVISION ( 2 ,
2  )
signal

◆ Q_REVISION [14/18]

QQuickComboBox::Q_REVISION ( 2 ,
2  )
slot

◆ Q_REVISION [15/18]

QQuickComboBox::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [16/18]

QQuickComboBox::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [17/18]

QQuickComboBox::Q_REVISION ( 6 ,
0  )
signal

◆ Q_REVISION() [18/18]

QQuickComboBox::Q_REVISION ( 6 ,
10  ) const &

◆ resetDisplayText()

void QQuickComboBox::resetDisplayText ( )

Definition at line 1294 of file qquickcombobox.cpp.

◆ resetDown()

void QQuickComboBox::resetDown ( )

Definition at line 1565 of file qquickcombobox.cpp.

◆ resetEditText()

void QQuickComboBox::resetEditText ( )

Definition at line 1648 of file qquickcombobox.cpp.

◆ selectTextByMouse()

bool QQuickComboBox::selectTextByMouse ( ) const
Since
QtQuick.Controls 2.15 (Qt 5.15) \qmlproperty bool QtQuick.Controls::ComboBox::selectTextByMouse

This property holds whether the text field for an editable ComboBox can be selected with the mouse.

The default value is false.

Definition at line 1891 of file qquickcombobox.cpp.

◆ setCurrentIndex()

void QQuickComboBox::setCurrentIndex ( int index)

Definition at line 1236 of file qquickcombobox.cpp.

◆ setDelegate()

void QQuickComboBox::setDelegate ( QQmlComponent * delegate)

Definition at line 1393 of file qquickcombobox.cpp.

◆ setDisplayText()

void QQuickComboBox::setDisplayText ( const QString & text)

Definition at line 1282 of file qquickcombobox.cpp.

◆ setDown()

void QQuickComboBox::setDown ( bool down)

Definition at line 1553 of file qquickcombobox.cpp.

◆ setEditable()

void QQuickComboBox::setEditable ( bool editable)

Definition at line 1591 of file qquickcombobox.cpp.

◆ setEditText()

void QQuickComboBox::setEditText ( const QString & text)

Definition at line 1638 of file qquickcombobox.cpp.

◆ setFlat()

void QQuickComboBox::setFlat ( bool flat)

Definition at line 1525 of file qquickcombobox.cpp.

◆ setImplicitContentWidthPolicy()

void QQuickComboBox::setImplicitContentWidthPolicy ( QQuickComboBox::ImplicitContentWidthPolicy policy)

Definition at line 1967 of file qquickcombobox.cpp.

◆ setIndicator()

void QQuickComboBox::setIndicator ( QQuickItem * indicator)

Definition at line 1421 of file qquickcombobox.cpp.

◆ setInputMethodHints()

void QQuickComboBox::setInputMethodHints ( Qt::InputMethodHints hints)

Definition at line 1721 of file qquickcombobox.cpp.

◆ setModel()

void QQuickComboBox::setModel ( const QVariant & model)

Definition at line 1111 of file qquickcombobox.cpp.

◆ setPopup()

void QQuickComboBox::setPopup ( QQuickPopup * popup)

Definition at line 1473 of file qquickcombobox.cpp.

◆ setPressed()

void QQuickComboBox::setPressed ( bool pressed)

Definition at line 1188 of file qquickcombobox.cpp.

◆ setSelectTextByMouse()

void QQuickComboBox::setSelectTextByMouse ( bool canSelect)

Definition at line 1897 of file qquickcombobox.cpp.

◆ setTextRole()

void QQuickComboBox::setTextRole ( const QString & role)

Definition at line 1321 of file qquickcombobox.cpp.

◆ setValueRole()

void QQuickComboBox::setValueRole ( const QString & role)

Definition at line 1350 of file qquickcombobox.cpp.

◆ textAt()

QString QQuickComboBox::textAt ( int index) const

\qmlmethod string QtQuick.Controls::ComboBox::textAt(int index)

Returns the text for the specified index, or an empty string if the index is out of bounds.

functions-after-component-completion For example:

ComboBox {
model: ListModel {
ListElement { text: "Banana" }
ListElement { text: "Apple" }
ListElement { text: "Coconut" }
}
onActivated: (index) => { print(textAt(index)) }
}
See also
textRole

Definition at line 1989 of file qquickcombobox.cpp.

◆ textRole()

QString QQuickComboBox::textRole ( ) const

\qmlproperty string QtQuick.Controls::ComboBox::textRole

This property holds the model role used for populating the combo box.

When the model has multiple roles, textRole can be set to determine which role should be displayed.

See also
model, currentText, displayText, {ComboBox Model Roles}

Definition at line 1315 of file qquickcombobox.cpp.

◆ textRoleChanged

void QQuickComboBox::textRoleChanged ( )
signal

◆ valueRole()

QString QQuickComboBox::valueRole ( ) const
Since
QtQuick.Controls 2.14 (Qt 5.14) \qmlproperty string QtQuick.Controls::ComboBox::valueRole

This property holds the model role used for storing the value associated with each item in the model.

For an example of how to use this property, see \l {ComboBox Model Roles}.

See also
model, currentValue

Definition at line 1344 of file qquickcombobox.cpp.

Property Documentation

◆ acceptableInput

bool QQuickComboBox::acceptableInput
read

Definition at line 61 of file qquickcombobox_p.h.

◆ count

int QQuickComboBox::count
read

Definition at line 38 of file qquickcombobox_p.h.

◆ currentIndex

int QQuickComboBox::currentIndex
readwrite

Definition at line 43 of file qquickcombobox_p.h.

◆ currentText

QString QQuickComboBox::currentText
read

Definition at line 44 of file qquickcombobox_p.h.

◆ currentValue

QVariant QQuickComboBox::currentValue
readwrite

Definition at line 67 of file qquickcombobox_p.h.

◆ delegate

QQmlComponent * QQuickComboBox::delegate
readwrite

Definition at line 47 of file qquickcombobox_p.h.

◆ delegateModel

QQmlInstanceModel * QQuickComboBox::delegateModel
read

Definition at line 40 of file qquickcombobox_p.h.

◆ displayText

QString QQuickComboBox::displayText
readwrite

Definition at line 45 of file qquickcombobox_p.h.

◆ down

bool QQuickComboBox::down
readwrite

Definition at line 53 of file qquickcombobox_p.h.

◆ editable

bool QQuickComboBox::editable
readwrite

Definition at line 54 of file qquickcombobox_p.h.

◆ editText

QString QQuickComboBox::editText
readwrite

Definition at line 55 of file qquickcombobox_p.h.

◆ flat

bool QQuickComboBox::flat
readwrite

Definition at line 51 of file qquickcombobox_p.h.

◆ highlightedIndex

int QQuickComboBox::highlightedIndex
read

Definition at line 42 of file qquickcombobox_p.h.

◆ implicitContentWidthPolicy

ImplicitContentWidthPolicy QQuickComboBox::implicitContentWidthPolicy
readwrite

Definition at line 72 of file qquickcombobox_p.h.

◆ implicitIndicatorHeight

qreal QQuickComboBox::implicitIndicatorHeight
read

Definition at line 64 of file qquickcombobox_p.h.

◆ implicitIndicatorWidth

qreal QQuickComboBox::implicitIndicatorWidth
read

Definition at line 63 of file qquickcombobox_p.h.

◆ indicator

QQuickItem * QQuickComboBox::indicator
readwrite

Definition at line 48 of file qquickcombobox_p.h.

◆ inputMethodComposing

bool QQuickComboBox::inputMethodComposing
read

Definition at line 60 of file qquickcombobox_p.h.

◆ inputMethodHints

Qt::InputMethodHints QQuickComboBox::inputMethodHints
readwrite

Definition at line 59 of file qquickcombobox_p.h.

◆ model

QVariant QQuickComboBox::model
readwrite

Definition at line 39 of file qquickcombobox_p.h.

◆ popup

QQuickPopup * QQuickComboBox::popup
readwrite

Definition at line 49 of file qquickcombobox_p.h.

◆ pressed

bool QQuickComboBox::pressed
read

Definition at line 41 of file qquickcombobox_p.h.

◆ selectTextByMouse

bool QQuickComboBox::selectTextByMouse
readwrite

Definition at line 70 of file qquickcombobox_p.h.

◆ textRole

QString QQuickComboBox::textRole
readwrite

Definition at line 46 of file qquickcombobox_p.h.

◆ valueRole

QString QQuickComboBox::valueRole
readwrite

Definition at line 68 of file qquickcombobox_p.h.


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