#include <qquicktextselection_p.h>

Inheritance diagram for QQuickTextSelection:

Collaboration diagram for QQuickTextSelection:

Public Types
enum	MoveOperation { NoMove = QTextCursor::NoMove , Start , Up , StartOfLine , StartOfBlock , StartOfWord , PreviousBlock , PreviousCharacter , PreviousWord , Left , WordLeft , End , Down , EndOfLine , EndOfWord , EndOfBlock , NextBlock , NextCharacter , NextWord , Right , WordRight , NextCell , PreviousCell , NextRow , PreviousRow }

Signals
	Q_REVISION (6, 11) void documentChanged()
	Q_REVISION (6, 11) void selectionStartChanged()
	Q_REVISION (6, 11) void selectionEndChanged()
void	textChanged ()
void	fontChanged ()
void	colorChanged ()
void	alignmentChanged ()
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
	Q_ENUM (MoveOperation)
	QQuickTextSelection (QObject *parent=nullptr)
	\qmltype TextSelection \nativetype QQuickTextSelection \inqmlmodule QtQuick
void	classBegin () override
	Invoked after class creation, but before any properties have been set.
void	componentComplete () override
	Invoked after the root component that caused this instantiation has completed construction.
QQuickTextDocument *	document () const
void	setDocument (QQuickTextDocument *doc)
int	selectionStart () const
void	setSelectionStart (int start)
int	selectionEnd () const
void	setSelectionEnd (int end)
QString	text () const
	\qmlproperty string QtQuick::TextSelection::text
void	setText (const QString &text)
QFont	font () const
	\qmlproperty color QtQuick::TextSelection::font
void	setFont (const QFont &font)
QColor	color () const
	\qmlproperty color QtQuick::TextSelection::color
void	setColor (QColor color)
Qt::Alignment	alignment () const
	\qmlproperty enumeration QtQuick::TextSelection::alignment
void	setAlignment (Qt::Alignment align)
	Q_REVISION (6, 11) Q_INVOKABLE bool moveSelectionStart(MoveOperation op
	Q_REVISION (6, 11) Q_INVOKABLE bool moveSelectionEnd(MoveOperation op
	Q_REVISION (6, 11) Q_INVOKABLE void duplicate()
	Q_REVISION (6, 11) Q_INVOKABLE void linkTo(const QUrl &destination)
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	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
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	isQmlObjectType () const
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.
bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
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 Attributes
int	n = 1)

Properties
QQuickTextDocument *	document
int	selectionStart
int	selectionEnd
QString	text
QFont	font
QColor	color
Qt::Alignment	alignment
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe
static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe
static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.
template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)
template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)
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)
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 32 of file qquicktextselection_p.h.

Member Enumeration Documentation

◆ MoveOperation

enum QQuickTextSelection::MoveOperation

Enumerator
NoMove
Start
Up
StartOfLine
StartOfBlock
StartOfWord
PreviousBlock
PreviousCharacter
PreviousWord
Left
WordLeft
End
Down
EndOfLine
EndOfWord
EndOfBlock
NextBlock
NextCharacter
NextWord
Right
WordRight
NextCell
PreviousCell
NextRow
PreviousRow

Definition at line 54 of file qquicktextselection_p.h.

Constructor & Destructor Documentation

◆ QQuickTextSelection()

QT_BEGIN_NAMESPACE QQuickTextSelection::QQuickTextSelection ( QObject * parent = nullptr )

explicit

\qmltype TextSelection \nativetype QQuickTextSelection \inqmlmodule QtQuick

Represents a contiguous selection of text and its properties.

Since: 6.7

\l {QtQuick::TextEdit::cursorSelection}{TextEdit.cursorSelection} represents the range of text that is currently selected (for example by dragging the mouse). It can be used to query and modify the selected text, as well as properties in the \l {QTextCharFormat}{character} and \l {QTextBlockFormat}{block} formats.

Additionally, since 6.11 it's possible to create explicit non-visual instances:

\qml TextEdit { id: textEdit

TextSelection { id: sel1 } } \endqml

TextEdit.cursorSelection and any explicit TextSelection instances can be used to query and modify the specified ranges of text, as well as properties in the \l {QTextCharFormat}{character} and \l {QTextBlockFormat}{block} formats.

Note: This API is considered tech preview and may change or be removed in future versions of Qt.

See also: TextEdit, QTextCursor

QQuickTextSelection provides QML API using QTextCursor. QQuickTextControl owns a text cursor, and one instance of QQuickTextSelection represents it and delegates all operations to it. But since 6.11, the user can also create other instances of TextSelection in QML for the purpose of programmatic editing; in that case m_control remains null, m_doc is set, QQuickTextSelection owns the QTextCursor, and delegates all operations to it.

Definition at line 61 of file qquicktextselection.cpp.

Member Function Documentation

◆ alignment()

Qt::Alignment QQuickTextSelection::alignment ( ) const

\qmlproperty enumeration QtQuick::TextSelection::alignment

The alignment of the block containing the selected text.

See also: QTextBlockFormat::alignment()

Definition at line 250 of file qquicktextselection.cpp.

◆ alignmentChanged

void QQuickTextSelection::alignmentChanged ( )

signal

◆ classBegin()

void QQuickTextSelection::classBegin ( )

inlineoverridevirtual

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

Implements QQmlParserStatus.

Definition at line 88 of file qquicktextselection_p.h.

◆ color()

QColor QQuickTextSelection::color ( ) const

\qmlproperty color QtQuick::TextSelection::color

The foreground color of the selected text.

See also: QTextCharFormat::foreground()

Definition at line 223 of file qquicktextselection.cpp.

◆ colorChanged

void QQuickTextSelection::colorChanged ( )

signal

◆ componentComplete()

void QQuickTextSelection::componentComplete ( )

overridevirtual

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

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

Implements QQmlParserStatus.

Definition at line 75 of file qquicktextselection.cpp.

◆ document()

QQuickTextDocument * QQuickTextSelection::document ( ) const

Since: 6.11 \qmlproperty TextDocument QtQuick::TextSelection::document

The QQuickTextDocument that contains the selected text.

See also: QtQuick::TextEdit::textDocument

Definition at line 96 of file qquicktextselection.cpp.

◆ font()

QFont QQuickTextSelection::font ( ) const

\qmlproperty color QtQuick::TextSelection::font

The font of the selected text.

See also: QTextCharFormat::font()

Definition at line 196 of file qquicktextselection.cpp.

◆ fontChanged

void QQuickTextSelection::fontChanged ( )

signal

◆ Q_ENUM()

QQuickTextSelection::Q_ENUM ( MoveOperation )

◆ Q_REVISION() [1/7]

QQuickTextSelection::Q_REVISION	(	6	,
		11	)

◆ Q_REVISION() [2/7]

QQuickTextSelection::Q_REVISION	(	6	,
		11	)

◆ Q_REVISION() [3/7]

QQuickTextSelection::Q_REVISION	(	6	,
		11	)

◆ Q_REVISION() [4/7]

QQuickTextSelection::Q_REVISION	(	6	,
		11	) const &

◆ Q_REVISION [5/7]

QQuickTextSelection::Q_REVISION	(	6	,
		11	)

signal

◆ Q_REVISION [6/7]

QQuickTextSelection::Q_REVISION	(	6	,
		11	)

signal

◆ Q_REVISION [7/7]

QQuickTextSelection::Q_REVISION	(	6	,
		11	)

signal

◆ selectionEnd()

int QQuickTextSelection::selectionEnd ( ) const

Since: 6.11 \qmlproperty int QtQuick::TextSelection::selectionEnd

The position after the last character in the selection.

See also: QtQuick::TextEdit::selectionEnd

Definition at line 147 of file qquicktextselection.cpp.

◆ selectionStart()

int QQuickTextSelection::selectionStart ( ) const

Since: 6.11 \qmlproperty int QtQuick::TextSelection::selectionStart

The position before the first character in the selection.

See also: QtQuick::TextEdit::selectionStart

Definition at line 119 of file qquicktextselection.cpp.

◆ setAlignment()

void QQuickTextSelection::setAlignment ( Qt::Alignment align )

Definition at line 255 of file qquicktextselection.cpp.

◆ setColor()

void QQuickTextSelection::setColor ( QColor color )

Definition at line 228 of file qquicktextselection.cpp.

◆ setDocument()

void QQuickTextSelection::setDocument ( QQuickTextDocument * doc )

Definition at line 101 of file qquicktextselection.cpp.

◆ setFont()

void QQuickTextSelection::setFont ( const QFont & font )

Definition at line 201 of file qquicktextselection.cpp.

◆ setSelectionEnd()

void QQuickTextSelection::setSelectionEnd ( int end )

Definition at line 152 of file qquicktextselection.cpp.

◆ setSelectionStart()

void QQuickTextSelection::setSelectionStart ( int start )

Definition at line 124 of file qquicktextselection.cpp.

◆ setText()

void QQuickTextSelection::setText ( const QString & text )

Definition at line 179 of file qquicktextselection.cpp.

◆ text()

QString QQuickTextSelection::text ( ) const

\qmlproperty string QtQuick::TextSelection::text

The selected text, without any rich text markup.

Setting this property replaces the selected text with the given string.

Definition at line 174 of file qquicktextselection.cpp.

◆ textChanged

void QQuickTextSelection::textChanged ( )

signal

Member Data Documentation

◆ n

int QQuickTextSelection::n = 1)

Definition at line 112 of file qquicktextselection_p.h.

Property Documentation

◆ alignment

Qt::Alignment QQuickTextSelection::alignment

readwrite

Definition at line 46 of file qquicktextselection_p.h.

◆ color

QColor QQuickTextSelection::color

readwrite

Definition at line 45 of file qquicktextselection_p.h.

◆ document

QQuickTextDocument * QQuickTextSelection::document

readwrite

Definition at line 38 of file qquicktextselection_p.h.

◆ font

QFont QQuickTextSelection::font

readwrite

Definition at line 44 of file qquicktextselection_p.h.

◆ selectionEnd

int QQuickTextSelection::selectionEnd

readwrite

Definition at line 40 of file qquicktextselection_p.h.

◆ selectionStart

int QQuickTextSelection::selectionStart

readwrite

Definition at line 39 of file qquicktextselection_p.h.

◆ text

QString QQuickTextSelection::text

readwrite

Definition at line 43 of file qquicktextselection_p.h.

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

qtdeclarative/src/quick/util/qquicktextselection_p.h (7f4ba3aece3783bdacc5239a2f3d7c600db62c3e)
qtdeclarative/src/quick/util/qquicktextselection.cpp (7f7c01b9f62ed9a616a33223c6a1fe9eed8d388a)

Public Types

Signals

Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ MoveOperation

Constructor & Destructor Documentation

◆ QQuickTextSelection()

Member Function Documentation

◆ alignment()

◆ alignmentChanged

◆ classBegin()

◆ color()

◆ colorChanged

◆ componentComplete()

◆ document()

◆ font()

◆ fontChanged

◆ Q_ENUM()

◆ Q_REVISION() [1/7]

◆ Q_REVISION() [2/7]

◆ Q_REVISION() [3/7]

◆ Q_REVISION() [4/7]

◆ Q_REVISION [5/7]

◆ Q_REVISION [6/7]

◆ Q_REVISION [7/7]

◆ selectionEnd()

◆ selectionStart()

◆ setAlignment()

◆ setColor()

◆ setDocument()

◆ setFont()

◆ setSelectionEnd()

◆ setSelectionStart()

◆ setText()

◆ text()

◆ textChanged

Member Data Documentation

◆ n

Property Documentation

◆ alignment

◆ color

◆ document

◆ font

◆ selectionEnd

◆ selectionStart

◆ text