KTextDocument Class Reference

#include <KTextDocument.h>

Inheritance diagram for KTextDocument:

Public Member Functions
	KTextDocument (const QString &text, QObject *parent=nullptr)
	KTextDocument (QObject *parent=nullptr)
QSize	minimumSizeHint ()
QSize	sizeHint ()
Public Member Functions inherited from QTextDocument
	QTextDocument (const QString &text, QObject *parent)
	QTextDocument (QObject *parent)
void	addResource (int type, const QUrl &name, const QVariant &resource)
void	adjustSize ()
QList< QTextFormat >	allFormats () const const
int	availableRedoSteps () const const
int	availableUndoSteps () const const
qreal	baselineOffset () const const
QUrl	baseUrl () const const
void	baseUrlChanged (const QUrl &url)
QTextBlock	begin () const const
int	blockCount () const const
void	blockCountChanged (int newBlockCount)
QChar	characterAt (int pos) const const
int	characterCount () const const
virtual void	clear ()
void	clearUndoRedoStacks (Stacks stacksToClear)
QTextDocument *	clone (QObject *parent) const const
void	contentsChange (int position, int charsRemoved, int charsAdded)
void	contentsChanged ()
void	cursorPositionChanged (const QTextCursor &cursor)
Qt::CursorMoveStyle	defaultCursorMoveStyle () const const
QFont	defaultFont () const const
QString	defaultStyleSheet () const const
QTextOption	defaultTextOption () const const
QAbstractTextDocumentLayout *	documentLayout () const const
void	documentLayoutChanged ()
qreal	documentMargin () const const
void	drawContents (QPainter *p, const QRectF &rect)
QTextBlock	end () const const
QTextCursor	find (const QRegularExpression &expr, const QTextCursor &cursor, FindFlags options) const const
QTextCursor	find (const QRegularExpression &expr, int from, FindFlags options) const const
QTextCursor	find (const QString &subString, const QTextCursor &cursor, FindFlags options) const const
QTextCursor	find (const QString &subString, int position, FindFlags options) const const
QTextBlock	findBlock (int pos) const const
QTextBlock	findBlockByLineNumber (int lineNumber) const const
QTextBlock	findBlockByNumber (int blockNumber) const const
QTextBlock	firstBlock () const const
qreal	idealWidth () const const
qreal	indentWidth () const const
bool	isEmpty () const const
bool	isLayoutEnabled () const const
bool	isModified () const const
bool	isRedoAvailable () const const
bool	isUndoAvailable () const const
bool	isUndoRedoEnabled () const const
QTextBlock	lastBlock () const const
int	lineCount () const const
void	markContentsDirty (int position, int length)
int	maximumBlockCount () const const
QString	metaInformation (MetaInformation info) const const
void	modificationChanged (bool changed)
QTextObject *	object (int objectIndex) const const
QTextObject *	objectForFormat (const QTextFormat &f) const const
int	pageCount () const const
QSizeF	pageSize () const const
void	print (QPagedPaintDevice *printer) const const
void	redo ()
void	redo (QTextCursor *cursor)
void	redoAvailable (bool available)
QVariant	resource (int type, const QUrl &name) const const
QTextDocument::ResourceProvider	resourceProvider () const const
int	revision () const const
QTextFrame *	rootFrame () const const
void	setBaselineOffset (qreal baseline)
void	setBaseUrl (const QUrl &url)
void	setDefaultCursorMoveStyle (Qt::CursorMoveStyle style)
void	setDefaultFont (const QFont &font)
void	setDefaultStyleSheet (const QString &sheet)
void	setDefaultTextOption (const QTextOption &option)
void	setDocumentLayout (QAbstractTextDocumentLayout *layout)
void	setDocumentMargin (qreal margin)
void	setHtml (const QString &html)
void	setIndentWidth (qreal width)
void	setLayoutEnabled (bool b)
void	setMarkdown (const QString &markdown, MarkdownFeatures features)
void	setMaximumBlockCount (int maximum)
void	setMetaInformation (MetaInformation info, const QString &string)
void	setModified (bool m)
void	setPageSize (const QSizeF &size)
void	setPlainText (const QString &text)
void	setResourceProvider (const ResourceProvider &provider)
void	setSubScriptBaseline (qreal baseline)
void	setSuperScriptBaseline (qreal baseline)
void	setTextWidth (qreal width)
void	setUndoRedoEnabled (bool enable)
void	setUseDesignMetrics (bool b)
QSizeF	size () const const
qreal	subScriptBaseline () const const
qreal	superScriptBaseline () const const
qreal	textWidth () const const
QString	toHtml () const const
QString	toMarkdown (MarkdownFeatures features) const const
QString	toPlainText () const const
QString	toRawText () const const
void	undo ()
void	undo (QTextCursor *cursor)
void	undoAvailable (bool available)
void	undoCommandAdded ()
bool	useDesignMetrics () const const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QTextDocument
enum	FindFlag
typedef	FindFlags
typedef	MarkdownFeatures
enum	MetaInformation
typedef	ResourceProvider
enum	ResourceType
enum	Stacks
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QTextDocument
	baseUrl
	blockCount
	defaultFont
	defaultStyleSheet
	defaultTextOption
	documentMargin
	indentWidth
	layoutEnabled
	maximumBlockCount
	modified
	pageSize
	size
	textWidth
	undoRedoEnabled
	useDesignMetrics
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QTextDocument
QTextDocument::ResourceProvider	defaultResourceProvider ()
void	setDefaultResourceProvider (const ResourceProvider &provider)
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QTextDocument
	CssMedia
	DocumentTitle
	DocumentUrl
	FindBackward
	FindCaseSensitively
	FindWholeWords
	HtmlResource
	ImageResource
	MarkdownResource
	RedoStack
	StyleSheetResource
	UndoAndRedoStacks
	UndoStack
	UnknownResource
	UserResource
Protected Member Functions inherited from QTextDocument
virtual QTextObject *	createObject (const QTextFormat &format)
virtual QVariant	loadResource (int type, const QUrl &name)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

KTextDocument is an internally used enhanced QTextDocument.

Definition at line 30 of file KTextDocument.h.

Constructor & Destructor Documentation

KTextDocument() [1/2]

KTextDocument::KTextDocument ( QObject * parent = nullptr )

explicit

Definition at line 22 of file KTextDocument.cpp.

KTextDocument() [2/2]

KTextDocument::KTextDocument ( const QString & text, QObject * parent = nullptr )

explicit

Definition at line 31 of file KTextDocument.cpp.

~KTextDocument()

KTextDocument::~KTextDocument ( )

override

Definition at line 40 of file KTextDocument.cpp.

Member Function Documentation

minimumSizeHint()

QSize KTextDocument::minimumSizeHint

(

)

Definition at line 50 of file KTextDocument.cpp.

sizeHint()

QSize KTextDocument::sizeHint

(

)

Definition at line 43 of file KTextDocument.cpp.

---

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

• KTextDocument.h
• KTextDocument.cpp