#include <qquicktextcontrol_p.h>

Inheritance diagram for QQuickTextControl:

Collaboration diagram for QQuickTextControl:

Public Slots
void	setPlainText (const QString &text)
void	setMarkdownText (const QString &text)
void	setHtml (const QString &text)
void	undo ()
void	redo ()
void	clear ()
void	selectAll ()
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	textChanged ()
void	preeditTextChanged ()
void	contentsChange (int from, int charsRemoved, int charsAdded)
void	undoAvailable (bool b)
void	redoAvailable (bool b)
void	currentCharFormatChanged (const QTextCharFormat &format)
void	copyAvailable (bool b)
void	selectionChanged ()
void	cursorPositionChanged ()
void	overwriteModeChanged (bool overwriteMode)
void	updateCursorRequest ()
void	updateRequest ()
void	cursorRectangleChanged ()
void	linkActivated (const QString &link)
void	linkHovered (const QString &link)
void	markerClicked ()
void	markerHovered (bool marker)
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
	QQuickTextControl (QTextDocument doc, QObject parent=nullptr)
virtual	~QQuickTextControl ()
QTextDocument *	document () const
void	setDocument (QTextDocument *doc)
void	setTextCursor (const QTextCursor &cursor)
QTextCursor	textCursor () const
void	setTextInteractionFlags (Qt::TextInteractionFlags flags)
Qt::TextInteractionFlags	textInteractionFlags () const
QString	toPlainText () const
bool	hasImState () const
bool	overwriteMode () const
void	setOverwriteMode (bool overwrite)
bool	cursorVisible () const
void	setCursorVisible (bool visible)
QRectF	anchorRect () const
QRectF	cursorRect (const QTextCursor &cursor) const
QRectF	cursorRect () const
QRectF	selectionRect (const QTextCursor &cursor) const
QRectF	selectionRect () const
QString	hoveredLink () const
QString	anchorAt (const QPointF &pos) const
QTextBlock	blockWithMarkerAt (const QPointF &pos) const
void	setCursorWidth (int width)
void	setAcceptRichText (bool accept)
void	moveCursor (QTextCursor::MoveOperation op, QTextCursor::MoveMode mode=QTextCursor::MoveAnchor)
bool	canPaste () const
void	setCursorIsFocusIndicator (bool b)
void	setWordSelectionEnabled (bool enabled)
void	updateCursorRectangle (bool force)
virtual int	hitTest (const QPointF &point, Qt::HitTestAccuracy accuracy) const
virtual QRectF	blockBoundingRect (const QTextBlock &block) const
QString	preeditText () const
virtual void	processEvent (QEvent *e, const QTransform &transform)
void	processEvent (QEvent *e, const QPointF &coordinateOffset=QPointF())
virtual QMimeData *	createMimeDataFromSelection () const
virtual bool	canInsertFromMimeData (const QMimeData *source) const
virtual void	insertFromMimeData (const QMimeData *source)
bool	cursorOn () const
bool	isBeingEdited ()
Public Member Functions inherited from QInputControl
	QInputControl (Type type, QObject *parent=nullptr)
bool	isAcceptableInput (const QKeyEvent *event) const
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	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`.

Protected Member Functions
void	timerEvent (QTimerEvent *e) override
	This event handler can be reimplemented in a subclass to receive timer events for the object.
bool	event (QEvent *e) override
	This virtual function receives events to an object and should return true if the event e was recognized and processed.
Protected Member Functions inherited from QInputControl
	QInputControl (Type type, QObjectPrivate &dd, QObject *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	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)

Additional Inherited Members
Public Types inherited from QInputControl
enum	Type { LineEdit , TextEdit }
Static Public Member Functions inherited from QInputControl
static bool	isCommonTextEditShortcut (const QKeyEvent *ke)
static QVariant	selectionWrapper (QMimeData *mimeData)
static QMimeData *	mimeDataForInputEvent (QInputMethodEvent *event)
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
Properties inherited from QObject
QString	objectName
	the name of this object
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 41 of file qquicktextcontrol_p.h.

Constructor & Destructor Documentation

◆ QQuickTextControl()

QQuickTextControl::QQuickTextControl	(	QTextDocument *	doc,
		QObject *	parent = nullptr )

explicit

Definition at line 585 of file qquicktextcontrol.cpp.

◆ ~QQuickTextControl()

QQuickTextControl::~QQuickTextControl ( )

virtual

Definition at line 591 of file qquicktextcontrol.cpp.

Member Function Documentation

◆ anchorAt()

QString QQuickTextControl::anchorAt ( const QPointF & pos ) const

Definition at line 1605 of file qquicktextcontrol.cpp.

◆ anchorRect()

QRectF QQuickTextControl::anchorRect ( ) const

Definition at line 1573 of file qquicktextcontrol.cpp.

◆ blockBoundingRect()

QRectF QQuickTextControl::blockBoundingRect ( const QTextBlock & block ) const

virtual

Definition at line 1873 of file qquicktextcontrol.cpp.

◆ blockWithMarkerAt()

QTextBlock QQuickTextControl::blockWithMarkerAt ( const QPointF & pos ) const

Definition at line 1611 of file qquicktextcontrol.cpp.

◆ canInsertFromMimeData()

bool QQuickTextControl::canInsertFromMimeData ( const QMimeData * source ) const

virtual

Definition at line 1675 of file qquicktextcontrol.cpp.

◆ canPaste()

bool QQuickTextControl::canPaste ( ) const

Definition at line 1635 of file qquicktextcontrol.cpp.

◆ clear

void QQuickTextControl::clear ( )

slot

Definition at line 578 of file qquicktextcontrol.cpp.

◆ contentsChange

void QQuickTextControl::contentsChange	(	int	from,
		int	charsRemoved,
		int	charsAdded )

signal

◆ copyAvailable

void QQuickTextControl::copyAvailable ( bool b )

signal

◆ createMimeDataFromSelection()

QMimeData * QQuickTextControl::createMimeDataFromSelection ( ) const

virtual

Definition at line 1668 of file qquicktextcontrol.cpp.

◆ currentCharFormatChanged

void QQuickTextControl::currentCharFormatChanged ( const QTextCharFormat & format )

signal

◆ cursorOn()

bool QQuickTextControl::cursorOn ( ) const

Definition at line 1861 of file qquicktextcontrol.cpp.

◆ cursorPositionChanged

void QQuickTextControl::cursorPositionChanged ( )

signal

◆ cursorRect() [1/2]

QRectF QQuickTextControl::cursorRect ( ) const

Definition at line 1593 of file qquicktextcontrol.cpp.

◆ cursorRect() [2/2]

QRectF QQuickTextControl::cursorRect ( const QTextCursor & cursor ) const

Definition at line 1584 of file qquicktextcontrol.cpp.

◆ cursorRectangleChanged

void QQuickTextControl::cursorRectangleChanged ( )

signal

◆ cursorVisible()

bool QQuickTextControl::cursorVisible ( ) const

Definition at line 1559 of file qquicktextcontrol.cpp.

◆ document()

QTextDocument * QQuickTextControl::document ( ) const

Definition at line 595 of file qquicktextcontrol.cpp.

◆ event()

bool QQuickTextControl::event ( QEvent * e )

overrideprotectedvirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
    Q_OBJECT
 
public:
    MyClass(QWidget *parent = nullptr);
    ~MyClass();
 
    bool event(QEvent* ev) override
    {
        if (ev->type() == QEvent::PolishRequest) {
            // overwrite handling of PolishRequest if any
            doThings();
            return true;
        } else  if (ev->type() == QEvent::Show) {
            // complement handling of Show if any
            doThings2();
            QWidget::event(ev);
            return true;
        }
        // Make sure the rest of events are handled
        return QWidget::event(ev);
    }
};

See also: installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 768 of file qquicktextcontrol.cpp.

◆ hasImState()

bool QQuickTextControl::hasImState ( ) const

Definition at line 1538 of file qquicktextcontrol.cpp.

◆ hitTest()

int QQuickTextControl::hitTest	(	const QPointF &	point,
		Qt::HitTestAccuracy	accuracy ) const

virtual

Definition at line 1867 of file qquicktextcontrol.cpp.

◆ hoveredLink()

QString QQuickTextControl::hoveredLink ( ) const

Definition at line 1599 of file qquicktextcontrol.cpp.

◆ insertFromMimeData()

void QQuickTextControl::insertFromMimeData ( const QMimeData * source )

virtual

Definition at line 1687 of file qquicktextcontrol.cpp.

◆ isBeingEdited()

bool QQuickTextControl::isBeingEdited ( )

Definition at line 773 of file qquicktextcontrol.cpp.

◆ linkActivated

void QQuickTextControl::linkActivated ( const QString & link )

signal

◆ linkHovered

void QQuickTextControl::linkHovered ( const QString & link )

signal

◆ markerClicked

void QQuickTextControl::markerClicked ( )

signal

◆ markerHovered

void QQuickTextControl::markerHovered ( bool marker )

signal

◆ moveCursor()

void QQuickTextControl::moveCursor	(	QTextCursor::MoveOperation	op,
		QTextCursor::MoveMode	mode = QTextCursor::MoveAnchor )

Definition at line 1623 of file qquicktextcontrol.cpp.

◆ overwriteMode()

bool QQuickTextControl::overwriteMode ( ) const

Definition at line 1544 of file qquicktextcontrol.cpp.

◆ overwriteModeChanged

void QQuickTextControl::overwriteModeChanged ( bool overwriteMode )

signal

◆ preeditText()

QString QQuickTextControl::preeditText ( ) const

Definition at line 1879 of file qquicktextcontrol.cpp.

◆ preeditTextChanged

void QQuickTextControl::preeditTextChanged ( )

signal

◆ processEvent() [1/2]

void QQuickTextControl::processEvent	(	QEvent *	e,
		const QPointF &	coordinateOffset = QPointF() )

Definition at line 703 of file qquicktextcontrol.cpp.

◆ processEvent() [2/2]

void QQuickTextControl::processEvent	(	QEvent *	e,
		const QTransform &	transform )

virtual

Definition at line 710 of file qquicktextcontrol.cpp.

◆ redo

void QQuickTextControl::redo ( )

slot

Definition at line 567 of file qquicktextcontrol.cpp.

◆ redoAvailable

void QQuickTextControl::redoAvailable ( bool b )

signal

◆ selectAll

void QQuickTextControl::selectAll ( )

slot

Definition at line 693 of file qquicktextcontrol.cpp.

◆ selectionChanged

void QQuickTextControl::selectionChanged ( )

signal

◆ selectionRect() [1/2]

QRectF QQuickTextControl::selectionRect ( ) const

◆ selectionRect() [2/2]

QRectF QQuickTextControl::selectionRect ( const QTextCursor & cursor ) const

◆ setAcceptRichText()

void QQuickTextControl::setAcceptRichText ( bool accept )

Definition at line 1617 of file qquicktextcontrol.cpp.

◆ setCursorIsFocusIndicator()

void QQuickTextControl::setCursorIsFocusIndicator ( bool b )

Definition at line 1647 of file qquicktextcontrol.cpp.

◆ setCursorVisible()

void QQuickTextControl::setCursorVisible ( bool visible )

Definition at line 1565 of file qquicktextcontrol.cpp.

◆ setCursorWidth()

void QQuickTextControl::setCursorWidth ( int width )

◆ setDocument()

void QQuickTextControl::setDocument ( QTextDocument * doc )

Definition at line 601 of file qquicktextcontrol.cpp.

◆ setHtml

void QQuickTextControl::setHtml ( const QString & text )

slot

Definition at line 801 of file qquicktextcontrol.cpp.

◆ setMarkdownText

void QQuickTextControl::setMarkdownText ( const QString & text )

slot

Definition at line 795 of file qquicktextcontrol.cpp.

◆ setOverwriteMode()

void QQuickTextControl::setOverwriteMode ( bool overwrite )

Definition at line 1550 of file qquicktextcontrol.cpp.

◆ setPlainText

void QQuickTextControl::setPlainText ( const QString & text )

slot

Definition at line 789 of file qquicktextcontrol.cpp.

◆ setTextCursor()

void QQuickTextControl::setTextCursor ( const QTextCursor & cursor )

Definition at line 641 of file qquicktextcontrol.cpp.

◆ setTextInteractionFlags()

void QQuickTextControl::setTextInteractionFlags ( Qt::TextInteractionFlags flags )

Definition at line 1825 of file qquicktextcontrol.cpp.

◆ setWordSelectionEnabled()

void QQuickTextControl::setWordSelectionEnabled ( bool enabled )

Definition at line 1654 of file qquicktextcontrol.cpp.

◆ textChanged

void QQuickTextControl::textChanged ( )

signal

◆ textCursor()

QTextCursor QQuickTextControl::textCursor ( ) const

Definition at line 659 of file qquicktextcontrol.cpp.

◆ textInteractionFlags()

Qt::TextInteractionFlags QQuickTextControl::textInteractionFlags ( ) const

Definition at line 1836 of file qquicktextcontrol.cpp.

◆ timerEvent()

void QQuickTextControl::timerEvent ( QTimerEvent * event )

overrideprotectedvirtual

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

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

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

Reimplemented from QObject.

Definition at line 779 of file qquicktextcontrol.cpp.

◆ toPlainText()

QString QQuickTextControl::toPlainText ( ) const

Definition at line 1842 of file qquicktextcontrol.cpp.

◆ undo

void QQuickTextControl::undo ( )

slot

Definition at line 556 of file qquicktextcontrol.cpp.

◆ undoAvailable

void QQuickTextControl::undoAvailable ( bool b )

signal

◆ updateCursorRectangle()

void QQuickTextControl::updateCursorRectangle ( bool force )

Definition at line 632 of file qquicktextcontrol.cpp.

◆ updateCursorRequest

void QQuickTextControl::updateCursorRequest ( )

signal

◆ updateRequest

void QQuickTextControl::updateRequest ( )

signal

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

qtdeclarative/src/quick/items/qquicktextcontrol_p.h (01cd43d30e3ca2c4dd94a4a4711604adb9417517)
qtdeclarative/src/quick/items/qquicktextcontrol.cpp (1aefea26e5a574dad25646d330a6b3bb943a596c)

Public Slots

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickTextControl()

◆ ~QQuickTextControl()

Member Function Documentation

◆ anchorAt()

◆ anchorRect()

◆ blockBoundingRect()

◆ blockWithMarkerAt()

◆ canInsertFromMimeData()

◆ canPaste()

◆ clear

◆ contentsChange

◆ copyAvailable

◆ createMimeDataFromSelection()

◆ currentCharFormatChanged

◆ cursorOn()

◆ cursorPositionChanged

◆ cursorRect() [1/2]

◆ cursorRect() [2/2]

◆ cursorRectangleChanged

◆ cursorVisible()

◆ document()

◆ event()

◆ hasImState()

◆ hitTest()

◆ hoveredLink()

◆ insertFromMimeData()

◆ isBeingEdited()

◆ linkActivated

◆ linkHovered

◆ markerClicked

◆ markerHovered

◆ moveCursor()

◆ overwriteMode()

◆ overwriteModeChanged

◆ preeditText()

◆ preeditTextChanged

◆ processEvent() [1/2]

◆ processEvent() [2/2]

◆ redo

◆ redoAvailable

◆ selectAll

◆ selectionChanged

◆ selectionRect() [1/2]

◆ selectionRect() [2/2]

◆ setAcceptRichText()

◆ setCursorIsFocusIndicator()

◆ setCursorVisible()

◆ setCursorWidth()

◆ setDocument()

◆ setHtml

◆ setMarkdownText

◆ setOverwriteMode()

◆ setPlainText

◆ setTextCursor()

◆ setTextInteractionFlags()

◆ setWordSelectionEnabled()

◆ textChanged

◆ textCursor()

◆ textInteractionFlags()

◆ timerEvent()

◆ toPlainText()

◆ undo

◆ undoAvailable

◆ updateCursorRectangle()

◆ updateCursorRequest

◆ updateRequest