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

#include <qquicksearchfield_p.h>

Inheritance diagram for QQuickSearchField:
Collaboration diagram for QQuickSearchField:

Signals

void activated (int index)
void highlighted (int index)
void accepted ()
void searchTriggered ()
void textEdited ()
void suggestionModelChanged ()
void delegateModelChanged ()
void suggestionCountChanged ()
void currentIndexChanged ()
void highlightedIndexChanged ()
void textChanged ()
void textRoleChanged ()
void liveChanged ()
void popupChanged ()
void delegateChanged ()
void searchButtonPressed ()
void clearButtonPressed ()
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

 QQuickSearchField (QQuickItem *parent=nullptr)
 ~QQuickSearchField ()
QVariant suggestionModel () const
 \qmlproperty model QtQuick.Controls::SearchField::suggestionModel
void setSuggestionModel (const QVariant &model)
QQmlInstanceModeldelegateModel () const
 \readonly \qmlproperty model QtQuick.Controls::SearchField::delegateModel
int suggestionCount () const
 \readonly \qmlproperty int QtQuick.Controls::SearchField::suggestionCount
int currentIndex () const
 \qmlproperty int QtQuick.Controls::SearchField::currentIndex
void setCurrentIndex (int index)
int highlightedIndex () const
 \readonly \qmlproperty int QtQuick.Controls::SearchField::highlightedIndex
QString text () const
 \qmlproperty string QtQuick.Controls::SearchField::text
void setText (const QString &text)
QString textRole () const
 \qmlproperty string QtQuick.Controls::SearchField::textRole
void setTextRole (const QString &textRole)
bool isLive () const
 \qmlproperty bool QtQuick.Controls::SearchField::live
void setLive (const bool live)
QQuickIndicatorButtonsearchIndicator () const
 \qmlproperty real QtQuick.Controls::SearchField::searchIndicator \readonly
QQuickIndicatorButtonclearIndicator () const
 \qmlproperty real QtQuick.Controls::SearchField::clearIndicator \readonly
QQuickPopuppopup () const
 \qmlproperty Popup QtQuick.Controls::SearchField::popup
void setPopup (QQuickPopup *popup)
QQmlComponentdelegate () const
 \qmlproperty Component QtQuick.Controls::SearchField::delegate
void setDelegate (QQmlComponent *delegate)
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 hoverEnterEvent (QHoverEvent *event) override
 This event handler can be reimplemented in a subclass to receive hover-enter events for an item.
void hoverMoveEvent (QHoverEvent *event) override
 This event handler can be reimplemented in a subclass to receive hover-move events for an item.
void hoverLeaveEvent (QHoverEvent *event) override
 This event handler can be reimplemented in a subclass to receive hover-leave 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 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 contentItemChange (QQuickItem *newItem, QQuickItem *oldItem) override
void itemChange (QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &data) override
 Called when change occurs for this item.
Protected Member Functions inherited from QQuickControl
virtual QFont defaultFont () const
 QQuickControl (QQuickControlPrivate &dd, QQuickItem *parent)
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 fontChange (const QFont &newFont, const QFont &oldFont)
virtual void mirrorChange ()
virtual void spacingChange (qreal newSpacing, qreal oldSpacing)
virtual void paddingChange (const QMarginsF &newPadding, const QMarginsF &oldPadding)
virtual void localeChange (const QLocale &newLocale, const QLocale &oldLocale)
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)
virtual void keyReleaseEvent (QKeyEvent *event)
 This event handler can be reimplemented in a subclass to receive key release events for an item.
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 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

QVariant suggestionModel
QQmlInstanceModeldelegateModel
int suggestionCount
int currentIndex
int highlightedIndex
QString text
QString textRole
bool live
QQuickIndicatorButtonsearchIndicator
QQuickIndicatorButtonclearIndicator
QQuickPopuppopup
QQmlComponentdelegate
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

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 inherited from QQuickItem
void update ()
 Schedules a call to updatePaintNode() for this item.
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
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 30 of file qquicksearchfield_p.h.

Constructor & Destructor Documentation

◆ QQuickSearchField()

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

Definition at line 661 of file qquicksearchfield.cpp.

◆ ~QQuickSearchField()

QQuickSearchField::~QQuickSearchField ( )

Definition at line 678 of file qquicksearchfield.cpp.

Member Function Documentation

◆ accepted

void QQuickSearchField::accepted ( )
signal

◆ activated

void QQuickSearchField::activated ( int index)
signal

◆ classBegin()

void QQuickSearchField::classBegin ( )
overrideprotectedvirtual

Invoked after class creation, but before any properties have been set.

Reimplemented from QQuickControl.

Definition at line 1137 of file qquicksearchfield.cpp.

◆ clearButtonPressed

void QQuickSearchField::clearButtonPressed ( )
signal

◆ clearIndicator()

QQuickIndicatorButton * QQuickSearchField::clearIndicator ( ) const

\qmlproperty real QtQuick.Controls::SearchField::clearIndicator \readonly

This property holds the clear indicator.

Definition at line 900 of file qquicksearchfield.cpp.

◆ componentComplete()

void QQuickSearchField::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.

Reimplemented from QQuickControl.

Definition at line 1149 of file qquicksearchfield.cpp.

◆ contentItemChange()

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

Reimplemented from QQuickControl.

Definition at line 1163 of file qquicksearchfield.cpp.

◆ currentIndex()

int QQuickSearchField::currentIndex ( ) const

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

This property holds the index of the currently selected suggestion in the popup list.

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

See also
activated(), text, highlightedIndex

Definition at line 771 of file qquicksearchfield.cpp.

◆ currentIndexChanged

void QQuickSearchField::currentIndexChanged ( )
signal

◆ delegate()

QQmlComponent * QQuickSearchField::delegate ( ) const

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

This property holds a delegate that presents an item in the search field 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: searchField.popup.close()
}
}
QQmlComponent * delegate

{no-ownership-since-6.11} {SearchField}

Definition at line 987 of file qquicksearchfield.cpp.

◆ delegateChanged

void QQuickSearchField::delegateChanged ( )
signal

◆ delegateModel()

QQmlInstanceModel * QQuickSearchField::delegateModel ( ) const

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

This property holds the model that provides delegate instances for the search field.

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

Definition at line 744 of file qquicksearchfield.cpp.

◆ delegateModelChanged

void QQuickSearchField::delegateModelChanged ( )
signal

◆ eventFilter()

bool QQuickSearchField::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 1006 of file qquicksearchfield.cpp.

◆ focusInEvent()

void QQuickSearchField::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 QQuickControl.

Definition at line 1033 of file qquicksearchfield.cpp.

◆ focusOutEvent()

void QQuickSearchField::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 QQuickControl.

Definition at line 1044 of file qquicksearchfield.cpp.

◆ highlighted

void QQuickSearchField::highlighted ( int index)
signal

◆ highlightedIndex()

int QQuickSearchField::highlightedIndex ( ) const

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

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

When the highlighted item is activated, the popup closes, \l currentIndex is updated to match highlightedIndex, and this property is reset to -1, indicating that no item is currently highlighted.

See also
highlighted(), currentIndex

Definition at line 797 of file qquicksearchfield.cpp.

◆ highlightedIndexChanged

void QQuickSearchField::highlightedIndexChanged ( )
signal

◆ hoverEnterEvent()

void QQuickSearchField::hoverEnterEvent ( QHoverEvent * event)
overrideprotectedvirtual

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

The event information is provided by the event parameter.

Hover events are only provided if acceptHoverEvents() is true.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 1056 of file qquicksearchfield.cpp.

◆ hoverLeaveEvent()

void QQuickSearchField::hoverLeaveEvent ( QHoverEvent * event)
overrideprotectedvirtual

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

The event information is provided by the event parameter.

Hover events are only provided if acceptHoverEvents() is true.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 1078 of file qquicksearchfield.cpp.

◆ hoverMoveEvent()

void QQuickSearchField::hoverMoveEvent ( QHoverEvent * event)
overrideprotectedvirtual

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

The event information is provided by the event parameter.

Hover events are only provided if acceptHoverEvents() is true.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 1067 of file qquicksearchfield.cpp.

◆ isLive()

bool QQuickSearchField::isLive ( ) const

\qmlproperty bool QtQuick.Controls::SearchField::live

This property holds a boolean value that determines whether the search is triggered on every text edit.

When set to true, the \l searchTriggered() signal is emitted on each text change, allowing you to respond to every keystroke. When set to false, the \l searchTriggered() is only emitted when the user presses the Enter or Return key.

See also
searchTriggered()

Definition at line 866 of file qquicksearchfield.cpp.

◆ itemChange()

void QQuickSearchField::itemChange ( QQuickItem::ItemChange change,
const QQuickItem::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 QQuickControl.

Definition at line 1186 of file qquicksearchfield.cpp.

◆ keyPressEvent()

void QQuickSearchField::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 1087 of file qquicksearchfield.cpp.

◆ liveChanged

void QQuickSearchField::liveChanged ( )
signal

◆ popup()

QQuickPopup * QQuickSearchField::popup ( ) const

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

This property holds the popup.

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

onSpecialEvent: searchField.popup.close()

Definition at line 918 of file qquicksearchfield.cpp.

◆ popupChanged

void QQuickSearchField::popupChanged ( )
signal

◆ searchButtonPressed

void QQuickSearchField::searchButtonPressed ( )
signal

◆ searchIndicator()

QQuickIndicatorButton * QQuickSearchField::searchIndicator ( ) const

\qmlproperty real QtQuick.Controls::SearchField::searchIndicator \readonly

This property holds the search indicator.

Definition at line 888 of file qquicksearchfield.cpp.

◆ searchTriggered

void QQuickSearchField::searchTriggered ( )
signal

◆ setCurrentIndex()

void QQuickSearchField::setCurrentIndex ( int index)

Definition at line 777 of file qquicksearchfield.cpp.

◆ setDelegate()

void QQuickSearchField::setDelegate ( QQmlComponent * delegate)

Definition at line 993 of file qquicksearchfield.cpp.

◆ setLive()

void QQuickSearchField::setLive ( const bool live)

Definition at line 872 of file qquicksearchfield.cpp.

◆ setPopup()

void QQuickSearchField::setPopup ( QQuickPopup * popup)

Definition at line 926 of file qquicksearchfield.cpp.

◆ setSuggestionModel()

void QQuickSearchField::setSuggestionModel ( const QVariant & model)

Definition at line 717 of file qquicksearchfield.cpp.

◆ setText()

void QQuickSearchField::setText ( const QString & text)

Definition at line 818 of file qquicksearchfield.cpp.

◆ setTextRole()

void QQuickSearchField::setTextRole ( const QString & textRole)

Definition at line 843 of file qquicksearchfield.cpp.

◆ suggestionCount()

int QQuickSearchField::suggestionCount ( ) const

\readonly \qmlproperty int QtQuick.Controls::SearchField::suggestionCount

This property holds the number of suggestions to display from the suggestion model.

Definition at line 756 of file qquicksearchfield.cpp.

◆ suggestionCountChanged

void QQuickSearchField::suggestionCountChanged ( )
signal

◆ suggestionModel()

QVariant QQuickSearchField::suggestionModel ( ) const

\qmlproperty model QtQuick.Controls::SearchField::suggestionModel

This property holds the data model used to display search suggestions in the popup menu.

SearchField {
textRole: "age"
ListElement { name: "Karen"; age: "66" }
ListElement { name: "Jim"; age: "32" }
ListElement { name: "Pamela"; age: "28" }
}
}
EGLImageKHR EGLint * name
See also
textRole

Definition at line 711 of file qquicksearchfield.cpp.

◆ suggestionModelChanged

void QQuickSearchField::suggestionModelChanged ( )
signal

◆ text()

QString QQuickSearchField::text ( ) const

\qmlproperty string QtQuick.Controls::SearchField::text

This property holds the current input text in the search field.

Text is bound to the user input, triggering suggestion updates or search logic.

See also
searchTriggered(), textEdited()

Definition at line 812 of file qquicksearchfield.cpp.

◆ textChanged

void QQuickSearchField::textChanged ( )
signal

◆ textEdited

void QQuickSearchField::textEdited ( )
signal

◆ textRole()

QString QQuickSearchField::textRole ( ) const

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

This property holds the model role used to display items in the suggestion model shown in the popup list.

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

Definition at line 837 of file qquicksearchfield.cpp.

◆ textRoleChanged

void QQuickSearchField::textRoleChanged ( )
signal

Property Documentation

◆ clearIndicator

QQuickIndicatorButton * QQuickSearchField::clearIndicator
read

Definition at line 44 of file qquicksearchfield_p.h.

◆ currentIndex

int QQuickSearchField::currentIndex
readwrite

Definition at line 37 of file qquicksearchfield_p.h.

◆ delegate

QQmlComponent * QQuickSearchField::delegate
readwrite

Definition at line 46 of file qquicksearchfield_p.h.

◆ delegateModel

QQmlInstanceModel * QQuickSearchField::delegateModel
read

Definition at line 35 of file qquicksearchfield_p.h.

◆ highlightedIndex

int QQuickSearchField::highlightedIndex
read

Definition at line 39 of file qquicksearchfield_p.h.

◆ live

bool QQuickSearchField::live
readwrite

Definition at line 42 of file qquicksearchfield_p.h.

◆ popup

QQuickPopup * QQuickSearchField::popup
readwrite

Definition at line 45 of file qquicksearchfield_p.h.

◆ searchIndicator

QQuickIndicatorButton * QQuickSearchField::searchIndicator
read

Definition at line 43 of file qquicksearchfield_p.h.

◆ suggestionCount

int QQuickSearchField::suggestionCount
read

Definition at line 36 of file qquicksearchfield_p.h.

◆ suggestionModel

QVariant QQuickSearchField::suggestionModel
readwrite

Definition at line 33 of file qquicksearchfield_p.h.

◆ text

QString QQuickSearchField::text
readwrite

Definition at line 40 of file qquicksearchfield_p.h.

◆ textRole

QString QQuickSearchField::textRole
readwrite

Definition at line 41 of file qquicksearchfield_p.h.


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