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

#include <qquicktextfield_p.h>

+ Inheritance diagram for QQuickTextField:
+ Collaboration diagram for QQuickTextField:

Signals

void fontChanged ()
 
void implicitWidthChanged3 ()
 
void implicitHeightChanged3 ()
 
void backgroundChanged ()
 
void placeholderTextChanged ()
 
void focusReasonChanged ()
 
void pressAndHold (QQuickMouseEvent *event)
 
 Q_REVISION (2, 1) void pressed(QQuickMouseEvent *event)
 
 Q_REVISION (2, 1) void released(QQuickMouseEvent *event)
 
 Q_REVISION (2, 1) void hoveredChanged()
 
 Q_REVISION (2, 1) void hoverEnabledChanged()
 
 Q_REVISION (2, 5) void placeholderTextColorChanged()
 
 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 QQuickTextInput
void textChanged ()
 
void cursorPositionChanged ()
 
void cursorRectangleChanged ()
 
void selectionStartChanged ()
 
void selectionEndChanged ()
 
void selectedTextChanged ()
 
void accepted ()
 
void acceptableInputChanged ()
 
 Q_REVISION (2, 2) void editingFinished()
 
 Q_REVISION (2, 9) void textEdited()
 
void colorChanged ()
 
void selectionColorChanged ()
 
void selectedTextColorChanged ()
 
void fontChanged (const QFont &font)
 
void horizontalAlignmentChanged (QQuickTextInput::HAlignment alignment)
 
void verticalAlignmentChanged (QQuickTextInput::VAlignment alignment)
 
void wrapModeChanged ()
 
void readOnlyChanged (bool isReadOnly)
 
void cursorVisibleChanged (bool isCursorVisible)
 
void cursorDelegateChanged ()
 
void overwriteModeChanged (bool overwriteMode)
 
void maximumLengthChanged (int maximumLength)
 
void inputMaskChanged (const QString &inputMask)
 
void echoModeChanged (QQuickTextInput::EchoMode echoMode)
 
void passwordCharacterChanged ()
 
 Q_REVISION (2, 4) void passwordMaskDelayChanged(int delay)
 
void displayTextChanged ()
 
 Q_REVISION (2, 7) void preeditTextChanged()
 
void activeFocusOnPressChanged (bool activeFocusOnPress)
 
void autoScrollChanged (bool autoScroll)
 
void selectByMouseChanged (bool selectByMouse)
 
void mouseSelectionModeChanged (QQuickTextInput::SelectionMode mode)
 
void persistentSelectionChanged ()
 
void canPasteChanged ()
 
void canUndoChanged ()
 
void canRedoChanged ()
 
void inputMethodComposingChanged ()
 
void effectiveHorizontalAlignmentChanged ()
 
void contentSizeChanged ()
 
void inputMethodHintsChanged ()
 
void renderTypeChanged ()
 
 Q_REVISION (2, 6) void paddingChanged()
 
 Q_REVISION (2, 6) void topPaddingChanged()
 
 Q_REVISION (2, 6) void leftPaddingChanged()
 
 Q_REVISION (2, 6) void rightPaddingChanged()
 
 Q_REVISION (2, 6) void bottomPaddingChanged()
 
- 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

 QQuickTextField (QQuickItem *parent=nullptr)
 
 ~QQuickTextField ()
 
QFont font () const
 
void setFont (const QFont &font)
 
QQuickItembackground () const
 \qmlproperty Item QtQuick.Controls::TextField::background
 
void setBackground (QQuickItem *background)
 
QString placeholderText () const
 \qmlproperty string QtQuick.Controls::TextField::placeholderText
 
void setPlaceholderText (const QString &text)
 
Qt::FocusReason focusReason () const
 \qmlproperty enumeration QtQuick.Controls::TextField::focusReason
 
void setFocusReason (Qt::FocusReason reason)
 
bool isHovered () const
 
void setHovered (bool hovered)
 
bool isHoverEnabled () const
 
void setHoverEnabled (bool enabled)
 
void resetHoverEnabled ()
 
QColor placeholderTextColor () const
 \qmlproperty color QtQuick.Controls::TextField::placeholderTextColor
 
void setPlaceholderTextColor (const QColor &color)
 
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 QQuickTextInput
 QQuickTextInput (QQuickItem *parent=nullptr)
 \qmltype TextInput \nativetype QQuickTextInput \inqmlmodule QtQuick\inherits Item
 
 ~QQuickTextInput ()
 
void componentComplete () override
 \reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.
 
Q_INVOKABLE void positionAt (QQmlV4FunctionPtr args) const
 \qmlmethod int QtQuick::TextInput::positionAt(real x, real y, CursorPosition position)
 
Q_INVOKABLE QRectF positionToRectangle (int pos) const
 \qmlmethod rect QtQuick::TextInput::positionToRectangle(int pos)
 
Q_INVOKABLE void moveCursorSelection (int pos)
 
Q_INVOKABLE void moveCursorSelection (int pos, SelectionMode mode)
 \qmlmethod QtQuick::TextInput::moveCursorSelection(int position, SelectionMode mode)
 
RenderType renderType () const
 \qmlproperty enumeration QtQuick::TextInput::renderType
 
void setRenderType (RenderType renderType)
 
QString text () const
 \qmlproperty string QtQuick::TextInput::text
 
void setText (const QString &)
 
int length () const
 \qmlproperty int QtQuick::TextInput::length
 
QFont font () const
 \qmlproperty string QtQuick::TextInput::font.family
 
void setFont (const QFont &font)
 
QColor color () const
 \qmlproperty color QtQuick::TextInput::color
 
void setColor (const QColor &c)
 
QColor selectionColor () const
 \qmlproperty color QtQuick::TextInput::selectionColor
 
void setSelectionColor (const QColor &c)
 
QColor selectedTextColor () const
 \qmlproperty color QtQuick::TextInput::selectedTextColor
 
void setSelectedTextColor (const QColor &c)
 
HAlignment hAlign () const
 \qmlproperty enumeration QtQuick::TextInput::effectiveHorizontalAlignment \readonly
 
void setHAlign (HAlignment align)
 
void resetHAlign ()
 
HAlignment effectiveHAlign () const
 
VAlignment vAlign () const
 
void setVAlign (VAlignment align)
 
WrapMode wrapMode () const
 \qmlproperty enumeration QtQuick::TextInput::wrapMode
 
void setWrapMode (WrapMode w)
 
bool isReadOnly () const
 \qmlproperty bool QtQuick::TextInput::readOnly
 
void setReadOnly (bool)
 
bool isCursorVisible () const
 \qmlproperty bool QtQuick::TextInput::cursorVisible Set to true when the TextInput shows a cursor.
 
void setCursorVisible (bool on)
 
int cursorPosition () const
 \qmlproperty int QtQuick::TextInput::cursorPosition The position of the cursor in the TextInput.
 
void setCursorPosition (int cp)
 
QRectF cursorRectangle () const
 \qmlproperty rectangle QtQuick::TextInput::cursorRectangle \readonly
 
int selectionStart () const
 \qmlproperty int QtQuick::TextInput::selectionStart
 
int selectionEnd () const
 \qmlproperty int QtQuick::TextInput::selectionEnd
 
QString selectedText () const
 \qmlproperty string QtQuick::TextInput::selectedText \readonly
 
int maxLength () const
 \qmlproperty int QtQuick::TextInput::maximumLength The maximum permitted length of the text in the TextInput.
 
void setMaxLength (int ml)
 
QString inputMask () const
 \qmlproperty string QtQuick::TextInput::inputMask
 
void setInputMask (const QString &im)
 
EchoMode echoMode () const
 \qmlsignal QtQuick::TextInput::accepted()
 
void setEchoMode (EchoMode echo)
 
QString passwordCharacter () const
 \qmlproperty string QtQuick::TextInput::passwordCharacter
 
void setPasswordCharacter (const QString &str)
 
int passwordMaskDelay () const
 \qmlproperty int QtQuick::TextInput::passwordMaskDelay
 
void setPasswordMaskDelay (int delay)
 
void resetPasswordMaskDelay ()
 
QString displayText () const
 \qmlproperty string QtQuick::TextInput::displayText
 
 Q_REVISION (2, 7) QString preeditText() const
 
QQmlComponentcursorDelegate () const
 \qmlproperty Component QtQuick::TextInput::cursorDelegate The delegate for the cursor in the TextInput.
 
void setCursorDelegate (QQmlComponent *)
 
bool overwriteMode () const
 \qmlproperty bool QtQuick::TextInput::overwriteMode
 
void setOverwriteMode (bool overwrite)
 
bool focusOnPress () const
 \qmlproperty bool QtQuick::TextInput::activeFocusOnPress
 
void setFocusOnPress (bool)
 
bool autoScroll () const
 \qmlproperty bool QtQuick::TextInput::autoScroll
 
void setAutoScroll (bool)
 
bool selectByMouse () const
 \qmlproperty bool QtQuick::TextInput::selectByMouse
 
void setSelectByMouse (bool)
 
SelectionMode mouseSelectionMode () const
 \qmlproperty enumeration QtQuick::TextInput::mouseSelectionMode
 
void setMouseSelectionMode (SelectionMode mode)
 
bool persistentSelection () const
 \qmlproperty bool QtQuick::TextInput::persistentSelection
 
void setPersistentSelection (bool persist)
 
bool hasAcceptableInput () const
 \qmlproperty bool QtQuick::TextInput::acceptableInput \readonly
 
QRectF boundingRect () const override
 Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
 
QRectF clipRect () const override
 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().
 
bool canPaste () const
 \qmlproperty bool QtQuick::TextInput::canPaste \readonly
 
bool canUndo () const
 \qmlproperty bool QtQuick::TextInput::canUndo \readonly
 
bool canRedo () const
 \qmlproperty bool QtQuick::TextInput::canRedo \readonly
 
bool isInputMethodComposing () const
 \qmlproperty bool QtQuick::TextInput::inputMethodComposing \readonly
 
Qt::InputMethodHints inputMethodHints () const
 \qmlproperty enumeration QtQuick::TextInput::inputMethodHints
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
Q_INVOKABLE QString getText (int start, int end) const
 \qmlmethod string QtQuick::TextInput::getText(int start, int end)
 
qreal contentWidth () const
 \qmlproperty real QtQuick::TextInput::contentWidth \readonly
 
qreal contentHeight () const
 \qmlproperty real QtQuick::TextInput::contentHeight \readonly
 
qreal padding () const
 
void setPadding (qreal padding)
 
void resetPadding ()
 
qreal topPadding () const
 
void setTopPadding (qreal padding)
 
void resetTopPadding ()
 
qreal leftPadding () const
 
void setLeftPadding (qreal padding)
 
void resetLeftPadding ()
 
qreal rightPadding () const
 
void setRightPadding (qreal padding)
 
void resetRightPadding ()
 
qreal bottomPadding () const
 
void setBottomPadding (qreal padding)
 
void resetBottomPadding ()
 
void invalidate () override
 
- 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 the specified sibling item to the index before this item within the list of children.
 
void stackAfter (const QQuickItem *)
 Moves the specified sibling item to the index after this 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.
 
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 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.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 
- Public Member Functions inherited from QQuickTextInterface

Protected Member Functions

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.
 
void itemChange (ItemChange change, const ItemChangeData &value) override
 Called when change occurs for this item.
 
void geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override
 
virtual void insetChange (const QMarginsF &newInset, const QMarginsF &oldInset)
 
QSGNodeupdatePaintNode (QSGNode *oldNode, UpdatePaintNodeData *data) override
 Called on the render thread when it is time to sync the state of the item with the scene graph.
 
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 mouseDoubleClickEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse double-click events for an item.
 
void timerEvent (QTimerEvent *event) override
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
- Protected Member Functions inherited from QQuickTextInput
 QQuickTextInput (QQuickTextInputPrivate &dd, QQuickItem *parent=nullptr)
 
void geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override
 
void itemChange (ItemChange change, const ItemChangeData &value) override
 Called when change occurs for this 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 mouseDoubleClickEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse double-click events for an item.
 
void keyPressEvent (QKeyEvent *ev) override
 This event handler can be reimplemented in a subclass to receive key press 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.
 
bool event (QEvent *e) override
 \reimp
 
void focusOutEvent (QFocusEvent *event) override
 This event handler can be reimplemented in a subclass to receive focus-out events for an item.
 
void focusInEvent (QFocusEvent *event) override
 This event handler can be reimplemented in a subclass to receive focus-in events for an item.
 
void timerEvent (QTimerEvent *event) override
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
QSGNodeupdatePaintNode (QSGNode *oldNode, UpdatePaintNodeData *data) override
 Called on the render thread when it is time to sync the state of the item with the scene graph.
 
void updatePolish () override
 This function should perform any layout as required for this item.
 
- Protected Member Functions inherited from QQuickImplicitSizeItem
 QQuickImplicitSizeItem (QQuickImplicitSizeItemPrivate &dd, QQuickItem *parent)
 
- Protected Member Functions inherited from QQuickItem
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 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 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().
 
 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 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

QFont font
 
qreal implicitWidth
 
qreal implicitHeight
 
QQuickItembackground
 
QString placeholderText
 
Qt::FocusReason focusReason
 
bool hovered
 
bool hoverEnabled
 
QColor placeholderTextColor
 
qreal implicitBackgroundWidth
 
qreal implicitBackgroundHeight
 
qreal topInset
 
qreal leftInset
 
qreal rightInset
 
qreal bottomInset
 
- Properties inherited from QQuickTextInput
QString text
 
int length
 
QColor color
 
QColor selectionColor
 
QColor selectedTextColor
 
QFont font
 
HAlignment horizontalAlignment
 
HAlignment effectiveHorizontalAlignment
 
VAlignment verticalAlignment
 
WrapMode wrapMode
 
bool readOnly
 
bool cursorVisible
 
int cursorPosition
 
QRectF cursorRectangle
 
QQmlComponentcursorDelegate
 
bool overwriteMode
 
int selectionStart
 
int selectionEnd
 
QString selectedText
 
int maximumLength
 
QString inputMask
 
Qt::InputMethodHints inputMethodHints
 
bool acceptableInput
 
EchoMode echoMode
 
bool activeFocusOnPress
 
QString passwordCharacter
 
int passwordMaskDelay
 
QString displayText
 
QString preeditText
 \qmlproperty string QtQuick::TextInput::preeditText \readonly
 
bool autoScroll
 
bool selectByMouse
 
SelectionMode mouseSelectionMode
 
bool persistentSelection
 
bool canPaste
 
bool canUndo
 
bool canRedo
 
bool inputMethodComposing
 
qreal contentWidth
 
qreal contentHeight
 
RenderType renderType
 
qreal padding
 
qreal topPadding
 
qreal leftPadding
 
qreal rightPadding
 
qreal bottomPadding
 
- Properties inherited from QQuickImplicitSizeItem
qreal implicitWidth
 
qreal implicitHeight
 
- 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 This property holds the list of transformations to apply.
 
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
 

Friends

struct QQuickPressHandler
 

Additional Inherited Members

- Public Types inherited from QQuickTextInput
enum  EchoMode { Normal , NoEcho , Password , PasswordEchoOnEdit }
 
enum  HAlignment { AlignLeft = Qt::AlignLeft , AlignRight = Qt::AlignRight , AlignHCenter = Qt::AlignHCenter }
 
enum  VAlignment { AlignTop = Qt::AlignTop , AlignBottom = Qt::AlignBottom , AlignVCenter = Qt::AlignVCenter }
 
enum  WrapMode {
  NoWrap = QTextOption::NoWrap , WordWrap = QTextOption::WordWrap , WrapAnywhere = QTextOption::WrapAnywhere , WrapAtWordBoundaryOrAnywhere = QTextOption::WrapAtWordBoundaryOrAnywhere ,
  Wrap = QTextOption::WrapAtWordBoundaryOrAnywhere
}
 
enum  SelectionMode { SelectCharacters , SelectWords }
 
enum  CursorPosition { CursorBetweenCharacters , CursorOnCharacter }
 
enum  RenderType { QtRendering , NativeRendering , CurveRendering }
 
- 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 QQuickTextInput
void selectAll ()
 \qmlmethod QtQuick::TextInput::selectAll()
 
void selectWord ()
 \qmlmethod QtQuick::TextInput::selectWord()
 
void select (int start, int end)
 \qmlmethod QtQuick::TextInput::select(int start, int end)
 
void deselect ()
 \qmlmethod QtQuick::TextInput::deselect()
 
bool isRightToLeft (int start, int end)
 \qmlmethod QtQuick::TextInput::isRightToLeft(int start, int end)
 
void undo ()
 \qmlmethod QtQuick::TextInput::undo()
 
void redo ()
 \qmlmethod QtQuick::TextInput::redo()
 
void insert (int position, const QString &text)
 \qmlmethod QtQuick::TextInput::insert(int position, string text)
 
void remove (int start, int end)
 \qmlmethod QtQuick::TextInput::remove(int start, int end)
 
 Q_REVISION (2, 4) void ensureVisible(int position)
 
 Q_REVISION (2, 7) void clear()
 
- 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 27 of file qquicktextfield_p.h.

Constructor & Destructor Documentation

◆ QQuickTextField()

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

Definition at line 377 of file qquicktextfield.cpp.

◆ ~QQuickTextField()

QQuickTextField::~QQuickTextField ( )

Definition at line 396 of file qquicktextfield.cpp.

Member Function Documentation

◆ background()

QQuickItem * QQuickTextField::background ( ) const

\qmlproperty Item QtQuick.Controls::TextField::background

This property holds the background item.

\input qquickcontrol-background.qdocinc notes

See also
{Customizing TextField}

Definition at line 430 of file qquicktextfield.cpp.

◆ backgroundChanged

void QQuickTextField::backgroundChanged ( )
signal

◆ bottomInset()

qreal QQuickTextField::bottomInset ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::TextField::bottomInset

This property holds the bottom inset for the background.

See also
{Control Layout}, topInset

Definition at line 771 of file qquicktextfield.cpp.

◆ classBegin()

void QQuickTextField::classBegin ( )
overrideprotectedvirtual

\reimp Derived classes should call the base class method before adding their own action to perform at classBegin.

Reimplemented from QQuickItem.

Definition at line 640 of file qquicktextfield.cpp.

◆ componentComplete()

void QQuickTextField::componentComplete ( )
overrideprotectedvirtual

\reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.

Reimplemented from QQuickItem.

Definition at line 789 of file qquicktextfield.cpp.

◆ focusInEvent()

void QQuickTextField::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 857 of file qquicktextfield.cpp.

◆ focusOutEvent()

void QQuickTextField::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 862 of file qquicktextfield.cpp.

◆ focusReason()

Qt::FocusReason QQuickTextField::focusReason ( ) const

\qmlproperty enumeration QtQuick.Controls::TextField::focusReason

This property holds the reason of the last focus change.

Note
This property does not indicate whether the item has \l {Item::activeFocus} {active focus}, but the reason why the item either gained or lost focus.

\value Qt.MouseFocusReason A mouse action occurred. \value Qt.TabFocusReason The Tab key was pressed. \value Qt.BacktabFocusReason A Backtab occurred. The input for this may include the Shift or Control keys; e.g. Shift+Tab. \value Qt.ActiveWindowFocusReason The window system made this window either active or inactive. \value Qt.PopupFocusReason The application opened/closed a pop-up that grabbed/released the keyboard focus. \value Qt.ShortcutFocusReason The user typed a label's buddy shortcut \value Qt.MenuBarFocusReason The menu bar took focus. \value Qt.OtherFocusReason Another reason, usually application-specific.

Note
Prefer \l {QtQuick.Controls::Control::focusReason} to this property.

Definition at line 552 of file qquicktextfield.cpp.

◆ focusReasonChanged

void QQuickTextField::focusReasonChanged ( )
signal

◆ font()

QFont QQuickTextField::font ( ) const

Definition at line 402 of file qquicktextfield.cpp.

◆ fontChanged

void QQuickTextField::fontChanged ( )
signal

◆ geometryChange()

void QQuickTextField::geometryChange ( const QRectF & newGeometry,
const QRectF & oldGeometry )
overrideprotectedvirtual
Since
6.0

This function is called to handle this item's changes in geometry from oldGeometry to newGeometry. If the two geometries are the same, it doesn't do anything.

Derived classes must call the base class method within their implementation.

Reimplemented from QQuickItem.

Definition at line 827 of file qquicktextfield.cpp.

◆ implicitBackgroundHeight()

qreal QQuickTextField::implicitBackgroundHeight ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::TextField::implicitBackgroundHeight \readonly

This property holds the implicit background height.

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

See also
implicitBackgroundWidth

Definition at line 677 of file qquicktextfield.cpp.

◆ implicitBackgroundWidth()

qreal QQuickTextField::implicitBackgroundWidth ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::TextField::implicitBackgroundWidth \readonly

This property holds the implicit background width.

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

See also
implicitBackgroundHeight

Definition at line 658 of file qquicktextfield.cpp.

◆ implicitHeightChanged3

void QQuickTextField::implicitHeightChanged3 ( )
signal

◆ implicitWidthChanged3

void QQuickTextField::implicitWidthChanged3 ( )
signal

◆ insetChange()

void QQuickTextField::insetChange ( const QMarginsF & newInset,
const QMarginsF & oldInset )
protectedvirtual

Definition at line 834 of file qquicktextfield.cpp.

◆ isHovered()

bool QQuickTextField::isHovered ( ) const
Since
QtQuick.Controls 2.1 (Qt 5.8) \qmlproperty bool QtQuick.Controls::TextField::hovered \readonly

This property holds whether the text field is hovered.

See also
hoverEnabled

Definition at line 573 of file qquicktextfield.cpp.

◆ isHoverEnabled()

bool QQuickTextField::isHoverEnabled ( ) const
Since
QtQuick.Controls 2.1 (Qt 5.8) \qmlproperty bool QtQuick.Controls::TextField::hoverEnabled

This property determines whether the text field accepts hover events. The default value is false.

See also
hovered

Definition at line 605 of file qquicktextfield.cpp.

◆ itemChange()

void QQuickTextField::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
[5]

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

Reimplemented from QQuickItem.

Definition at line 805 of file qquicktextfield.cpp.

◆ leftInset()

qreal QQuickTextField::leftInset ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::TextField::leftInset

This property holds the left inset for the background.

See also
{Control Layout}, rightInset

Definition at line 719 of file qquicktextfield.cpp.

◆ mouseDoubleClickEvent()

void QQuickTextField::mouseDoubleClickEvent ( QMouseEvent * event)
overrideprotectedvirtual

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

The event information is provided by the event parameter.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 931 of file qquicktextfield.cpp.

◆ mouseMoveEvent()

void QQuickTextField::mouseMoveEvent ( QMouseEvent * event)
overrideprotectedvirtual

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

The event information is provided by the event parameter.

In order to receive mouse movement events, the preceding mouse press event must be accepted (by overriding \l mousePressEvent(), for example) and \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 898 of file qquicktextfield.cpp.

◆ mousePressEvent()

void QQuickTextField::mousePressEvent ( QMouseEvent * event)
overrideprotectedvirtual

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

The event information is provided by the event parameter.

In order to receive mouse press events, \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 884 of file qquicktextfield.cpp.

◆ mouseReleaseEvent()

void QQuickTextField::mouseReleaseEvent ( QMouseEvent * event)
overrideprotectedvirtual

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

The event information is provided by the event parameter.

In order to receive mouse release events, the preceding mouse press event must be accepted (by overriding \l mousePressEvent(), for example) and \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 917 of file qquicktextfield.cpp.

◆ placeholderText()

QString QQuickTextField::placeholderText ( ) const

\qmlproperty string QtQuick.Controls::TextField::placeholderText

This property holds the hint that is displayed in the TextField before the user enters text.

Definition at line 489 of file qquicktextfield.cpp.

◆ placeholderTextChanged

void QQuickTextField::placeholderTextChanged ( )
signal

◆ placeholderTextColor()

QColor QQuickTextField::placeholderTextColor ( ) const

\qmlproperty color QtQuick.Controls::TextField::placeholderTextColor

Since
QtQuick.Controls 2.5 (Qt 5.12)

This property holds the color of placeholderText.

See also
placeholderText

Definition at line 517 of file qquicktextfield.cpp.

◆ pressAndHold

void QQuickTextField::pressAndHold ( QQuickMouseEvent * event)
signal

◆ Q_REVISION [1/11]

QQuickTextField::Q_REVISION ( 2 ,
1  )
signal

◆ Q_REVISION [2/11]

QQuickTextField::Q_REVISION ( 2 ,
1  )
signal

◆ Q_REVISION [3/11]

QQuickTextField::Q_REVISION ( 2 ,
1  )
signal

◆ Q_REVISION [4/11]

QQuickTextField::Q_REVISION ( 2 ,
1  )
signal

◆ Q_REVISION [5/11]

QQuickTextField::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [6/11]

QQuickTextField::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [7/11]

QQuickTextField::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [8/11]

QQuickTextField::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [9/11]

QQuickTextField::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [10/11]

QQuickTextField::Q_REVISION ( 2 ,
5  )
signal

◆ Q_REVISION [11/11]

QQuickTextField::Q_REVISION ( 2 ,
5  )
signal

◆ resetBottomInset()

void QQuickTextField::resetBottomInset ( )

Definition at line 783 of file qquicktextfield.cpp.

◆ resetHoverEnabled()

void QQuickTextField::resetHoverEnabled ( )

Definition at line 628 of file qquicktextfield.cpp.

◆ resetLeftInset()

void QQuickTextField::resetLeftInset ( )

Definition at line 731 of file qquicktextfield.cpp.

◆ resetRightInset()

void QQuickTextField::resetRightInset ( )

Definition at line 757 of file qquicktextfield.cpp.

◆ resetTopInset()

void QQuickTextField::resetTopInset ( )

Definition at line 705 of file qquicktextfield.cpp.

◆ rightInset()

qreal QQuickTextField::rightInset ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::TextField::rightInset

This property holds the right inset for the background.

See also
{Control Layout}, leftInset

Definition at line 745 of file qquicktextfield.cpp.

◆ setBackground()

void QQuickTextField::setBackground ( QQuickItem * background)

Definition at line 438 of file qquicktextfield.cpp.

◆ setBottomInset()

void QQuickTextField::setBottomInset ( qreal inset)

Definition at line 777 of file qquicktextfield.cpp.

◆ setFocusReason()

void QQuickTextField::setFocusReason ( Qt::FocusReason reason)

Definition at line 558 of file qquicktextfield.cpp.

◆ setFont()

void QQuickTextField::setFont ( const QFont & font)

Definition at line 411 of file qquicktextfield.cpp.

◆ setHovered()

void QQuickTextField::setHovered ( bool hovered)

Definition at line 583 of file qquicktextfield.cpp.

◆ setHoverEnabled()

void QQuickTextField::setHoverEnabled ( bool enabled)

Definition at line 615 of file qquicktextfield.cpp.

◆ setLeftInset()

void QQuickTextField::setLeftInset ( qreal inset)

Definition at line 725 of file qquicktextfield.cpp.

◆ setPlaceholderText()

void QQuickTextField::setPlaceholderText ( const QString & text)

Definition at line 495 of file qquicktextfield.cpp.

◆ setPlaceholderTextColor()

void QQuickTextField::setPlaceholderTextColor ( const QColor & color)

Definition at line 523 of file qquicktextfield.cpp.

◆ setRightInset()

void QQuickTextField::setRightInset ( qreal inset)

Definition at line 751 of file qquicktextfield.cpp.

◆ setTopInset()

void QQuickTextField::setTopInset ( qreal inset)

Definition at line 699 of file qquicktextfield.cpp.

◆ timerEvent()

void QQuickTextField::timerEvent ( QTimerEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QChronoTimer provides higher-level interfaces to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also
startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 942 of file qquicktextfield.cpp.

◆ topInset()

qreal QQuickTextField::topInset ( ) const
Since
QtQuick.Controls 2.5 (Qt 5.12) \qmlproperty real QtQuick.Controls::TextField::topInset

This property holds the top inset for the background.

See also
{Control Layout}, bottomInset

Definition at line 693 of file qquicktextfield.cpp.

◆ updatePaintNode()

QSGNode * QQuickTextField::updatePaintNode ( QSGNode * oldNode,
UpdatePaintNodeData * updatePaintNodeData )
overrideprotectedvirtual

Called on the render thread when it is time to sync the state of the item with the scene graph.

The function is called as a result of QQuickItem::update(), if the user has set the QQuickItem::ItemHasContents flag on the item.

The function should return the root of the scene graph subtree for this item. Most implementations will return a single QSGGeometryNode containing the visual representation of this item. oldNode is the node that was returned the last time the function was called. updatePaintNodeData provides a pointer to the QSGTransformNode associated with this QQuickItem.

QSGNode *MyItem::updatePaintNode(QSGNode *node, UpdatePaintNodeData *)
{
QSGSimpleRectNode *n = static_cast<QSGSimpleRectNode *>(node);
if (!n) {
n->setColor(Qt::red);
}
return n;
}
QRectF boundingRect() const override
Returns the extents of the item in its own coordinate system: a rectangle from {0,...
\group qtquick-scenegraph-nodes \title Qt Quick Scene Graph Node classes
Definition qsgnode.h:37
The QSGSimpleRectNode class is a convenience class for drawing solid filled rectangles using scenegra...
void setRect(const QRectF &rect)
Sets the rectangle of this rect node to rect.
@ red
Definition qnamespace.h:36
GLfloat n
[4]

The main thread is blocked while this function is executed so it is safe to read values from the QQuickItem instance and other objects in the main thread.

If no call to QQuickItem::updatePaintNode() result in actual scene graph changes, like QSGNode::markDirty() or adding and removing nodes, then the underlying implementation may decide to not render the scene again as the visual outcome is identical.

Warning
It is crucial that graphics operations and interaction with the scene graph happens exclusively on the render thread, primarily during the QQuickItem::updatePaintNode() call. The best rule of thumb is to only use classes with the "QSG" prefix inside the QQuickItem::updatePaintNode() function.
This function is called on the render thread. This means any QObjects or thread local storage that is created will have affinity to the render thread, so apply caution when doing anything other than rendering in this function. Similarly for signals, these will be emitted on the render thread and will thus often be delivered via queued connections.
Note
All classes with QSG prefix should be used solely on the scene graph's rendering thread. See \l {Scene Graph and Rendering} for more information.
See also
QSGMaterial, QSGGeometryNode, QSGGeometry, QSGFlatColorMaterial, QSGTextureMaterial, QSGNode::markDirty(), {Graphics Resource Handling}

Reimplemented from QQuickItem.

Definition at line 841 of file qquicktextfield.cpp.

Friends And Related Symbol Documentation

◆ QQuickPressHandler

friend struct QQuickPressHandler
friend

Definition at line 121 of file qquicktextfield_p.h.

Property Documentation

◆ background

QQuickItem * QQuickTextField::background
readwrite

Definition at line 33 of file qquicktextfield_p.h.

◆ bottomInset

qreal QQuickTextField::bottomInset
readwrite

Definition at line 46 of file qquicktextfield_p.h.

◆ focusReason

Qt::FocusReason QQuickTextField::focusReason
readwrite

Definition at line 35 of file qquicktextfield_p.h.

◆ font

QFont QQuickTextField::font
readwrite

Definition at line 30 of file qquicktextfield_p.h.

◆ hovered

bool QQuickTextField::hovered
read

Definition at line 37 of file qquicktextfield_p.h.

◆ hoverEnabled

bool QQuickTextField::hoverEnabled
readwrite

Definition at line 38 of file qquicktextfield_p.h.

◆ implicitBackgroundHeight

qreal QQuickTextField::implicitBackgroundHeight
read

Definition at line 42 of file qquicktextfield_p.h.

◆ implicitBackgroundWidth

qreal QQuickTextField::implicitBackgroundWidth
read

Definition at line 41 of file qquicktextfield_p.h.

◆ implicitHeight

qreal QQuickTextField::implicitHeight
readwrite

Definition at line 32 of file qquicktextfield_p.h.

◆ implicitWidth

qreal QQuickTextField::implicitWidth
readwrite

Definition at line 31 of file qquicktextfield_p.h.

◆ leftInset

qreal QQuickTextField::leftInset
readwrite

Definition at line 44 of file qquicktextfield_p.h.

◆ placeholderText

QString QQuickTextField::placeholderText
readwrite

Definition at line 34 of file qquicktextfield_p.h.

◆ placeholderTextColor

QColor QQuickTextField::placeholderTextColor
readwrite

Definition at line 40 of file qquicktextfield_p.h.

◆ rightInset

qreal QQuickTextField::rightInset
readwrite

Definition at line 45 of file qquicktextfield_p.h.

◆ topInset

qreal QQuickTextField::topInset
readwrite

Definition at line 43 of file qquicktextfield_p.h.


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