#include <qquicktextedit_p.h>

Inheritance diagram for QQuickTextEdit:

Collaboration diagram for QQuickTextEdit:

Public Types
enum	HAlignment { AlignLeft = Qt::AlignLeft , AlignRight = Qt::AlignRight , AlignHCenter = Qt::AlignHCenter , AlignJustify = Qt::AlignJustify }

enum	VAlignment { AlignTop = Qt::AlignTop , AlignBottom = Qt::AlignBottom , AlignVCenter = Qt::AlignVCenter }

enum	TextFormat { PlainText = Qt::PlainText , RichText = Qt::RichText , AutoText = Qt::AutoText , MarkdownText = Qt::MarkdownText }

enum	WrapMode { NoWrap = QTextOption::NoWrap , WordWrap = QTextOption::WordWrap , WrapAnywhere = QTextOption::WrapAnywhere , WrapAtWordBoundaryOrAnywhere = QTextOption::WrapAtWordBoundaryOrAnywhere , Wrap = QTextOption::WrapAtWordBoundaryOrAnywhere }

enum	SelectionMode { SelectCharacters , SelectWords }

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
void	selectAll ()
	\qmlmethod QtQuick::TextEdit::selectAll()

void	selectWord ()
	\qmlmethod QtQuick::TextEdit::selectWord()

void	select (int start, int end)
	\qmlmethod QtQuick::TextEdit::select(int start, int end)

void	deselect ()
	\qmlmethod QtQuick::TextEdit::deselect()

bool	isRightToLeft (int start, int end)
	\qmlmethod QtQuick::TextEdit::isRightToLeft(int start, int end)

void	undo ()
	\qmlmethod QtQuick::TextEdit::undo()

void	redo ()
	\qmlmethod QtQuick::TextEdit::redo()

void	insert (int position, const QString &text)
	\qmlmethod QtQuick::TextEdit::insert(int position, string text)

void	remove (int start, int end)
	\qmlmethod string QtQuick::TextEdit::remove(int start, int end)

	Q_REVISION (2, 2) void append(const QString &text)

	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

Signals
void	textChanged ()

	Q_REVISION (2, 7) void preeditTextChanged()

void	contentSizeChanged ()

void	cursorPositionChanged ()

void	cursorRectangleChanged ()

void	selectionStartChanged ()

void	selectionEndChanged ()

void	selectedTextChanged ()

void	colorChanged (const QColor &color)

void	selectionColorChanged (const QColor &color)

void	selectedTextColorChanged (const QColor &color)

void	fontChanged (const QFont &font)

void	horizontalAlignmentChanged (QQuickTextEdit::HAlignment alignment)

void	verticalAlignmentChanged (QQuickTextEdit::VAlignment alignment)

void	wrapModeChanged ()

void	lineCountChanged ()

void	textFormatChanged (QQuickTextEdit::TextFormat textFormat)

void	readOnlyChanged (bool isReadOnly)

void	cursorVisibleChanged (bool isCursorVisible)

void	cursorDelegateChanged ()

void	overwriteModeChanged (bool overwriteMode)

void	activeFocusOnPressChanged (bool activeFocusOnPressed)

void	persistentSelectionChanged (bool isPersistentSelection)

void	textMarginChanged (qreal textMargin)

	Q_REVISION (2, 1) void selectByKeyboardChanged(bool selectByKeyboard)

void	selectByMouseChanged (bool selectByMouse)

void	mouseSelectionModeChanged (QQuickTextEdit::SelectionMode mode)

void	linkActivated (const QString &link)

	Q_REVISION (2, 2) void linkHovered(const QString &link)

void	canPasteChanged ()

void	canUndoChanged ()

void	canRedoChanged ()

void	inputMethodComposingChanged ()

void	effectiveHorizontalAlignmentChanged ()

void	baseUrlChanged ()

void	inputMethodHintsChanged ()

void	renderTypeChanged ()

	Q_REVISION (2, 6) void editingFinished()

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

	Q_REVISION (2, 10) void tabStopDistanceChanged(qreal distance)

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
	QQuickTextEdit (QQuickItem *parent=nullptr)

	~QQuickTextEdit () override

QString	text () const

void	setText (const QString &)
	\qmlproperty string QtQuick::TextEdit::font.family

	Q_REVISION (2, 7) QString preeditText() const

TextFormat	textFormat () const
	\qmlproperty enumeration QtQuick::TextEdit::textFormat

void	setTextFormat (TextFormat format)

QFont	font () const

void	setFont (const QFont &font)

QColor	color () const

void	setColor (const QColor &c)

QColor	selectionColor () const
	\qmlproperty color QtQuick::TextEdit::selectionColor

void	setSelectionColor (const QColor &c)

QColor	selectedTextColor () const
	\qmlproperty color QtQuick::TextEdit::selectedTextColor

void	setSelectedTextColor (const QColor &c)

HAlignment	hAlign () const
	\qmlproperty enumeration QtQuick::TextEdit::horizontalAlignment \qmlproperty enumeration QtQuick::TextEdit::verticalAlignment \qmlproperty enumeration QtQuick::TextEdit::effectiveHorizontalAlignment

void	setHAlign (HAlignment align)

void	resetHAlign ()

HAlignment	effectiveHAlign () const

VAlignment	vAlign () const

void	setVAlign (VAlignment align)

WrapMode	wrapMode () const
	\qmlproperty enumeration QtQuick::TextEdit::wrapMode

void	setWrapMode (WrapMode w)

int	lineCount () const
	\qmlproperty int QtQuick::TextEdit::lineCount

int	length () const
	\qmlproperty int QtQuick::TextEdit::length

bool	isCursorVisible () const
	\qmlproperty bool QtQuick::TextEdit::cursorVisible If true the text edit shows a cursor.

void	setCursorVisible (bool on)

int	cursorPosition () const
	\qmlproperty int QtQuick::TextEdit::cursorPosition The position of the cursor in the TextEdit.

void	setCursorPosition (int pos)

QQmlComponent *	cursorDelegate () const
	\qmlproperty Component QtQuick::TextEdit::cursorDelegate The delegate for the cursor in the TextEdit.

void	setCursorDelegate (QQmlComponent *)

bool	overwriteMode () const
	\qmlproperty bool QtQuick::TextEdit::overwriteMode

void	setOverwriteMode (bool overwrite)

int	selectionStart () const
	\qmlproperty int QtQuick::TextEdit::selectionStart

int	selectionEnd () const
	\qmlproperty int QtQuick::TextEdit::selectionEnd

QString	selectedText () const
	\qmlproperty string QtQuick::TextEdit::selectedText

bool	focusOnPress () const
	\qmlproperty bool QtQuick::TextEdit::activeFocusOnPress

void	setFocusOnPress (bool on)

bool	persistentSelection () const
	\qmlproperty bool QtQuick::TextEdit::persistentSelection

void	setPersistentSelection (bool on)

qreal	textMargin () const
	\qmlproperty real QtQuick::TextEdit::textMargin

void	setTextMargin (qreal margin)

Qt::InputMethodHints	inputMethodHints () const
	\qmlproperty enumeration QtQuick::TextEdit::inputMethodHints

void	setInputMethodHints (Qt::InputMethodHints hints)

bool	selectByKeyboard () const
	\qmlproperty bool QtQuick::TextEdit::selectByKeyboard

void	setSelectByKeyboard (bool)

bool	selectByMouse () const
	\qmlproperty bool QtQuick::TextEdit::selectByMouse

void	setSelectByMouse (bool)

SelectionMode	mouseSelectionMode () const
	\qmlproperty enumeration QtQuick::TextEdit::mouseSelectionMode

void	setMouseSelectionMode (SelectionMode mode)

bool	canPaste () const
	\qmlproperty bool QtQuick::TextEdit::canPaste

bool	canUndo () const
	\qmlproperty bool QtQuick::TextEdit::canUndo

bool	canRedo () const
	\qmlproperty bool QtQuick::TextEdit::canRedo

void	componentComplete () override
	Ensures any delayed caching or data loading the class needs to performed is complete.

int	resourcesLoading () const

void	setReadOnly (bool)
	\qmlproperty bool QtQuick::TextEdit::readOnly

bool	isReadOnly () const

QRectF	cursorRectangle () const
	\qmlproperty rectangle QtQuick::TextEdit::cursorRectangle

qreal	contentWidth () const
	\qmlproperty real QtQuick::TextEdit::contentWidth

qreal	contentHeight () const
	\qmlproperty real QtQuick::TextEdit::contentHeight

QUrl	baseUrl () const
	\qmlproperty url QtQuick::TextEdit::baseUrl

void	setBaseUrl (const QUrl &url)

void	resetBaseUrl ()

Q_INVOKABLE QRectF	positionToRectangle (int) const
	\qmlmethod rectangle QtQuick::TextEdit::positionToRectangle(position)

Q_INVOKABLE int	positionAt (qreal x, qreal y) const
	\qmlmethod int QtQuick::TextEdit::positionAt(int x, int y)

Q_INVOKABLE void	moveCursorSelection (int pos)
	\qmlmethod QtQuick::TextEdit::moveCursorSelection(int position, SelectionMode mode)

Q_INVOKABLE void	moveCursorSelection (int pos, SelectionMode mode)

QQuickTextSelection *	cursorSelection () const
	\qmlproperty QtQuick::TextSelection QtQuick::TextEdit::cursorSelection

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	isInputMethodComposing () const
	\qmlproperty bool QtQuick::TextEdit::inputMethodComposing

RenderType	renderType () const
	\qmlproperty enumeration QtQuick::TextEdit::renderType

void	setRenderType (RenderType renderType)

Q_INVOKABLE QString	getText (int start, int end) const
	\qmlmethod string QtQuick::TextEdit::getText(int start, int end)

Q_INVOKABLE QString	getFormattedText (int start, int end) const
	\qmlmethod string QtQuick::TextEdit::getFormattedText(int start, int end)

QQuickTextDocument *	textDocument ()

QString	hoveredLink () const
	\qmlsignal QtQuick::TextEdit::linkHovered(string link)

	Q_REVISION (2, 3) Q_INVOKABLE QString linkAt(qreal x

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

int	tabStopDistance () const
	\qmlproperty real QtQuick::TextEdit::tabStopDistance

void	setTabStopDistance (qreal distance)

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.

QQuickWindow *	window () const
	Returns the window in which this item is rendered.

QQuickItem *	parentItem () 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< QQuickTransform >	transform ()

qreal	x () const

qreal	y () const

QPointF	position () const

void	setX (qreal)

void	setY (qreal)

void	setPosition (const QPointF &)

QBindable< qreal >	bindableX ()

QBindable< qreal >	bindableY ()

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< qreal >	bindableWidth ()

qreal	height () const

void	setHeight (qreal)

void	resetHeight ()

void	setImplicitHeight (qreal)

qreal	implicitHeight () const

QBindable< qreal >	bindableHeight ()

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.

QQuickItem *	viewportItem () 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.

QQuickItem *	scopedFocusItem () 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< QQuickItemGrabResult >	grabToImage (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)

QObject *	containmentMask () 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 QQuickItem *	childAt (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 QSGTextureProvider *	textureProvider () 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< QString >	bindableObjectName ()

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

QThread *	thread () 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 >
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 >
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 QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () 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

Public Attributes
qreal y	const

Public Attributes inherited from QQuickItem
const QSize &	targetSize = QSize())

qreal y	const

Protected Member Functions
	QQuickTextEdit (QQuickTextEditPrivate &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.

bool	event (QEvent *) override
	\reimp

void	keyPressEvent (QKeyEvent *) override
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Handles the given key event.

void	keyReleaseEvent (QKeyEvent *) override
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Handles the given key event.

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	mousePressEvent (QMouseEvent *event) override
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Handles the given mouse event.

void	mouseReleaseEvent (QMouseEvent *event) override
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Handles the given mouse event.

void	mouseDoubleClickEvent (QMouseEvent *event) override
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Handles the given mouse event.

void	mouseMoveEvent (QMouseEvent *event) override
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Handles the given mouse event.

QSGNode *	updatePaintNode (QSGNode oldNode, UpdatePaintNodeData updatePaintNodeData) 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)

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

virtual void	mouseUngrabEvent ()
	This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this 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 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
QObject *	sender () 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
QString	text

QColor	color

QColor	selectionColor

QColor	selectedTextColor

QFont	font

HAlignment	horizontalAlignment

HAlignment	effectiveHorizontalAlignment

VAlignment	verticalAlignment

WrapMode	wrapMode

int	lineCount

int	length

qreal	contentWidth

qreal	contentHeight

qreal	paintedWidth

qreal	paintedHeight

TextFormat	textFormat

bool	readOnly

bool	cursorVisible

int	cursorPosition

QRectF	cursorRectangle

QQmlComponent *	cursorDelegate

bool	overwriteMode

int	selectionStart

int	selectionEnd

QString	selectedText

bool	activeFocusOnPress

bool	persistentSelection

qreal	textMargin

Qt::InputMethodHints	inputMethodHints

bool	selectByKeyboard

bool	selectByMouse

SelectionMode	mouseSelectionMode

bool	canPaste

bool	canUndo

bool	canRedo

bool	inputMethodComposing

QUrl	baseUrl

RenderType	renderType

QQuickTextDocument *	textDocument
	\qmlproperty TextDocument QtQuick::TextEdit::textDocument

QString	hoveredLink

qreal	padding

qreal	topPadding

qreal	leftPadding

qreal	rightPadding

qreal	bottomPadding

QString	preeditText
	\qmlproperty string QtQuick::TextEdit::preeditText \readonly

qreal	tabStopDistance

QQuickTextSelection *	cursorSelection

Properties inherited from QQuickImplicitSizeItem
qreal	implicitWidth

qreal	implicitHeight

Properties inherited from QQuickItem
QQuickItem *	parent
	\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< QQuickTransform >	transform
	\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

QObject *	containmentMask
	\qmlproperty QObject* QtQuick::Item::containmentMask

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QQuickTextUtil

class	QQuickTextDocumentPrivate

Additional Inherited Members
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 40 of file qquicktextedit_p.h.

Member Enumeration Documentation

◆ HAlignment

enum QQuickTextEdit::HAlignment

Enumerator
AlignLeft
AlignRight
AlignHCenter
AlignJustify

Definition at line 102 of file qquicktextedit_p.h.

◆ RenderType

enum QQuickTextEdit::RenderType

Enumerator
QtRendering
NativeRendering
CurveRendering

Definition at line 139 of file qquicktextedit_p.h.

◆ SelectionMode

enum QQuickTextEdit::SelectionMode

Enumerator
SelectCharacters
SelectWords

Definition at line 133 of file qquicktextedit_p.h.

◆ TextFormat

enum QQuickTextEdit::TextFormat

Enumerator
PlainText
RichText
AutoText
MarkdownText

Definition at line 117 of file qquicktextedit_p.h.

◆ VAlignment

enum QQuickTextEdit::VAlignment

Enumerator
AlignTop
AlignBottom
AlignVCenter

Definition at line 110 of file qquicktextedit_p.h.

◆ WrapMode

enum QQuickTextEdit::WrapMode

Enumerator
NoWrap
WordWrap
WrapAnywhere
WrapAtWordBoundaryOrAnywhere
Wrap

Definition at line 125 of file qquicktextedit_p.h.

Constructor & Destructor Documentation

◆ QQuickTextEdit() [1/2]

QQuickTextEdit::QQuickTextEdit ( QQuickItem * parent = nullptr )

Definition at line 143 of file qquicktextedit.cpp.

◆ ~QQuickTextEdit()

QQuickTextEdit::~QQuickTextEdit ( )

override

Definition at line 150 of file qquicktextedit.cpp.

◆ QQuickTextEdit() [2/2]

QQuickTextEdit::QQuickTextEdit	(	QQuickTextEditPrivate &	dd,
		QQuickItem *	parent = nullptr )

protected

Definition at line 156 of file qquicktextedit.cpp.

Member Function Documentation

◆ activeFocusOnPressChanged

void QQuickTextEdit::activeFocusOnPressChanged ( bool activeFocusOnPressed )

signal

◆ baseUrl()

QUrl QQuickTextEdit::baseUrl ( ) const

\qmlproperty url QtQuick::TextEdit::baseUrl

This property specifies a base URL which is used to resolve relative URLs within the text.

The default value is the url of the QML file instantiating the TextEdit item.

Definition at line 1237 of file qquicktextedit.cpp.

◆ baseUrlChanged

void QQuickTextEdit::baseUrlChanged ( )

signal

◆ bottomPadding()

qreal QQuickTextEdit::bottomPadding ( ) const

Definition at line 3746 of file qquicktextedit.cpp.

◆ boundingRect()

QRectF QQuickTextEdit::boundingRect ( ) const

overridevirtual

Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().

Reimplemented from QQuickItem.

Definition at line 3006 of file qquicktextedit.cpp.

◆ canPaste()

bool QQuickTextEdit::canPaste ( ) const

\qmlproperty bool QtQuick::TextEdit::canPaste

Returns true if the TextEdit is writable and the content of the clipboard is suitable for pasting into the TextEdit.

Definition at line 2757 of file qquicktextedit.cpp.

◆ canPasteChanged

void QQuickTextEdit::canPasteChanged ( )

signal

◆ canRedo()

bool QQuickTextEdit::canRedo ( ) const

\qmlproperty bool QtQuick::TextEdit::canRedo

Returns true if the TextEdit is writable and there are \l {undo}{undone} operations that can be redone.

Definition at line 2787 of file qquicktextedit.cpp.

◆ canRedoChanged

void QQuickTextEdit::canRedoChanged ( )

signal

◆ canUndo()

bool QQuickTextEdit::canUndo ( ) const

\qmlproperty bool QtQuick::TextEdit::canUndo

Returns true if the TextEdit is writable and there are previous operations that can be undone.

Definition at line 2774 of file qquicktextedit.cpp.

◆ canUndoChanged

void QQuickTextEdit::canUndoChanged ( )

signal

◆ clipRect()

QRectF QQuickTextEdit::clipRect ( ) const

overridevirtual

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

This is the region intended to remain visible if \l clip is true. It can also be used in updatePaintNode() to limit the graphics added to the scene graph.

For example, a large drawing or a large text document might be shown in a Flickable that occupies only part of the application's Window: in that case, Flickable is the viewport item, and a custom content-rendering item may choose to omit scene graph nodes that fall outside the area that is currently visible. If the \l ItemObservesViewport flag is set, this area will change each time the user scrolls the content in the Flickable.

In case of nested viewport items, clipRect() is the intersection of the {boundingRect}s of all ancestors that have the \l ItemIsViewport flag set, mapped to the coordinate system of this item.

See also: boundingRect()

Reimplemented from QQuickItem.

Definition at line 3027 of file qquicktextedit.cpp.

◆ color()

QColor QQuickTextEdit::color ( ) const

\qmlproperty color QtQuick::TextEdit::color

The text color.

\qml

green text using hexadecimal notation TextEdit { color: "#00FF00" } \endqml

\qml steelblue text using SVG color name TextEdit { color: "steelblue" } \endqml

Definition at line 772 of file qquicktextedit.cpp.

◆ colorChanged

void QQuickTextEdit::colorChanged ( const QColor & color )

signal

◆ componentComplete()

void QQuickTextEdit::componentComplete ( )

overridevirtual

Ensures any delayed caching or data loading the class needs to performed is complete.

Reimplemented from QQuickItem.

Definition at line 1744 of file qquicktextedit.cpp.

◆ contentHeight()

qreal QQuickTextEdit::contentHeight ( ) const

\qmlproperty real QtQuick::TextEdit::contentHeight

Returns the height of the text, including the height past the height that is covered if the text does not fit within the set height.

Definition at line 1222 of file qquicktextedit.cpp.

◆ contentSizeChanged

void QQuickTextEdit::contentSizeChanged ( )

signal

◆ contentWidth()

qreal QQuickTextEdit::contentWidth ( ) const

\qmlproperty real QtQuick::TextEdit::contentWidth

Returns the width of the text, including the width past the width which is covered due to insufficient wrapping if \l wrapMode is set.

Definition at line 1210 of file qquicktextedit.cpp.

◆ cursorDelegate()

QQmlComponent * QQuickTextEdit::cursorDelegate ( ) const

\qmlproperty Component QtQuick::TextEdit::cursorDelegate The delegate for the cursor in the TextEdit.

If you set a cursorDelegate for a TextEdit, this delegate will be used for drawing the cursor instead of the standard cursor. An instance of the delegate will be created and managed by the text edit when a cursor is needed, and the x and y properties of delegate instance will be set so as to be one pixel before the top left of the current character.

Note that the root item of the delegate component must be a QQuickItem or QQuickItem derived item.

Definition at line 1503 of file qquicktextedit.cpp.

◆ cursorDelegateChanged

void QQuickTextEdit::cursorDelegateChanged ( )

signal

◆ cursorPosition()

int QQuickTextEdit::cursorPosition ( ) const

\qmlproperty int QtQuick::TextEdit::cursorPosition The position of the cursor in the TextEdit.

The cursor is positioned between characters.

Note: The characters in this case refer to the string of \l QChar objects, therefore 16-bit Unicode characters, and the position is considered an index into this string. This does not necessarily correspond to individual graphemes in the writing system, as a single grapheme may be represented by multiple Unicode characters, such as in the case of surrogate pairs, linguistic ligatures or diacritics.

Definition at line 1471 of file qquicktextedit.cpp.

◆ cursorPositionChanged

void QQuickTextEdit::cursorPositionChanged ( )

signal

◆ cursorRectangle()

QRectF QQuickTextEdit::cursorRectangle ( ) const

\qmlproperty rectangle QtQuick::TextEdit::cursorRectangle

The rectangle where the standard text cursor is rendered within the text edit. Read-only.

The position and height of a custom cursorDelegate are updated to follow the cursorRectangle automatically when it changes. The width of the delegate is unaffected by changes in the cursor rectangle.

Definition at line 1968 of file qquicktextedit.cpp.

◆ cursorRectangleChanged

void QQuickTextEdit::cursorRectangleChanged ( )

signal

◆ cursorSelection()

QQuickTextSelection * QQuickTextEdit::cursorSelection ( ) const

\qmlproperty QtQuick::TextSelection QtQuick::TextEdit::cursorSelection

Since: 6.7 \preliminary

This property is an object that provides properties of the text that is currently selected, if any, alongside the text cursor.

See also: selectedText, selectionStart, selectionEnd

Definition at line 1328 of file qquicktextedit.cpp.

◆ cursorVisibleChanged

void QQuickTextEdit::cursorVisibleChanged ( bool isCursorVisible )

signal

◆ deselect

void QQuickTextEdit::deselect ( )

slot

\qmlmethod QtQuick::TextEdit::deselect()

Removes active text selection.

Definition at line 2040 of file qquicktextedit.cpp.

◆ effectiveHAlign()

QQuickTextEdit::HAlignment QQuickTextEdit::effectiveHAlign ( ) const

Definition at line 892 of file qquicktextedit.cpp.

◆ effectiveHorizontalAlignmentChanged

void QQuickTextEdit::effectiveHorizontalAlignmentChanged ( )

signal

◆ event()

bool QQuickTextEdit::event ( QEvent * ev )

overrideprotectedvirtual

\reimp

Reimplemented from QQuickItem.

Definition at line 1974 of file qquicktextedit.cpp.

◆ focusInEvent()

void QQuickTextEdit::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 3298 of file qquicktextedit.cpp.

◆ focusOnPress()

bool QQuickTextEdit::focusOnPress ( ) const

\qmlproperty bool QtQuick::TextEdit::activeFocusOnPress

Whether the TextEdit should gain active focus on a mouse press. By default this is set to true.

Definition at line 1586 of file qquicktextedit.cpp.

◆ focusOutEvent()

void QQuickTextEdit::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 3305 of file qquicktextedit.cpp.

◆ font()

QFont QQuickTextEdit::font ( ) const

Definition at line 721 of file qquicktextedit.cpp.

◆ fontChanged

void QQuickTextEdit::fontChanged ( const QFont & font )

signal

◆ geometryChange()

void QQuickTextEdit::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 1706 of file qquicktextedit.cpp.

◆ getFormattedText()

QString QQuickTextEdit::getFormattedText	(	int	start,
		int	end ) const

\qmlmethod string QtQuick::TextEdit::getFormattedText(int start, int end)

Returns the section of text that is between the start and end positions.

The returned text will be formatted according the \l textFormat property.

Definition at line 3404 of file qquicktextedit.cpp.

◆ getText()

QString QQuickTextEdit::getText	(	int	start,
		int	end ) const

\qmlmethod string QtQuick::TextEdit::getText(int start, int end)

Returns the section of text that is between the start and end positions.

The returned text does not include any rich text formatting.

Definition at line 3379 of file qquicktextedit.cpp.

◆ hAlign()

QQuickTextEdit::HAlignment QQuickTextEdit::hAlign ( ) const

\qmlproperty enumeration QtQuick::TextEdit::horizontalAlignment \qmlproperty enumeration QtQuick::TextEdit::verticalAlignment \qmlproperty enumeration QtQuick::TextEdit::effectiveHorizontalAlignment

Sets the horizontal and vertical alignment of the text within the TextEdit item's width and height. By default, the text alignment follows the natural alignment of the text, for example text that is read from left to right will be aligned to the left.

Valid values for horizontalAlignment are:

\value TextEdit.AlignLeft left alignment with ragged edges on the right (default) \value TextEdit.AlignRight align each line to the right with ragged edges on the left \value TextEdit.AlignHCenter align each line to the center \value TextEdit.AlignJustify align each line to both right and left, spreading out words as necessary

Valid values for verticalAlignment are:

\value TextEdit.AlignTop start at the top of the item (default) \value TextEdit.AlignBottom align the last line to the bottom and other lines above \value TextEdit.AlignVCenter align the center vertically

When using the attached property LayoutMirroring::enabled to mirror application layouts, the horizontal alignment of text will also be mirrored. However, the property horizontalAlignment will remain unchanged. To query the effective horizontal alignment of TextEdit, use the read-only property effectiveHorizontalAlignment.

Definition at line 865 of file qquicktextedit.cpp.

◆ horizontalAlignmentChanged

void QQuickTextEdit::horizontalAlignmentChanged ( QQuickTextEdit::HAlignment alignment )

signal

◆ hoveredLink()

QString QQuickTextEdit::hoveredLink ( ) const

\qmlsignal QtQuick::TextEdit::linkHovered(string link)

Since: 5.2

This signal is emitted when the user hovers a link embedded in the text. The link must be in rich text or HTML format and the link string provides access to the particular link.

See also: hoveredLink, linkAt()

\qmlsignal QtQuick::TextEdit::editingFinished()

Since: 5.6

This signal is emitted when the text edit loses focus.

\qmlproperty string QtQuick::TextEdit::hoveredLink

Since: 5.2

This property contains the link string when the user hovers a link embedded in the text. The link must be in rich text or HTML format and the link string provides access to the particular link.

See also: linkHovered, linkAt()

Definition at line 3547 of file qquicktextedit.cpp.

◆ hoverEnterEvent()

void QQuickTextEdit::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 3563 of file qquicktextedit.cpp.

◆ hoverLeaveEvent()

void QQuickTextEdit::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 3579 of file qquicktextedit.cpp.

◆ hoverMoveEvent()

void QQuickTextEdit::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 3571 of file qquicktextedit.cpp.

◆ inputMethodComposingChanged

void QQuickTextEdit::inputMethodComposingChanged ( )

signal

◆ inputMethodHints()

Qt::InputMethodHints QQuickTextEdit::inputMethodHints ( ) const

\qmlproperty enumeration QtQuick::TextEdit::inputMethodHints

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

The value is a bit-wise combination of flags or Qt.ImhNone if no hints are set.

Flags that alter behaviour are:

\value Qt.ImhHiddenText Characters should be hidden, as is typically used when entering passwords. \value Qt.ImhSensitiveData Typed text should not be stored by the active input method in any persistent storage like predictive user dictionary. \value Qt.ImhNoAutoUppercase The input method should not try to automatically switch to upper case when a sentence ends. \value Qt.ImhPreferNumbers Numbers are preferred (but not required). \value Qt.ImhPreferUppercase Upper case letters are preferred (but not required). \value Qt.ImhPreferLowercase Lower case letters are preferred (but not required). \value Qt.ImhNoPredictiveText Do not use predictive text (i.e. dictionary lookup) while typing. \value Qt.ImhDate The text editor functions as a date field. \value Qt.ImhTime The text editor functions as a time field.

Flags that restrict input (exclusive flags) are:

\value Qt.ImhDigitsOnly Only digits are allowed. \value Qt.ImhFormattedNumbersOnly Only number input is allowed. This includes decimal point and minus sign. \value Qt.ImhUppercaseOnly Only upper case letter input is allowed. \value Qt.ImhLowercaseOnly Only lower case letter input is allowed. \value Qt.ImhDialableCharactersOnly Only characters suitable for phone dialing are allowed. \value Qt.ImhEmailCharactersOnly Only characters suitable for email addresses are allowed. \value Qt.ImhUrlCharactersOnly Only characters suitable for URLs are allowed.

Masks:

\value Qt.ImhExclusiveInputMask This mask yields nonzero if any of the exclusive flags are used.

Definition at line 1680 of file qquicktextedit.cpp.

◆ inputMethodHintsChanged

void QQuickTextEdit::inputMethodHintsChanged ( )

signal

◆ insert

void QQuickTextEdit::insert	(	int	position,
		const QString &	text )

slot

\qmlmethod QtQuick::TextEdit::insert(int position, string text)

Inserts text into the TextEdit at position.

Definition at line 3437 of file qquicktextedit.cpp.

◆ invalidate()

void QQuickTextEdit::invalidate ( )

overridevirtual

Implements QQuickTextInterface.

Definition at line 444 of file qquicktextedit.cpp.

◆ isCursorVisible()

bool QQuickTextEdit::isCursorVisible ( ) const

\qmlproperty bool QtQuick::TextEdit::cursorVisible If true the text edit shows a cursor.

This property is set and unset when the text edit gets active focus, but it can also be set directly (useful, for example, if a KeyProxy might forward keys to it).

Definition at line 1439 of file qquicktextedit.cpp.

◆ isInputMethodComposing()

bool QQuickTextEdit::isInputMethodComposing ( ) const

\qmlproperty bool QtQuick::TextEdit::inputMethodComposing

This property holds whether the TextEdit has partial text input from an input method.

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

Definition at line 2805 of file qquicktextedit.cpp.

◆ isReadOnly()

bool QQuickTextEdit::isReadOnly ( ) const

Definition at line 1952 of file qquicktextedit.cpp.

◆ isRightToLeft

bool QQuickTextEdit::isRightToLeft	(	int	start,
		int	end )

slot

\qmlmethod QtQuick::TextEdit::isRightToLeft(int start, int end)

Returns true if the natural reading direction of the editor text found between positions start and end is right to left.

Definition at line 2110 of file qquicktextedit.cpp.

◆ itemChange()

void QQuickTextEdit::itemChange	(	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

QQuickItem::itemChange(change, value);

QQuickItem::itemChange

virtual void itemChange(ItemChange, const ItemChangeData &)

Called when change occurs for this item.

Definition qquickitem.cpp:5793

value

EGLOutputLayerEXT EGLint EGLAttrib value

[5]

Definition qeglstreamconvenience_p.h:46

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

Reimplemented from QQuickItem.

Definition at line 1719 of file qquicktextedit.cpp.

◆ keyPressEvent()

void QQuickTextEdit::keyPressEvent ( QKeyEvent * event )

overrideprotectedvirtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Handles the given key event.

Reimplemented from QQuickItem.

Definition at line 2015 of file qquicktextedit.cpp.

◆ keyReleaseEvent()

void QQuickTextEdit::keyReleaseEvent ( QKeyEvent * event )

overrideprotectedvirtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Handles the given key event.

Reimplemented from QQuickItem.

Definition at line 2027 of file qquicktextedit.cpp.

◆ leftPadding()

qreal QQuickTextEdit::leftPadding ( ) const

Definition at line 3706 of file qquicktextedit.cpp.

◆ length()

int QQuickTextEdit::length ( ) const

\qmlproperty int QtQuick::TextEdit::length

Returns the total number of plain text characters in the TextEdit item.

As this number doesn't include any formatting markup it may not be the same as the length of the string returned by the \l text property.

This property can be faster than querying the length the \l text property as it doesn't require any copying or conversion of the TextEdit's internal string data.

Definition at line 1197 of file qquicktextedit.cpp.

Referenced by testing.tools.encode_pdf_filter._PngIdatPdfStream::write().

Here is the caller graph for this function:

◆ lineCount()

\qmlproperty enumeration QtQuick::TextEdit::mouseSelectionMode

Specifies how text should be selected using a mouse.

\value TextEdit.SelectCharacters (default) The selection is updated with individual characters. \value TextEdit.SelectWords The selection is updated with whole words.

This property only applies when \l selectByMouse is true.

Definition at line 1883 of file qquicktextedit.cpp.

◆ mouseSelectionModeChanged

void QQuickTextEdit::mouseSelectionModeChanged ( QQuickTextEdit::SelectionMode mode )

signal

◆ moveCursorSelection() [1/2]

void QQuickTextEdit::moveCursorSelection ( int pos )

\qmlmethod QtQuick::TextEdit::moveCursorSelection(int position, SelectionMode mode)

Moves the cursor to position and updates the selection according to the optional mode parameter. (To only move the cursor, set the \l cursorPosition property.)

When this method is called it additionally sets either the selectionStart or the selectionEnd (whichever was at the previous cursor position) to the specified position. This allows you to easily extend and contract the selected text range.

The selection mode specifies whether the selection is updated on a per character or a per word basis. If not specified the selection mode will default to {TextEdit.SelectCharacters}.

\value TextEdit.SelectCharacters Sets either the selectionStart or selectionEnd (whichever was at the previous cursor position) to the specified position. \value TextEdit.SelectWords Sets the selectionStart and selectionEnd to include all words between the specified position and the previous cursor position. Words partially in the range are included.

For example, take this sequence of calls:

cursorPosition = 5
moveCursorSelection(9, TextEdit.SelectCharacters)
moveCursorSelection(7, TextEdit.SelectCharacters)

This moves the cursor to position 5, extend the selection end from 5 to 9 and then retract the selection end from 9 to 7, leaving the text from position 5 to 7 selected (the 6th and 7th characters).

The same sequence with TextEdit.SelectWords will extend the selection start to a word boundary before or on position 5 and extend the selection end to a word boundary on or past position 9.

Definition at line 1372 of file qquicktextedit.cpp.

◆ moveCursorSelection() [2/2]

void QQuickTextEdit::moveCursorSelection	(	int	pos,
		SelectionMode	mode )

Definition at line 1383 of file qquicktextedit.cpp.

◆ overwriteMode()

bool QQuickTextEdit::overwriteMode ( ) const

\qmlproperty bool QtQuick::TextEdit::overwriteMode

Since: 5.8 Whether text entered by the user will overwrite existing text.

As with many text editors, the text editor widget can be configured to insert or overwrite existing text with new text entered by the user.

If this property is true, existing text is overwritten, character-for-character by new text; otherwise, text is inserted at the cursor position, displacing existing text.

By default, this property is false (new text does not overwrite existing text).

Definition at line 1999 of file qquicktextedit.cpp.

◆ overwriteModeChanged

void QQuickTextEdit::overwriteModeChanged ( bool overwriteMode )

signal

◆ padding()

qreal QQuickTextEdit::padding ( ) const

Since: 5.6 \qmlproperty real QtQuick::TextEdit::padding \qmlproperty real QtQuick::TextEdit::topPadding \qmlproperty real QtQuick::TextEdit::leftPadding \qmlproperty real QtQuick::TextEdit::bottomPadding \qmlproperty real QtQuick::TextEdit::rightPadding

These properties hold the padding around the content. This space is reserved in addition to the contentWidth and contentHeight.

Definition at line 3652 of file qquicktextedit.cpp.

◆ persistentSelection()

bool QQuickTextEdit::persistentSelection ( ) const

\qmlproperty bool QtQuick::TextEdit::persistentSelection

Whether the TextEdit should keep the selection visible when it loses active focus to another item in the scene. By default this is set to false.

Definition at line 1607 of file qquicktextedit.cpp.

◆ persistentSelectionChanged

void QQuickTextEdit::persistentSelectionChanged ( bool isPersistentSelection )

signal

◆ positionAt()

int QQuickTextEdit::positionAt	(	qreal	x,
		qreal	y ) const

\qmlmethod int QtQuick::TextEdit::positionAt(int x, int y)

Returns the text position closest to pixel position (x, y).

Position 0 is before the first character, position 1 is after the first character but before the second, and so on until position \l {text}.length, which is after all characters.

Definition at line 1290 of file qquicktextedit.cpp.

◆ positionToRectangle()

QRectF QQuickTextEdit::positionToRectangle ( int pos ) const

\qmlmethod rectangle QtQuick::TextEdit::positionToRectangle(position)

Returns the rectangle at the given position in the text. The x, y, and height properties correspond to the cursor that would describe that position.

Definition at line 1273 of file qquicktextedit.cpp.

◆ Q_REVISION [1/14]

QQuickTextEdit::Q_REVISION	(	2	,
		1	)

signal

◆ Q_REVISION [2/14]

QQuickTextEdit::Q_REVISION	(	2	,
		10	)

signal

◆ Q_REVISION [3/14]

QQuickTextEdit::Q_REVISION	(	2	,
		2	) const &

slot

◆ Q_REVISION [4/14]

QQuickTextEdit::Q_REVISION	(	2	,
		2	) const &

signal

◆ Q_REVISION() [5/14]

QQuickTextEdit::Q_REVISION	(	2	,
		3	)

◆ Q_REVISION [6/14]

QQuickTextEdit::Q_REVISION	(	2	,
		6	)

signal

◆ Q_REVISION [7/14]

QQuickTextEdit::Q_REVISION	(	2	,
		6	)

signal

◆ Q_REVISION [8/14]

QQuickTextEdit::Q_REVISION	(	2	,
		6	)

signal

◆ Q_REVISION [9/14]

QQuickTextEdit::Q_REVISION	(	2	,
		6	)

signal

◆ Q_REVISION [10/14]

QQuickTextEdit::Q_REVISION	(	2	,
		6	)

signal

◆ Q_REVISION [11/14]

QQuickTextEdit::Q_REVISION	(	2	,
		6	)

signal

◆ Q_REVISION() [12/14]

QQuickTextEdit::Q_REVISION	(	2	,
		7	) const

◆ Q_REVISION [13/14]

QQuickTextEdit::Q_REVISION	(	2	,
		7	)

slot

◆ Q_REVISION [14/14]

QQuickTextEdit::Q_REVISION	(	2	,
		7	)

signal

◆ readOnlyChanged

void QQuickTextEdit::readOnlyChanged ( bool isReadOnly )

signal

◆ redo

void QQuickTextEdit::redo ( )

slot

\qmlmethod QtQuick::TextEdit::redo()

Redoes the last operation if redo is \l {canRedo}{available}.

Definition at line 2176 of file qquicktextedit.cpp.

◆ remove

void QQuickTextEdit::remove	(	int	start,
		int	end )

slot

\qmlmethod string QtQuick::TextEdit::remove(int start, int end)

Removes the section of text that is between the start and end positions from the TextEdit.

Definition at line 3469 of file qquicktextedit.cpp.

◆ renderType()

QQuickTextEdit::RenderType QQuickTextEdit::renderType ( ) const

\qmlproperty enumeration QtQuick::TextEdit::renderType

Override the default rendering type for this component.

Supported render types are:

\value TextEdit.QtRendering Text is rendered using a scalable distance field for each glyph. \value TextEdit.NativeRendering Text is rendered using a platform-specific technique. \value TextEdit.CurveRendering Text is rendered using a curve rasterizer running directly on the graphics hardware. (Introduced in Qt 6.7.0.)

Select TextEdit.NativeRendering if you prefer text to look native on the target platform and do not require advanced features such as transformation of the text. Using such features in combination with the NativeRendering render type will lend poor and sometimes pixelated results.

Both TextEdit.QtRendering and TextEdit.CurveRendering are hardware-accelerated techniques. QtRendering is the faster of the two, but uses more memory and will exhibit rendering artifacts at large sizes. CurveRendering should be considered as an alternative in cases where QtRendering does not give good visual results or where reducing graphics memory consumption is a priority.

The default rendering type is determined by \l QQuickWindow::textRenderType().

Definition at line 701 of file qquicktextedit.cpp.

◆ renderTypeChanged

void QQuickTextEdit::renderTypeChanged ( )

signal

◆ resetBaseUrl()

void QQuickTextEdit::resetBaseUrl ( )

Definition at line 1258 of file qquicktextedit.cpp.

◆ resetBottomPadding()

void QQuickTextEdit::resetBottomPadding ( )

Definition at line 3760 of file qquicktextedit.cpp.

◆ resetHAlign()

void QQuickTextEdit::resetHAlign ( )

Definition at line 882 of file qquicktextedit.cpp.

◆ resetLeftPadding()

void QQuickTextEdit::resetLeftPadding ( )

Definition at line 3720 of file qquicktextedit.cpp.

◆ resetPadding()

void QQuickTextEdit::resetPadding ( )

Definition at line 3681 of file qquicktextedit.cpp.

◆ resetRightPadding()

void QQuickTextEdit::resetRightPadding ( )

Definition at line 3740 of file qquicktextedit.cpp.

◆ resetTopPadding()

void QQuickTextEdit::resetTopPadding ( )

Definition at line 3700 of file qquicktextedit.cpp.

◆ resourcesLoading()

int QQuickTextEdit::resourcesLoading ( ) const

Definition at line 1782 of file qquicktextedit.cpp.

◆ rightPadding()

qreal QQuickTextEdit::rightPadding ( ) const

Definition at line 3726 of file qquicktextedit.cpp.

◆ select

void QQuickTextEdit::select	(	int	start,
		int	end )

slot

\qmlmethod QtQuick::TextEdit::select(int start, int end)

Causes the text from start to end to be selected.

If either start or end is out of range, the selection is not changed.

After calling this, selectionStart will become the lesser and selectionEnd will become the greater (regardless of the order passed to this method).

See also: selectionStart, selectionEnd

Definition at line 2085 of file qquicktextedit.cpp.

◆ selectAll

void QQuickTextEdit::selectAll ( )

slot

\qmlmethod QtQuick::TextEdit::selectAll()

Causes all text to be selected.

Definition at line 2053 of file qquicktextedit.cpp.

◆ selectByKeyboard()

bool QQuickTextEdit::selectByKeyboard ( ) const

\qmlproperty bool QtQuick::TextEdit::selectByKeyboard

Since: 5.1

Defaults to true when the editor is editable, and false when read-only.

If true, the user can use the keyboard to select text even if the editor is read-only. If false, the user cannot use the keyboard to select text even if the editor is editable.

See also: readOnly

Definition at line 1802 of file qquicktextedit.cpp.

◆ selectByMouse()

bool QQuickTextEdit::selectByMouse ( ) const

\qmlproperty bool QtQuick::TextEdit::selectByMouse

Defaults to true since Qt 6.4.

If true, the user can use the mouse to select text in the usual way.

Note: In versions prior to 6.4, the default was false; but if you enabled this property, you could also select text on a touchscreen by dragging your finger across it. This interfered with flicking when TextEdit was used inside a Flickable. However, Qt has supported text selection handles on mobile platforms, and on embedded platforms using Qt Virtual Keyboard, since version 5.7, via QInputMethod. Most users would be surprised if finger dragging selected text rather than flicking the parent Flickable. Therefore, selectByMouse now really means what it says: if true, you can select text by dragging only with a mouse, whereas the platform is expected to provide selection handles on touchscreens. If this change does not suit your application, you can set selectByMouse to false, or import an older API version (for example {import QtQuick 6.3}) to revert to the previous behavior. The option to revert behavior by changing the import version will be removed in a later version of Qt.

Definition at line 1848 of file qquicktextedit.cpp.

◆ selectByMouseChanged

void QQuickTextEdit::selectByMouseChanged ( bool selectByMouse )

signal

◆ selectedText()

QString QQuickTextEdit::selectedText ( ) const

\qmlproperty string QtQuick::TextEdit::selectedText

This read-only property provides the text currently selected in the text edit.

It is equivalent to the following snippet, but is faster and easier to use.

//myTextEdit is the id of the TextEdit
myTextEdit.text.toString().substring(myTextEdit.selectionStart,
        myTextEdit.selectionEnd);

This property is read-only. To change the selection, use select(start,end), selectAll(), or selectWord().

See also: selectionStart, cursorPosition, selectedText

Definition at line 1548 of file qquicktextedit.cpp.

◆ selectionEndChanged

void QQuickTextEdit::selectionEndChanged ( )

signal

◆ selectionStart()

int QQuickTextEdit::selectionStart ( ) const

\qmlproperty int QtQuick::TextEdit::selectionStart

The cursor position before the first character in the current selection.

This property is read-only. To change the selection, use select(start,end), selectAll(), or selectWord().

See also: selectionEnd, cursorPosition, selectedText

Definition at line 1532 of file qquicktextedit.cpp.

◆ selectionStartChanged

void QQuickTextEdit::selectionStartChanged ( )

signal

◆ selectWord

void QQuickTextEdit::selectWord ( )

slot

\qmlmethod QtQuick::TextEdit::selectWord()

Causes the word closest to the current cursor position to be selected.

Definition at line 2064 of file qquicktextedit.cpp.

◆ setBaseUrl()

void QQuickTextEdit::setBaseUrl ( const QUrl & url )

Definition at line 1247 of file qquicktextedit.cpp.

◆ setBottomPadding()

void QQuickTextEdit::setBottomPadding ( qreal padding )

Definition at line 3754 of file qquicktextedit.cpp.

◆ setColor()

void QQuickTextEdit::setColor ( const QColor & c )

Definition at line 778 of file qquicktextedit.cpp.

◆ setCursorDelegate()

void QQuickTextEdit::setCursorDelegate ( QQmlComponent * c )

Definition at line 1509 of file qquicktextedit.cpp.

◆ setCursorPosition()

void QQuickTextEdit::setCursorPosition ( int pos )

Definition at line 1477 of file qquicktextedit.cpp.

◆ setCursorVisible()

void QQuickTextEdit::setCursorVisible ( bool on )

Definition at line 1445 of file qquicktextedit.cpp.

◆ setFocusOnPress()

void QQuickTextEdit::setFocusOnPress ( bool on )

Definition at line 1592 of file qquicktextedit.cpp.

◆ setFont()

void QQuickTextEdit::setFont ( const QFont & font )

Definition at line 727 of file qquicktextedit.cpp.

◆ setHAlign()

void QQuickTextEdit::setHAlign ( HAlignment align )

Definition at line 871 of file qquicktextedit.cpp.

◆ setInputMethodHints()

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

Definition at line 1690 of file qquicktextedit.cpp.

◆ setLeftPadding()

void QQuickTextEdit::setLeftPadding ( qreal padding )

Definition at line 3714 of file qquicktextedit.cpp.

◆ setMouseSelectionMode()

void QQuickTextEdit::setMouseSelectionMode ( SelectionMode mode )

Definition at line 1889 of file qquicktextedit.cpp.

◆ setOverwriteMode()

void QQuickTextEdit::setOverwriteMode ( bool overwrite )

Definition at line 2005 of file qquicktextedit.cpp.

◆ setPadding()

void QQuickTextEdit::setPadding ( qreal padding )

Definition at line 3658 of file qquicktextedit.cpp.

◆ setPersistentSelection()

void QQuickTextEdit::setPersistentSelection ( bool on )

Definition at line 1613 of file qquicktextedit.cpp.

◆ setReadOnly()

void QQuickTextEdit::setReadOnly ( bool r )

\qmlproperty bool QtQuick::TextEdit::readOnly

Whether the user can interact with the TextEdit item. If this property is set to true the text cannot be edited by user interaction.

By default this property is false.

Definition at line 1907 of file qquicktextedit.cpp.

◆ setRenderType()

void QQuickTextEdit::setRenderType ( QQuickTextEdit::RenderType renderType )

Definition at line 707 of file qquicktextedit.cpp.

◆ setRightPadding()

void QQuickTextEdit::setRightPadding ( qreal padding )

Definition at line 3734 of file qquicktextedit.cpp.

◆ setSelectByKeyboard()

void QQuickTextEdit::setSelectByKeyboard ( bool on )

Definition at line 1810 of file qquicktextedit.cpp.

◆ setSelectByMouse()

void QQuickTextEdit::setSelectByMouse ( bool on )

Definition at line 1854 of file qquicktextedit.cpp.

◆ setSelectedTextColor()

void QQuickTextEdit::setSelectedTextColor ( const QColor & c )

Definition at line 822 of file qquicktextedit.cpp.

◆ setSelectionColor()

void QQuickTextEdit::setSelectionColor ( const QColor & c )

Definition at line 800 of file qquicktextedit.cpp.

◆ setTabStopDistance()

void QQuickTextEdit::setTabStopDistance ( qreal distance )

Definition at line 3780 of file qquicktextedit.cpp.

◆ setText()

void QQuickTextEdit::setText ( const QString & text )

\qmlproperty string QtQuick::TextEdit::font.family

Sets the family name of the font.

The family name is case insensitive and may optionally include a foundry name, e.g. "Helvetica [Cronyx]". If the family is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the font matching algorithm.

\qmlproperty string QtQuick::TextEdit::font.styleName

Since: 5.6

Sets the style name of the font.

The style name is case insensitive. If set, the font will be matched against style name instead of the font properties \l font.weight, \l font.bold and \l font.italic.

\qmlproperty bool QtQuick::TextEdit::font.bold

Sets whether the font weight is bold.

\qmlproperty int QtQuick::TextEdit::font.weight

The requested weight of the font. The weight requested must be an integer between 1 and 1000, or one of the predefined values:

\value Font.Thin 100 \value Font.ExtraLight 200 \value Font.Light 300 \value Font.Normal 400 (default) \value Font.Medium 500 \value Font.DemiBold 600 \value Font.Bold 700 \value Font.ExtraBold 800 \value Font.Black 900

\qml TextEdit { text: "Hello"; font.weight: Font.DemiBold } \endqml

\qmlproperty bool QtQuick::TextEdit::font.italic

Sets whether the font has an italic style.

\qmlproperty bool QtQuick::TextEdit::font.underline

Sets whether the text is underlined.

\qmlproperty bool QtQuick::TextEdit::font.strikeout

Sets whether the font has a strikeout style.

\qmlproperty real QtQuick::TextEdit::font.pointSize

Sets the font size in points. The point size must be greater than zero.

\qmlproperty int QtQuick::TextEdit::font.pixelSize

Sets the font size in pixels.

Using this function makes the font device dependent. Use \l{TextEdit::font.pointSize} to set the size of the font in a device independent manner.

\qmlproperty real QtQuick::TextEdit::font.letterSpacing

Sets the letter spacing for the font.

Letter spacing changes the default spacing between individual letters in the font. A positive value increases the letter spacing by the corresponding pixels; a negative value decreases the spacing.

\qmlproperty real QtQuick::TextEdit::font.wordSpacing

Sets the word spacing for the font.

Word spacing changes the default spacing between individual words. A positive value increases the word spacing by a corresponding amount of pixels, while a negative value decreases the inter-word spacing accordingly.

\qmlproperty enumeration QtQuick::TextEdit::font.capitalization

Sets the capitalization for the text.

\value Font.MixedCase no capitalization change is applied \value Font.AllUppercase alters the text to be rendered in all uppercase type \value Font.AllLowercase alters the text to be rendered in all lowercase type \value Font.SmallCaps alters the text to be rendered in small-caps type \value Font.Capitalize alters the text to be rendered with the first character of each word as an uppercase character

\qml TextEdit { text: "Hello"; font.capitalization: Font.AllLowercase } \endqml

\qmlproperty enumeration QtQuick::TextEdit::font.hintingPreference

Since: 5.8

Sets the preferred hinting on the text. This is a hint to the underlying text rendering system to use a certain level of hinting, and has varying support across platforms. See the table in the documentation for QFont::HintingPreference for more details.

Note: This property only has an effect when used together with render type TextEdit.NativeRendering.

\value Font.PreferDefaultHinting Use the default hinting level for the target platform. \value Font.PreferNoHinting If possible, render text without hinting the outlines of the glyphs. The text layout will be typographically accurate, using the same metrics as are used e.g. when printing. \value Font.PreferVerticalHinting If possible, render text with no horizontal hinting, but align glyphs to the pixel grid in the vertical direction. The text will appear crisper on displays where the density is too low to give an accurate rendering of the glyphs. But since the horizontal metrics of the glyphs are unhinted, the text's layout will be scalable to higher density devices (such as printers) without impacting details such as line breaks. \value Font.PreferFullHinting If possible, render text with hinting in both horizontal and vertical directions. The text will be altered to optimize legibility on the target device, but since the metrics will depend on the target size of the text, the positions of glyphs, line breaks, and other typographical detail will not scale, meaning that a text layout may look different on devices with different pixel densities.

\qml TextEdit { text: "Hello"; renderType: TextEdit.NativeRendering; font.hintingPreference: Font.PreferVerticalHinting } \endqml

\qmlproperty bool QtQuick::TextEdit::font.kerning

Since: 5.10

Enables or disables the kerning OpenType feature when shaping the text. Disabling this may improve performance when creating or changing the text, at the expense of some cosmetic features. The default value is true.

\qml TextEdit { text: "OATS FLAVOUR WAY"; kerning: font.false } \endqml

\qmlproperty bool QtQuick::TextEdit::font.preferShaping

Since: 5.10

Sometimes, a font will apply complex rules to a set of characters in order to display them correctly. In some writing systems, such as Brahmic scripts, this is required in order for the text to be legible, but in e.g. Latin script, it is merely a cosmetic feature. Setting the preferShaping property to false will disable all such features when they are not required, which will improve performance in most cases.

The default value is true.

\qml TextEdit { text: "Some text"; font.preferShaping: false } \endqml

\qmlproperty object QtQuick::TextEdit::font.variableAxes

Since: 6.7

qml-font-variable-axes

\qmlproperty object QtQuick::TextEdit::font.features

Since: 6.6

qml-font-features

\qmlproperty bool QtQuick::TextEdit::font.contextFontMerging

Since: 6.8

qml-font-context-font-merging

\qmlproperty bool QtQuick::TextEdit::font.preferTypoLineMetrics

Since: 6.8

qml-font-prefer-typo-line-metrics

\qmlproperty string QtQuick::TextEdit::text

The text to display. If the text format is AutoText the text edit will automatically determine whether the text should be treated as rich text. This determination is made using Qt::mightBeRichText(). However, detection of Markdown is not automatic.

The text-property is mostly suitable for setting the initial content and handling modifications to relatively small text content. The append(), insert() and remove() methods provide more fine-grained control and remarkably better performance for modifying especially large rich text content.

Note that some keyboards use a predictive function. In this case, the text being composed by the input method is not part of this property. The part of the text related to the predictions is underlined and stored in the \l preeditText property.

If you used \l TextDocument::source to load text, you can retrieve the loaded text from this property. In that case, you can then change \l textFormat to do format conversions that will change the value of the text property. For example, if textFormat is RichText or AutoText and you load an HTML file, then set textFormat to MarkdownText afterwards, the text property will contain the conversion from HTML to Markdown.

See also: clear(), preeditText, textFormat

Definition at line 420 of file qquicktextedit.cpp.

◆ setTextFormat()

void QQuickTextEdit::setTextFormat ( TextFormat format )

Definition at line 539 of file qquicktextedit.cpp.

◆ setTextMargin()

void QQuickTextEdit::setTextMargin ( qreal margin )

Definition at line 1633 of file qquicktextedit.cpp.

◆ setTopPadding()

void QQuickTextEdit::setTopPadding ( qreal padding )

Definition at line 3694 of file qquicktextedit.cpp.

◆ setVAlign()

void QQuickTextEdit::setVAlign ( QQuickTextEdit::VAlignment alignment )

Definition at line 1125 of file qquicktextedit.cpp.

◆ setWrapMode()

void QQuickTextEdit::setWrapMode ( WrapMode w )

Definition at line 1163 of file qquicktextedit.cpp.

◆ tabStopDistance()

int QQuickTextEdit::tabStopDistance ( ) const

\qmlproperty real QtQuick::TextEdit::tabStopDistance

Since: 5.10

The default distance, in device units, between tab stops.

See also: QTextOption::setTabStopDistance()

Definition at line 3774 of file qquicktextedit.cpp.

◆ text()

QString QQuickTextEdit::text ( ) const

Definition at line 163 of file qquicktextedit.cpp.

◆ textChanged

void QQuickTextEdit::textChanged ( )

signal

◆ textDocument()

QQuickTextDocument * QQuickTextEdit::textDocument ( )

◆ textFormat()

QQuickTextEdit::TextFormat QQuickTextEdit::textFormat ( ) const

\qmlproperty enumeration QtQuick::TextEdit::textFormat

The way the \l text property should be displayed.

Supported text formats are:

\value TextEdit.PlainText (default) all styling tags are treated as plain text \value TextEdit.AutoText detected via the Qt::mightBeRichText() heuristic or the file format of \l TextDocument::source \value TextEdit.RichText \l {Supported HTML Subset} {a subset of HTML 4} \value TextEdit.MarkdownText \l {https://commonmark.org/help/}{CommonMark} plus the \l {https://guides.github.com/features/mastering-markdown/}{GitHub} extensions for tables and task lists (since 5.14)

The default is TextEdit.PlainText. If the text format is set to TextEdit.AutoText, the text edit will automatically determine whether the text should be treated as rich text. If the \l text property is set, this determination is made using Qt::mightBeRichText(), which can detect the presence of an HTML tag on the first line of text, but cannot distinguish Markdown from plain text. If the \l TextDocument::source property is set, this determination is made from the \l {QMimeDatabase::mimeTypeForFile()}{mime type of the file}.

\table \row

Column {

TextEdit {

font.pointSize: 24

textFormat: TextEdit.AutoText

text: "Hello World!"

}

TextEdit {

font.pointSize: 24

textFormat: TextEdit.RichText

text: "Hello World!"

}

TextEdit {

font.pointSize: 24

textFormat: TextEdit.PlainText

text: "Hello World!"

}

TextEdit {

font.pointSize: 24

textFormat: TextEdit.MarkdownText

text: "**Hello** *World!*"

}

}
\endtable

With TextEdit.MarkdownText, checkboxes that result from using the \l {https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown}{GitHub checkbox extension} are interactively checkable.

If the \l TextDocument::source property is set, changing the textFormat property after loading has the effect of converting from the detected format to the requested format. For example, you can convert between HTML and Markdown. However if either of those "rich" formats is loaded and then you set textFormat to PlainText, the TextEdit will show the raw markup. Thus, suitable bindings (e.g. to a checkable Control) can enable the user to toggle back and forth between "raw" and WYSIWYG editing.

Note

Interactively typing markup or markdown formatting in WYSIWYG mode is not supported; but you can switch to PlainText, make changes, then switch back to the appropriate textFormat.

With Text.MarkdownText, and with the supported subset of HTML, some decorative elements are not rendered as they would be in a web browser: \list

code blocks use the \l {QFontDatabase::FixedFont}{default monospace font} but without a surrounding highlight box
block quotes are indented, but there is no vertical line alongside the quote \endlist

Definition at line 533 of file qquicktextedit.cpp.

◆ textFormatChanged

void QQuickTextEdit::textFormatChanged ( QQuickTextEdit::TextFormat textFormat )

signal

◆ textMargin()

qreal QQuickTextEdit::textMargin ( ) const

\qmlproperty real QtQuick::TextEdit::textMargin

The margin, in pixels, around the text in the TextEdit.

Definition at line 1627 of file qquicktextedit.cpp.

◆ textMarginChanged

void QQuickTextEdit::textMarginChanged ( qreal textMargin )

signal

◆ topPadding()

qreal QQuickTextEdit::topPadding ( ) const

Definition at line 3686 of file qquicktextedit.cpp.

◆ undo

void QQuickTextEdit::undo ( )

slot

\qmlmethod QtQuick::TextEdit::undo()

Undoes the last operation if undo is \l {canUndo}{available}. Deselects any current selection, and updates the selection start to the current cursor position.

Definition at line 2164 of file qquicktextedit.cpp.

◆ updatePaintNode()

QSGNode * QQuickTextEdit::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 = new QSGSimpleRectNode();
        n->setColor(Qt::red);
    }
    n->setRect(boundingRect());
    return n;
}

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 2468 of file qquicktextedit.cpp.

◆ updatePolish()

void QQuickTextEdit::updatePolish ( )

overrideprotectedvirtual

This function should perform any layout as required for this item.

When polish() is called, the scene graph schedules a polish event for this item. When the scene graph is ready to render this item, it calls updatePolish() to do any item layout as required before it renders the next frame.

See also: ensurePolished()

Reimplemented from QQuickItem.

Definition at line 2746 of file qquicktextedit.cpp.

◆ vAlign()

QQuickTextEdit::VAlignment QQuickTextEdit::vAlign ( ) const

Definition at line 1119 of file qquicktextedit.cpp.

◆ verticalAlignmentChanged

void QQuickTextEdit::verticalAlignmentChanged ( QQuickTextEdit::VAlignment alignment )

signal

◆ wrapMode()

QQuickTextEdit::WrapMode QQuickTextEdit::wrapMode ( ) const

\qmlproperty enumeration QtQuick::TextEdit::wrapMode

Set this property to wrap the text to the TextEdit item's width. The text will only wrap if an explicit width has been set.

\value TextEdit.NoWrap (default) no wrapping will be performed. If the text contains insufficient newlines, \l {Item::}{implicitWidth} will exceed a set width. \value TextEdit.WordWrap wrapping is done on word boundaries only. If a word is too long, \l {Item::}{implicitWidth} will exceed a set width. \value TextEdit.WrapAnywhere wrapping is done at any point on a line, even if it occurs in the middle of a word. \value TextEdit.Wrap if possible, wrapping occurs at a word boundary; otherwise it will occur at the appropriate point on the line, even in the middle of a word.

The default is TextEdit.NoWrap. If you set a width, consider using TextEdit.Wrap.

Definition at line 1157 of file qquicktextedit.cpp.

◆ wrapModeChanged

void QQuickTextEdit::wrapModeChanged ( )

signal

Friends And Related Symbol Documentation

◆ QQuickTextDocumentPrivate

friend class QQuickTextDocumentPrivate

friend

Definition at line 415 of file qquicktextedit_p.h.

◆ QQuickTextUtil

friend class QQuickTextUtil

friend

Definition at line 414 of file qquicktextedit_p.h.

Member Data Documentation

◆ length

int QQuickTextEdit::length

QString QQuickTextEdit::preeditText

read

\qmlproperty string QtQuick::TextEdit::preeditText \readonly

Since: 5.7

This property contains partial text input from an input method.

To turn off partial text that results from predictions, set the Qt.ImhNoPredictiveText flag in inputMethodHints.

See also: inputMethodHints

Definition at line 45 of file qquicktextedit_p.h.

◆ textDocument

QQuickTextDocument * QQuickTextEdit::textDocument

read

\qmlproperty TextDocument QtQuick::TextEdit::textDocument

Since: 5.1

Returns the QQuickTextDocument of this TextEdit. Since Qt 6.7, it has features for loading and saving files. It can also be used in C++ as a means of accessing the underlying QTextDocument instance, for example to install a \l QSyntaxHighlighter.

See also: QQuickTextDocument

Definition at line 83 of file qquicktextedit_p.h.

◆ textFormat

TextFormat QQuickTextEdit::textFormat

readwrite

Definition at line 60 of file qquicktextedit_p.h.

◆ textMargin

qreal QQuickTextEdit::textMargin

readwrite

Definition at line 72 of file qquicktextedit_p.h.

◆ topPadding

qreal QQuickTextEdit::topPadding

readwrite

Definition at line 86 of file qquicktextedit_p.h.

◆ verticalAlignment

VAlignment QQuickTextEdit::verticalAlignment

readwrite

Definition at line 52 of file qquicktextedit_p.h.

◆ wrapMode

WrapMode QQuickTextEdit::wrapMode

readwrite

Definition at line 53 of file qquicktextedit_p.h.

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

qtdeclarative/src/quick/items/qquicktextedit_p.h (82971e75b8e55ea14b6cbdb77ba6f280cd0c7bd5)
qtdeclarative/src/quick/items/qquicktextedit.cpp (adde115d717af6aad6c8d3a2dd2885047567c07e)

Public Types

Public Slots

Signals

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ HAlignment

◆ RenderType

◆ SelectionMode

◆ TextFormat

◆ VAlignment

◆ WrapMode

Constructor & Destructor Documentation

◆ QQuickTextEdit() [1/2]

◆ ~QQuickTextEdit()

◆ QQuickTextEdit() [2/2]

Member Function Documentation

◆ activeFocusOnPressChanged

◆ baseUrl()

◆ baseUrlChanged

◆ bottomPadding()

◆ boundingRect()

◆ canPaste()

◆ canPasteChanged

◆ canRedo()

◆ canRedoChanged

◆ canUndo()

◆ canUndoChanged

◆ clipRect()

◆ color()

◆ colorChanged

◆ componentComplete()

◆ contentHeight()

◆ contentSizeChanged

◆ contentWidth()

◆ cursorDelegate()

◆ cursorDelegateChanged

◆ cursorPosition()

◆ cursorPositionChanged

◆ cursorRectangle()

◆ cursorRectangleChanged

◆ cursorSelection()

◆ cursorVisibleChanged

◆ deselect

◆ effectiveHAlign()

◆ effectiveHorizontalAlignmentChanged

◆ event()

◆ focusInEvent()

◆ focusOnPress()

◆ focusOutEvent()

◆ font()

◆ fontChanged

◆ geometryChange()

◆ getFormattedText()

◆ getText()

◆ hAlign()

◆ horizontalAlignmentChanged

◆ hoveredLink()

◆ hoverEnterEvent()

◆ hoverLeaveEvent()

◆ hoverMoveEvent()

◆ inputMethodComposingChanged

◆ inputMethodHints()

◆ inputMethodHintsChanged

◆ insert

◆ invalidate()

◆ isCursorVisible()

◆ isInputMethodComposing()

◆ isReadOnly()

◆ isRightToLeft

◆ itemChange()

◆ keyPressEvent()

◆ keyReleaseEvent()

◆ leftPadding()

◆ length()