\qmltype TextDocument \instantiates QQuickTextDocument \inqmlmodule QtQuick More...

#include <qquicktextdocument.h>

Inheritance diagram for QQuickTextDocument:

Collaboration diagram for QQuickTextDocument:

Public Types
enum class	Status : quint8 { Null = 0 , Loading , Loaded , Saving , Saved , ReadError , WriteError , NonLocalFileError }

Signals
	Q_REVISION (6, 7) void textDocumentChanged()

	Q_REVISION (6, 7) void sourceChanged()

	Q_REVISION (6, 7) void modifiedChanged()

	Q_REVISION (6, 7) void statusChanged()

	Q_REVISION (6, 7) void errorStringChanged()

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
	QQuickTextDocument (QQuickItem *parent)
	Constructs a QQuickTextDocument object with parent as the parent object.

QUrl	source () const
	\qmlproperty url QtQuick::TextDocument::source

void	setSource (const QUrl &url)

bool	isModified () const
	\qmlproperty bool QtQuick::TextDocument::modified

void	setModified (bool modified)

QTextDocument *	textDocument () const
	Returns a pointer to the QTextDocument object.

void	setTextDocument (QTextDocument *document)
	Sets the given document.

	Q_REVISION (6, 7) Q_INVOKABLE void save()

	Q_REVISION (6, 7) Q_INVOKABLE void saveAs(const QUrl &url)

Status	status () const
	\qmlproperty enumeration QtQuick::TextDocument::status \readonly

QString	errorString () const
	\qmlproperty string QtQuick::TextDocument::errorString \readonly

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
QUrl	source
	the URL from which to load document contents

bool	modified
	whether the document has been modified by the user

Status	status
	the status of document loading or saving

QString	errorString
	a human-readable string describing the error that occurred during loading or saving, if any

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

\qmltype TextDocument \instantiates QQuickTextDocument \inqmlmodule QtQuick

A wrapper around TextEdit's backing QTextDocument. \preliminary

To load text into the document, set the \l source property. If the user then modifies the text and wants to save the same document, call \l save() to save it to the same source again (only if \l {QUrl::isLocalFile()}{it's a local file}). Or call \l saveAs() to save it to a different file.

This class cannot be instantiated in QML, but is available from \l TextEdit::textDocument.

Note: All loading and saving is done synchronously for now. This may block the UI if the \l source is a slow network drive. This may be improved in future versions of Qt.; This API is considered tech preview and may change in future versions of Qt.

Since: 5.1

The QQuickTextDocument class provides access to the QTextDocument of QQuickTextEdit. \inmodule QtQuick

This class provides access to the QTextDocument of QQuickTextEdit elements. This is provided to allow usage of the \l{Rich Text Processing} functionalities of Qt, including document modifications. It can also be used to output content, for example with \l{QTextDocumentWriter}, or provide additional formatting, for example with \l{QSyntaxHighlighter}.

Definition at line 13 of file qquicktextdocument.h.

Member Enumeration Documentation

◆ Status

enum class QQuickTextDocument::Status : quint8

strong

Enumerator
Null
Loading
Loaded
Saving
Saved
ReadError
WriteError
NonLocalFileError

Definition at line 26 of file qquicktextdocument.h.

Constructor & Destructor Documentation

◆ QQuickTextDocument()

QQuickTextDocument::QQuickTextDocument ( QQuickItem * parent )

Constructs a QQuickTextDocument object with parent as the parent object.

Definition at line 61 of file qquicktextdocument.cpp.

References connect(), d, QTextDocument::modificationChanged(), and Q_ASSERT.

Here is the call graph for this function:

Member Function Documentation

◆ errorString()

QString QQuickTextDocument::errorString ( ) const

\qmlproperty string QtQuick::TextDocument::errorString \readonly

Since: 6.7 \preliminary

This property holds a human-readable string describing the error that occurred during loading or saving, if any; otherwise, an empty string.

See also: status, source, save(), saveAs()

Definition at line 169 of file qquicktextdocument.cpp.

References d.

◆ isModified()

bool QQuickTextDocument::isModified ( ) const

\qmlproperty bool QtQuick::TextDocument::modified

Since: 6.7 \preliminary

This property holds whether the document has been modified by the user since the last time it was loaded or saved. By default, this property is false.

As with \l QTextDocument::modified, you can set the modified property: for example, set it to false to allow setting the \l source property to a different URL (thus discarding the user's changes).

See also: QTextDocument::modified

Definition at line 284 of file qquicktextdocument.cpp.

References textDocument().

Referenced by setSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Q_REVISION() [1/7]

QQuickTextDocument::Q_REVISION	(	6	,
		7	)

◆ Q_REVISION() [2/7]

QQuickTextDocument::Q_REVISION	(	6	,
		7	) const &

◆ Q_REVISION [3/7]

QQuickTextDocument::Q_REVISION	(	6	,
		7	)

signal

◆ Q_REVISION [4/7]

QQuickTextDocument::Q_REVISION	(	6	,
		7	)

signal

◆ Q_REVISION [5/7]

QQuickTextDocument::Q_REVISION	(	6	,
		7	)

signal

◆ Q_REVISION [6/7]

QQuickTextDocument::Q_REVISION	(	6	,
		7	)

signal

◆ Q_REVISION [7/7]

QQuickTextDocument::Q_REVISION	(	6	,
		7	)

signal

◆ setModified()

void QQuickTextDocument::setModified ( bool modified )

Definition at line 290 of file qquicktextdocument.cpp.

References modified, and textDocument().

Here is the call graph for this function:

◆ setSource()

void QQuickTextDocument::setSource ( const QUrl & url )

Definition at line 234 of file qquicktextdocument.cpp.

References d, emit, isModified(), qmlWarning(), url, and QUrl::url().

Here is the call graph for this function:

◆ setTextDocument()

void QQuickTextDocument::setTextDocument ( QTextDocument * document )

Sets the given document.

Since: 6.7

The caller retains ownership of the document.

Definition at line 475 of file qquicktextdocument.cpp.

◆ source()

QUrl QQuickTextDocument::source ( ) const

\qmlproperty url QtQuick::TextDocument::source

Since: 6.7 \preliminary

QQuickTextDocument can handle any text format supported by Qt, loaded from any URL scheme supported by Qt.

The URL may be absolute, or relative to the URL of the component.

The source property cannot be changed while the document's \l modified state is true. If the user has modified the document contents, you should prompt the user whether to \l save(), or else discard changes by setting {modified = false} before setting the \l source property to a different URL.

See also: QTextDocumentWriter::supportedDocumentFormats()

Definition at line 228 of file qquicktextdocument.cpp.

References d.

◆ status()

QQuickTextDocument::Status QQuickTextDocument::status ( ) const

\qmlproperty enumeration QtQuick::TextDocument::status \readonly

Since: 6.7 \preliminary

This property holds the status of document loading or saving. It can be one of:

\value TextDocument.Null No file has been loaded \value TextDocument.Loading Reading from \l source has begun \value TextDocument.Loaded Reading has successfully finished \value TextDocument.Saving File writing has begun after save() or saveAs() \value TextDocument.Saved Writing has successfully finished \value TextDocument.ReadError An error occurred while reading from \l source \value TextDocument.WriteError An error occurred in save() or saveAs() \value TextDocument.NonLocalFileError saveAs() was called with a URL pointing to a remote resource rather than a local file

Use this status to provide an update or respond to the status change in some way. For example, you could:

\list

Trigger a state change: \qml State { name: 'loaded' when: textEdit.textDocument.status == textEdit.textDocument.Loaded } \endqml

Implement an onStatusChanged signal handler: \qml TextEdit { onStatusChanged: { if (textDocument.status === textDocument.Loaded) console.log('Loaded') } } \endqml

Bind to the status value:

TextEdit {
    id: edit
    width: 300
    height: 200
    textFormat: TextEdit.MarkdownText
    textDocument.source: "example.md"
    wrapMode: TextEdit.WordWrap
 
    Text {
        anchors {
            bottom: parent.bottom
            right: parent.right
        }
        color: edit.textDocument.status === TextDocument.Loaded ? "darkolivegreen" : "tomato"
        text:
            switch (edit.textDocument.status) {
            case TextDocument.Loading:
                return qsTr("Loading ") + edit.textDocument.source
            case TextDocument.Loaded:
                return qsTr("Loaded ") + edit.textDocument.source
            default:
                return edit.textDocument.errorString
            }
    }
}

\endlist

See also: errorString, source, save(), saveAs()

Definition at line 141 of file qquicktextdocument.cpp.

References d.

◆ textDocument()

QTextDocument * QQuickTextDocument::textDocument ( ) const

Returns a pointer to the QTextDocument object.

Definition at line 463 of file qquicktextdocument.cpp.

References d.

Referenced by isModified(), and setModified().

Here is the caller graph for this function:

Property Documentation

◆ errorString

QQuickTextDocument::errorString

read

a human-readable string describing the error that occurred during loading or saving, if any

Since: 6.7 \preliminary

By default this string is empty.

See also: status, source, save(), saveAs()

Definition at line 19 of file qquicktextdocument.h.

◆ modified

QQuickTextDocument::modified

readwrite

whether the document has been modified by the user

Since: 6.7 \preliminary

This property holds whether the document has been modified by the user since the last time it was loaded or saved. By default, this property is false.

As with \l QTextDocument::modified, you can set the modified property: for example, set it to false to allow setting the \l source property to a different URL (thus discarding the user's changes).

See also: QTextDocument::modified

Definition at line 17 of file qquicktextdocument.h.

Referenced by setModified().

◆ source

QQuickTextDocument::source

readwrite

the URL from which to load document contents

Since: 6.7 \preliminary

QQuickTextDocument can handle any text format supported by Qt, loaded from any URL scheme supported by Qt.

The source property cannot be changed while the document's \l modified state is true. If the user has modified the document contents, you should prompt the user whether to \l save(), or else discard changes by setting \l modified to false before setting the source property to a different URL.

See also: QTextDocumentWriter::supportedDocumentFormats()

Definition at line 16 of file qquicktextdocument.h.

◆ status

QQuickTextDocument::status

read

the status of document loading or saving

Since: 6.7 \preliminary

This property holds the status of document loading or saving. It can be one of:

\value Null No file has been loaded \value Loading Reading from \l source has begun \value Loaded Reading has successfully finished \value Saving File writing has begun after save() or saveAs() \value Saved Writing has successfully finished \value ReadError An error occurred while reading from \l source \value WriteError An error occurred in save() or saveAs() \value NonLocalFileError saveAs() was called with a URL pointing to a remote resource rather than a local file

See also: errorString, source, save(), saveAs()

Definition at line 18 of file qquicktextdocument.h.

Referenced by QQuickTextEditPrivate::onDocumentStatusChanged().

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

qtdeclarative/src/quick/items/qquicktextdocument.h (d063437539d84c6c9d2a1fdde8184d19d2887395)
qtdeclarative/src/quick/items/qquicktextdocument.cpp (4949768067cfc8a16c0cef958928e94147842bb8)

Public Types

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Status

Constructor & Destructor Documentation

◆ QQuickTextDocument()

Member Function Documentation

◆ errorString()

◆ isModified()

◆ 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]

◆ setModified()

◆ setSource()

◆ setTextDocument()

◆ source()

◆ status()

◆ textDocument()

Property Documentation

◆ errorString

◆ modified

◆ source

◆ status