#include <qquicktextselection_p.h>

Inheritance diagram for QQuickTextSelection:

Collaboration diagram for QQuickTextSelection:

Signals
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
	QQuickTextSelection (QObject *parent=nullptr)
	\qmltype TextSelection \instantiates QQuickTextSelection \inqmlmodule QtQuick

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)

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

Properties
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 31 of file qquicktextselection_p.h.

Constructor & Destructor Documentation

◆ QQuickTextSelection()

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

explicit

\qmltype TextSelection \instantiates 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.

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.

Definition at line 40 of file qquicktextselection.cpp.

References QObject::connect(), QQuickTextControl::currentCharFormatChanged(), QQuickTextControl::cursorPositionChanged(), QQuickTextEditPrivate::get(), QObject::parent(), and textEdit.

Here is the call graph for this function:

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 136 of file qquicktextselection.cpp.

References QTextBlockFormat::alignment(), and QTextCursor::blockFormat().

Here is the call graph for this function:

◆ alignmentChanged

void QQuickTextSelection::alignmentChanged ( )

signal

Referenced by setAlignment().

Here is the caller graph for this function:

◆ color()

QColor QQuickTextSelection::color ( ) const

\qmlproperty color QtQuick::TextSelection::color

The foreground color of the selected text.

See also: QTextCharFormat::foreground()

Definition at line 109 of file qquicktextselection.cpp.

References QTextCursor::charFormat(), QBrush::color(), and QTextFormat::foreground().

Here is the call graph for this function:

◆ colorChanged

void QQuickTextSelection::colorChanged ( )

signal

Referenced by setColor().

Here is the caller graph for this function:

◆ font()

QFont QQuickTextSelection::font ( ) const

\qmlproperty color QtQuick::TextSelection::font

The font of the selected text.

See also: QTextCharFormat::font()

Definition at line 82 of file qquicktextselection.cpp.

References QTextCursor::charFormat(), and QTextCharFormat::font().

Here is the call graph for this function:

◆ fontChanged

void QQuickTextSelection::fontChanged ( )

signal

Referenced by setFont().

Here is the caller graph for this function:

◆ setAlignment()

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

Definition at line 141 of file qquicktextselection.cpp.

References alignment, alignmentChanged(), emit, QTextCursor::mergeBlockFormat(), and QTextBlockFormat::setAlignment().

Here is the call graph for this function:

◆ setColor()

void QQuickTextSelection::setColor ( QColor color )

Definition at line 114 of file qquicktextselection.cpp.

References colorChanged(), emit, fmt, QTextFormat::setForeground(), and QTextCursor::WordUnderCursor.

Here is the call graph for this function:

◆ setFont()

void QQuickTextSelection::setFont ( const QFont & font )

Definition at line 87 of file qquicktextselection.cpp.

References emit, fmt, font, fontChanged(), QTextCharFormat::setFont(), and QTextCursor::WordUnderCursor.

Here is the call graph for this function:

◆ setText()

void QQuickTextSelection::setText ( const QString & text )

Definition at line 65 of file qquicktextselection.cpp.

References emit, text, and textChanged().

Here is the call graph for this function:

◆ 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 60 of file qquicktextselection.cpp.

References QTextCursor::selectedText().

Here is the call graph for this function:

◆ textChanged

void QQuickTextSelection::textChanged ( )

signal

Referenced by setText().

Here is the caller graph for this function:

Property Documentation

◆ alignment

Qt::Alignment QQuickTextSelection::alignment

readwrite

Definition at line 38 of file qquicktextselection_p.h.

Referenced by setAlignment().

◆ color

QColor QQuickTextSelection::color

readwrite

Definition at line 37 of file qquicktextselection_p.h.

◆ font

QFont QQuickTextSelection::font

readwrite

Definition at line 36 of file qquicktextselection_p.h.

Referenced by setFont().

◆ text

QString QQuickTextSelection::text

readwrite

Definition at line 35 of file qquicktextselection_p.h.

Referenced by setText().

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

qtdeclarative/src/quick/util/qquicktextselection_p.h (295953bfc791ee9a4b0660ee72f54c39e35a3973)
qtdeclarative/src/quick/util/qquicktextselection.cpp (295953bfc791ee9a4b0660ee72f54c39e35a3973)

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickTextSelection()

Member Function Documentation

◆ alignment()

◆ alignmentChanged

◆ color()

◆ colorChanged

◆ font()

◆ fontChanged

◆ setAlignment()

◆ setColor()

◆ setFont()

◆ setText()

◆ text()

◆ textChanged

Property Documentation

◆ alignment

◆ color

◆ font

◆ text