QtGui.QTextDocument Class Reference

The QTextDocument class holds formatted text that can be viewed and edited using a QTextEdit. More...

Inheritance diagram for QtGui.QTextDocument:

Collaboration diagram for QtGui.QTextDocument:

Public Types
enum	FindFlag { FindBackward = 1, FindCaseSensitively = 2, FindWholeWords = 4 }
	More...
enum	MetaInformation { DocumentTitle = 0, DocumentUrl = 1 }
	More...
enum	ResourceType { HtmlResource = 1, ImageResource = 2, StyleSheetResource = 3, UserResource = 100 }
	More...
enum	Stacks { RedoStack = 2, UndoAndRedoStacks = 3, UndoStack = 1 }

Public Member Functions
	QTextDocument (QObject parent=null)
	QTextDocument (string text, QObject parent=null)
override void	CreateProxy ()
new void	AddResource (int type, QUrl name, object resource)
new void	AdjustSize ()
new System.Collections.Generic.List < QTextFormat >	AllFormats ()
new void	AppendUndoItem (QAbstractUndoItem arg1)
new int	AvailableRedoSteps ()
new int	AvailableUndoSteps ()
new QTextBlock	Begin ()
new QChar	CharacterAt (int pos)
new int	CharacterCount ()
virtual void	Clear ()
new void	ClearUndoRedoStacks (QTextDocument.Stacks historyToClear=QTextDocument.Stacks.UndoAndRedoStacks)
new QTextDocument	Clone (QObject parent=null)
new double	documentMargin ()
new void	DrawContents (QPainter painter)
new void	DrawContents (QPainter painter, QRectF rect)
new QTextBlock	End ()
new QTextCursor	Find (QRegExp expr, QTextCursor from, QTextDocument.FindFlag options=0)
new QTextCursor	Find (QRegExp expr, int from=0, QTextDocument.FindFlag options=0)
new QTextCursor	Find (string subString, QTextCursor from, QTextDocument.FindFlag options=0)
new QTextCursor	Find (string subString, int from=0, QTextDocument.FindFlag options=0)
new QTextBlock	FindBlock (int pos)
new QTextBlock	FindBlockByLineNumber (int blockNumber)
new QTextBlock	FindBlockByNumber (int blockNumber)
new QTextBlock	FirstBlock ()
new QTextFrame	FrameAt (int pos)
new double	IdealWidth ()
new double	indentWidth ()
new bool	IsEmpty ()
new bool	IsRedoAvailable ()
new bool	IsUndoAvailable ()
new QTextBlock	LastBlock ()
new int	LineCount ()
new void	MarkContentsDirty (int from, int length)
new string	metaInformation (QTextDocument.MetaInformation info)
new QTextObject	Object (int objectIndex)
new QTextObject	ObjectForFormat (QTextFormat arg1)
new int	PageCount ()
new void	Print (QPrinter printer)
new void	Redo ()
new void	Redo (QTextCursor cursor)
new object	Resource (int type, QUrl name)
new int	Revision ()
new QTextFrame	RootFrame ()
new void	SetDocumentMargin (double margin)
new void	SetHtml (string html)
new void	SetIndentWidth (double width)
new void	SetMetaInformation (QTextDocument.MetaInformation info, string arg2)
new void	SetPlainText (string text)
new void	SetTextWidth (double width)
new double	textWidth ()
new string	ToHtml ()
new string	ToHtml (QByteArray encoding)
new string	ToPlainText ()
new void	Undo ()
new void	Undo (QTextCursor cursor)
new void	Dispose ()
Public Member Functions inherited from QtCore.QObject
	QObject (QObject parent=null)
new bool	BlockSignals (bool b)
new System.Collections.Generic.List < QObject >	Children ()
new bool	Connect (QObject sender, string signal, string member, Qt.ConnectionType type=Qt.ConnectionType.AutoConnection)
new void	DeleteLater ()
new bool	Disconnect (QObject receiver, string member=null)
new bool	Disconnect (string signal=null, QObject receiver=null, string member=null)
new void	DumpObjectInfo ()
new void	DumpObjectTree ()
new System.Collections.Generic.List < QByteArray >	DynamicPropertyNames ()
virtual bool	OnEvent (QEvent arg1)
virtual bool	EventFilter (QObject arg1, QEvent arg2)
new bool	Inherits (string classname)
new void	InstallEventFilter (QObject arg1)
new bool	IsWidgetType ()
new void	KillTimer (int id)
new object	Property (string name)
new void	RemoveEventFilter (QObject arg1)
new bool	SetProperty (string name, object value)
new void	SetUserData (uint id, QObjectUserData data)
new bool	SignalsBlocked ()
new int	StartTimer (int interval)
new QObjectUserData	UserData (uint id)
new void	Dispose ()
Public Member Functions inherited from QtCore.Qt
delegate QTextStream	FuncQTextStreamQTextStream (QTextStream qTextStream)
delegate string	FuncStringQByteArray (QByteArray qByteArray)
delegate QByteArray	FuncQByteArrayString (string @string)
delegate void	ActionQtMsgTypeString (QtMsgType qtMsgType, string @string)
delegate QObject	FuncQObject ()

Static Public Member Functions
static string	Tr (string s, string c=null)
static string	Tr (string s, string c, int n)
static string	TrUtf8 (string s, string c=null)
static string	TrUtf8 (string s, string c, int n)
Static Public Member Functions inherited from QtCore.QObject
static bool	Connect (QObject sender, QMetaMethod signal, QObject receiver, QMetaMethod method, Qt.ConnectionType type=Qt.ConnectionType.AutoConnection)
static bool	Connect (QObject sender, string signal, QObject receiver, string member, Qt.ConnectionType arg5=Qt.ConnectionType.AutoConnection)
static bool	Disconnect (QObject sender, QMetaMethod signal, QObject receiver, QMetaMethod member)
static bool	Disconnect (QObject sender, string signal, QObject receiver, string member)
static uint	RegisterUserData ()
static string	Tr (string s, string c=null)
static string	Tr (string s, string c, int n)
static string	TrUtf8 (string s, string c=null)
static string	TrUtf8 (string s, string c, int n)
Static Public Member Functions inherited from QtCore.Qt
static QDataStream	Write (QDataStream s, object p)
static QDataStream	Write (QDataStream arg1, QSizeF arg2)
static QTextStream	Write (QTextStream s, Qt.FuncQTextStreamQTextStream f)
static QDataStream	Write (QDataStream arg1, QPoint arg2)
static QDataStream	Write (QDataStream arg1, QLineF arg2)
static QDataStream	Write (QDataStream arg1, QPointF arg2)
static QDataStream	Write (QDataStream arg1, QChar arg2)
static QDataStream	Write (QDataStream arg1, QByteArray arg2)
static QDataStream	Write (QDataStream arg1, QEasingCurve arg2)
static QDataStream	Write (QDataStream arg1, QRectF arg2)
static QDataStream	Write (QDataStream arg1, QDateTime arg2)
static QDataStream	Write (QDataStream arg1, QUrl arg2)
static QDataStream	Write (QDataStream arg1, QTime arg2)
static QDataStream	Write (QDataStream arg1, QLocale arg2)
static QDataStream	Write (QDataStream arg1, QBitArray arg2)
static QDataStream	Write (QDataStream arg1, QUuid arg2)
static QDataStream	Write (QDataStream arg1, QLine arg2)
static QDataStream	Write (QDataStream arg1, QDate arg2)
static QDataStream	Write (QDataStream @out, QRegExp regExp)
static QDataStream	Write (QDataStream arg1, QRect arg2)
static QDataStream	Write (QDataStream arg1, QSize arg2)
static QDataStream	Write (QDataStream s, QVariant.Type p)
static QDataStream	Write (QDataStream arg1, string arg2)
static QDataStream	Write (QDataStream @out, System.Collections.Generic.List< string > list)
static QDataStream	Read (QDataStream arg1, QChar arg2)
static QDataStream	Read (QDataStream arg1, QLocale arg2)
static QDataStream	Read (QDataStream arg1, QRect arg2)
static QDataStream	Read (QDataStream arg1, QEasingCurve arg2)
static QDataStream	Read (QDataStream arg1, QDate arg2)
static QDataStream	Read (QDataStream arg1, QUrl arg2)
static QDataStream	Read (QDataStream arg1, QUuid arg2)
static QTextStream	Read (QTextStream s, Qt.FuncQTextStreamQTextStream f)
static QDataStream	Read (QDataStream arg1, QLineF arg2)
static QDataStream	Read (QDataStream arg1, QRectF arg2)
static QDataStream	Read (QDataStream arg1, QPointF arg2)
static QDataStream	Read (QDataStream arg1, QLine arg2)
static QDataStream	Read (QDataStream arg1, QBitArray arg2)
static QDataStream	Read (QDataStream arg1, QSize arg2)
static QDataStream	Read (QDataStream arg1, QDateTime arg2)
static QDataStream	Read (QDataStream arg1, QTime arg2)
static QDataStream	Read (QDataStream arg1, QPoint arg2)
static QDataStream	Read (QDataStream @in, QRegExp regExp)
static QDataStream	Read (QDataStream s, object p)
static QDataStream	Read (QDataStream arg1, QByteArray arg2)
static QDataStream	Read (QDataStream arg1, QSizeF arg2)
static QDataStream	Read (QDataStream arg1, string arg2)
static QDataStream	Read (QDataStream s, QVariant.Type p)
static QDataStream	Read (QDataStream @in, System.Collections.Generic.List< string > list)
static double	qAcos (double v)
static void	qAddPostRoutine (System.Action arg1)
static string	qAppName ()
static double	qAsin (double v)
static double	qAtan (double v)
static double	qAtan2 (double x, double y)
static void	qBadAlloc ()
static int	qCeil (double v)
static ushort	qChecksum (string s, uint len)
static QByteArray	qCompress (QByteArray data)
static QByteArray	qCompress (QByteArray data, int compressionLevel=-1)
static QByteArray	qCompress (Pointer< byte > data, int nbytes)
static QByteArray	qCompress (Pointer< byte > data, int nbytes, int compressionLevel=-1)
static double	qCos (double v)
static double	qExp (double v)
static double	qFabs (double v)
static double	qFastCos (double x)
static double	qFastSin (double x)
static string	qFlagLocation (string method)
static int	qFloor (double v)
static bool	qFuzzyCompare (double p1, double p2)
static bool	qFuzzyCompare (float p1, float p2)
static bool	qFuzzyIsNull (double d)
static bool	qFuzzyIsNull (float f)
static uint	qHash (QBitArray key)
static uint	qHash (QChar key)
static uint	qHash (QStringRef key)
static uint	qHash (QUrl url)
static uint	qHash (QPersistentModelIndex index)
static uint	qHash (QByteArray key)
static uint	qHash (QModelIndex index)
static uint	qHash (uint key)
static uint	qHash (sbyte key)
static uint	qHash (byte key)
static uint	qHash (short key)
static uint	qHash (NativeLong key)
static uint	qHash (ushort key)
static uint	qHash (long key)
static uint	qHash (ulong key)
static uint	qHash (int key)
static uint	qHash (string key)
static uint	qHash (NativeULong key)
static double	qInf ()
static Qt.ActionQtMsgTypeString	qInstallMsgHandler (Qt.ActionQtMsgTypeString arg1)
static int	qIntCast (float f)
static int	qIntCast (double f)
static bool	qIsFinite (double d)
static bool	qIsFinite (float f)
static bool	qIsInf (float f)
static bool	qIsInf (double d)
static bool	qIsNaN (float f)
static bool	qIsNaN (double d)
static bool	qIsNull (float f)
static bool	qIsNull (double d)
static double	qLn (double v)
static double	qPow (double x, double y)
static double	qQNaN ()
static void	qRegisterStaticPluginInstanceFunction (Qt.FuncQObject function)
static void	qRemovePostRoutine (System.Action arg1)
static int	qRound (double d)
static long	qRound64 (double d)
static double	qSNaN ()
static bool	qSharedBuild ()
static double	qSin (double v)
static double	qSqrt (double v)
static bool	qStringComparisonHelper (QStringRef s1, string s2)
static double	qTan (double v)
static QByteArray	qUncompress (QByteArray data)
static QByteArray	qUncompress (Pointer< byte > data, int nbytes)
static string	qVersion ()
static void	Qbswap_helper (Pointer< byte > src, Pointer< byte > dest, int size)
static QByteArray	Qgetenv (string varName)
static bool	Qputenv (string varName, QByteArray value)
static int	Qrand ()
static void	Qsrand (uint seed)
static int	Qstrcmp (QByteArray str1, QByteArray str2)
static int	Qstrcmp (QByteArray str1, string str2)
static int	Qstrcmp (string str1, QByteArray str2)
static int	Qstrcmp (string str1, string str2)
static Pointer< sbyte >	Qstrcpy (Pointer< sbyte > dst, string src)
static Pointer< sbyte >	Qstrdup (string arg1)
static int	Qstricmp (string arg1, string arg2)
static uint	Qstrlen (string str)
static int	Qstrncmp (string str1, string str2, uint len)
static Pointer< sbyte >	Qstrncpy (Pointer< sbyte > dst, string src, uint len)
static int	Qstrnicmp (string arg1, string arg2, uint len)
static uint	Qstrnlen (string str, uint maxlen)
static string	QtTrId (string id, int n=-1)

Protected Member Functions
	QTextDocument (System.Type dummy)
new void	OnBlockCountChanged (int newBlockCount)
new void	OnContentsChange (int from, int charsRemoves, int charsAdded)
new void	OnContentsChanged ()
virtual QTextObject	CreateObject (QTextFormat f)
new void	OnCursorPositionChanged (QTextCursor cursor)
new void	OnDocumentLayoutChanged ()
virtual object	LoadResource (int type, QUrl name)
new void	OnModificationChanged (bool m)
new void	OnRedoAvailable (bool arg1)
new void	OnUndoAvailable (bool arg1)
new void	OnUndoCommandAdded ()
Protected Member Functions inherited from QtCore.QObject
	QObject (System.Type dummy)
virtual void	OnChildEvent (QChildEvent arg1)
virtual void	ConnectNotify (string signal)
virtual void	OnCustomEvent (QEvent arg1)
new void	OnDestroyed (QObject arg1=null)
virtual void	DisconnectNotify (string signal)
new int	Receivers (string signal)
new QObject	Sender ()
new int	SenderSignalIndex ()
virtual void	OnTimerEvent (QTimerEvent arg1)

Properties
Slot< System.Int32, System.Int32, System.Int32 >	ContentsChange
Slot	ContentsChanged
Slot< System.Boolean >	UndoAvailable
Slot< System.Boolean >	RedoAvailable
Slot	UndoCommandAdded
Slot< System.Boolean >	ModificationChanged
Slot< QTextCursor >	CursorPositionChanged
Slot< System.Int32 >	BlockCountChanged
Slot	DocumentLayoutChanged
new Qt.CursorMoveStyle	DefaultCursorMoveStyle [get, set]
new QTextOption	DefaultTextOption [get, set]
new QAbstractTextDocumentLayout	DocumentLayout [get, set]
new bool	UndoRedoEnabled [get, set]
new bool	Modified [get, set]
new QSizeF	PageSize [get, set]
new QFont	DefaultFont [get, set]
new bool	UseDesignMetrics [get, set]
new QSizeF	Size [get]
new double	TextWidth [get, set]
new int	BlockCount [get]
new double	IndentWidth [get, set]
new string	DefaultStyleSheet [get, set]
new int	MaximumBlockCount [get, set]
new double	DocumentMargin [get, set]
static new QMetaObject	StaticMetaObject [get]
new IQTextDocumentSignals	Emit [get]
Properties inherited from QtCore.QObject
virtual EventHandler < QEventArgs< QChildEvent > >	ChildEvent
virtual EventHandler < QEventArgs< QEvent > >	CustomEvent
virtual EventHandler < QEventArgs< QEvent > >	Event
virtual EventHandler < QEventArgs< QTimerEvent > >	TimerEvent
Slot< QObject >	DestroyedQObject
Slot	Destroyed
new QObject	Parent [get, set]
virtual System.IntPtr	SmokeObject [get, set]
new string	ObjectName [get, set]
static new QMetaObject	StaticMetaObject [get]
static new QMetaObject	StaticQtMetaObject [get]
new IQObjectSignals	Emit [get]

Additional Inherited Members
Protected Attributes inherited from QtCore.QObject
object	Q_EMIT = null
SmokeInvocation	interceptor
readonly List< QEventHandler >	eventFilters = new List<QEventHandler>()

Detailed Description

The QTextDocument class holds formatted text that can be viewed and edited using a QTextEdit.

QTextDocument is a container for structured rich text documents, providing support for styled text and various types of document elements, such as lists, tables, frames, and images. They can be created for use in a QTextEdit, or used independently.

Each document element is described by an associated format object. Each format object is treated as a unique object by QTextDocuments, and can be passed to objectForFormat() to obtain the document element that it is applied to.

A QTextDocument can be edited programmatically using a QTextCursor, and its contents can be examined by traversing the document structure. The entire document structure is stored as a hierarchy of document elements beneath the root frame, found with the rootFrame() function. Alternatively, if you just want to iterate over the textual contents of the document you can use begin(), end(), and findBlock() to retrieve text blocks that you can examine and iterate over.

The layout of a document is determined by the documentLayout(); you can create your own QAbstractTextDocumentLayout subclass and set it using setDocumentLayout() if you want to use your own layout logic. The document's title and other meta-information can be obtained by calling the metaInformation() function. For documents that are exposed to users through the QTextEdit class, the document title is also available via the QTextEdit::documentTitle() function.

The toPlainText() and toHtml() convenience functions allow you to retrieve the contents of the document as plain text and HTML. The document's text can be searched using the find() functions.

Undo/redo of operations performed on the document can be controlled using the setUndoRedoEnabled() function. The undo/redo system can be controlled by an editor widget through the undo() and redo() slots; the document also provides contentsChanged(), undoAvailable(), and redoAvailable() signals that inform connected editor widgets about the state of the undo/redo system. The following are the undo/redo operations of a QTextDocument:

Insertion or removal of characters. A sequence of insertions or removals within the same text block are regarded as a single undo/redo operation.

Insertion or removal of text blocks. Sequences of insertion or removals in a single operation (e.g., by selecting and then deleting text) are regarded as a single undo/redo operation.

Text character format changes.

Text block format changes.

Text block group format changes.

See also QTextCursor, QTextEdit, Rich Text Processing, and Text Object Example.

Member Enumeration Documentation

enum QtGui.QTextDocument.FindFlag

This enum describes the options available to QTextDocument's find function. The options can be OR-ed together from the following list:

Enumerator:

FindBackward	Search backwards instead of forwards.
FindCaseSensitively	By default find works case insensitive. Specifying this option changes the behaviour to a case sensitive find operation.
FindWholeWords	Makes find match only complete words.

enum QtGui.QTextDocument.MetaInformation

This enum describes the different types of meta information that can be added to a document.

See also metaInformation() and setMetaInformation().

Enumerator:

DocumentTitle	The title of the document.
DocumentUrl	The url of the document. The loadResource() function uses this url as the base when loading relative resources.

enum QtGui.QTextDocument.ResourceType

This enum describes the types of resources that can be loaded by QTextDocument's loadResource() function.

See also loadResource().

Enumerator:

HtmlResource	The resource contains HTML.
ImageResource	The resource contains image data. Currently supported data types are QVariant::Pixmap and QVariant::Image. If the corresponding variant is of type QVariant::ByteArray then Qt attempts to load the image using QImage::loadFromData. QVariant::Icon is currently not supported. The icon needs to be converted to one of the supported types first, for example using QIcon::pixmap.
StyleSheetResource	The resource contains CSS.
UserResource	The first available value for user defined resource types.

enum QtGui.QTextDocument.Stacks

Enumerator:

RedoStack	The redo stack.
UndoAndRedoStacks	Both the undo and redo stacks.
UndoStack	The undo stack.

Constructor & Destructor Documentation

QtGui.QTextDocument.QTextDocument ( System.Type  dummy )

protected

QtGui.QTextDocument.QTextDocument

(

QObject

parent = null

)

Constructs an empty QTextDocument with the given parent.

QtGui.QTextDocument.QTextDocument	(	string	text,
		QObject	parent = null
	)

Constructs a QTextDocument containing the plain (unformatted) text specified, and with the given parent.

Member Function Documentation

new void QtGui.QTextDocument.AddResource	(	int	type,
		QUrl	name,
		object	resource
	)

Adds the resource resource to the resource cache, using type and name as identifiers. type should be a value from QTextDocument::ResourceType.

For example, you can add an image as a resource in order to reference it from within the document:

document->addResource(QTextDocument::ImageResource,

QUrl("mydata://image.png"), QVariant(image));

The image can be inserted into the document using the QTextCursor API:

QTextImageFormat imageFormat;

imageFormat.setName("mydata://image.png");

cursor.insertImage(imageFormat);

Alternatively, you can insert images using the HTML img tag:

editor->append("<img src=\"mydata://image.png\" />");

new void QtGui.QTextDocument.AdjustSize

(

)

Adjusts the document to a reasonable size.

This function was introduced in Qt 4.2.

See also idealWidth(), textWidth, and size.

new System.Collections.Generic.List<QTextFormat> QtGui.QTextDocument.AllFormats

(

)

Returns a vector of text formats for all the formats used in the document.

new void QtGui.QTextDocument.AppendUndoItem

(

QAbstractUndoItem

arg1

)

new int QtGui.QTextDocument.AvailableRedoSteps

(

)

Returns the number of available redo steps.

This function was introduced in Qt 4.6.

See also isRedoAvailable().

new int QtGui.QTextDocument.AvailableUndoSteps

(

)

Returns the number of available undo steps.

This function was introduced in Qt 4.6.

See also isUndoAvailable().

new QTextBlock QtGui.QTextDocument.Begin

(

)

Returns the document's first text block.

See also firstBlock().

new QChar QtGui.QTextDocument.CharacterAt

(

int

pos

)

Returns the character at position pos, or a null character if the position is out of range.

This function was introduced in Qt 4.5.

See also characterCount().

new int QtGui.QTextDocument.CharacterCount

(

)

Returns the number of characters of this document.

This function was introduced in Qt 4.5.

See also blockCount() and characterAt().

virtual void QtGui.QTextDocument.Clear ( )

virtual

Clears the document.

new void QtGui.QTextDocument.ClearUndoRedoStacks

(

QTextDocument.Stacks

historyToClear = QTextDocument.Stacks.UndoAndRedoStacks

)

Clears the stacks specified by stacksToClear.

This method clears any commands on the undo stack, the redo stack, or both (the default). If commands are cleared, the appropriate signals are emitted, QTextDocument::undoAvailable() or QTextDocument::redoAvailable().

This function was introduced in Qt 4.7.

See also QTextDocument::undoAvailable() and QTextDocument::redoAvailable().

new QTextDocument QtGui.QTextDocument.Clone

(

QObject

parent = null

)

Creates a new QTextDocument that is a copy of this text document. parent is the parent of the returned text document.

virtual QTextObject QtGui.QTextDocument.CreateObject ( QTextFormat  f )

protectedvirtual

Creates and returns a new document object (a QTextObject), based on the given format.

QTextObjects will always get created through this method, so you must reimplement it if you use custom text objects inside your document.

override void QtGui.QTextDocument.CreateProxy ( )

virtual

Reimplemented from QtCore.QObject.

new void QtGui.QTextDocument.Dispose

(

)

new double QtGui.QTextDocument.documentMargin

(

)

new void QtGui.QTextDocument.DrawContents

(

QPainter

painter

)

Draws the content of the document with painter p, clipped to rect. If rect is a null rectangle (default) then the document is painted unclipped.

This function was introduced in Qt 4.2.

new void QtGui.QTextDocument.DrawContents	(	QPainter	painter,
		QRectF	rect
	)

Draws the content of the document with painter p, clipped to rect. If rect is a null rectangle (default) then the document is painted unclipped.

This function was introduced in Qt 4.2.

new QTextBlock QtGui.QTextDocument.End

(

)

This function returns a block to test for the end of the document while iterating over it.

for (QTextBlock it = doc->begin(); it != doc->end(); it = it.next())

cout << it.text().toStdString() << endl;

The block returned is invalid and represents the block after the last block in the document. You can use lastBlock() to retrieve the last valid block of the document.

See also lastBlock().

new QTextCursor QtGui.QTextDocument.Find	(	QRegExp	expr,
		QTextCursor	from,
		QTextDocument.FindFlag	options = 0
	)

Finds the next occurrence of the string, subString, in the document. The search starts at the position of the given cursor, and proceeds forwards through the document unless specified otherwise in the search options. The options control the type of search performed.

Returns a cursor with the match selected if subString was found; otherwise returns a null cursor.

If the given cursor has a selection, the search begins after the selection; otherwise it begins at the cursor's position.

By default the search is case-sensitive, and can match text anywhere in the document.

new QTextCursor QtGui.QTextDocument.Find	(	QRegExp	expr,
		int	from = 0,
		QTextDocument.FindFlag	options = 0
	)

Finds the next occurrence of the string, subString, in the document. The search starts at the position of the given cursor, and proceeds forwards through the document unless specified otherwise in the search options. The options control the type of search performed.

Returns a cursor with the match selected if subString was found; otherwise returns a null cursor.

If the given cursor has a selection, the search begins after the selection; otherwise it begins at the cursor's position.

By default the search is case-sensitive, and can match text anywhere in the document.

new QTextCursor QtGui.QTextDocument.Find	(	string	subString,
		QTextCursor	from,
		QTextDocument.FindFlag	options = 0
	)

Finds the next occurrence of the string, subString, in the document. The search starts at the position of the given cursor, and proceeds forwards through the document unless specified otherwise in the search options. The options control the type of search performed.

Returns a cursor with the match selected if subString was found; otherwise returns a null cursor.

If the given cursor has a selection, the search begins after the selection; otherwise it begins at the cursor's position.

By default the search is case-sensitive, and can match text anywhere in the document.

new QTextCursor QtGui.QTextDocument.Find	(	string	subString,
		int	from = 0,
		QTextDocument.FindFlag	options = 0
	)

Finds the next occurrence of the string, subString, in the document. The search starts at the position of the given cursor, and proceeds forwards through the document unless specified otherwise in the search options. The options control the type of search performed.

Returns a cursor with the match selected if subString was found; otherwise returns a null cursor.

If the given cursor has a selection, the search begins after the selection; otherwise it begins at the cursor's position.

By default the search is case-sensitive, and can match text anywhere in the document.

new QTextBlock QtGui.QTextDocument.FindBlock

(

int

pos

)

Returns the text block that contains the pos-th character.

new QTextBlock QtGui.QTextDocument.FindBlockByLineNumber

(

int

blockNumber

)

Returns the text block that contains the specified lineNumber.

This function was introduced in Qt 4.5.

See also QTextBlock::firstLineNumber().

new QTextBlock QtGui.QTextDocument.FindBlockByNumber

(

int

blockNumber

)

Returns the text block with the specified blockNumber.

This function was introduced in Qt 4.4.

See also QTextBlock::blockNumber().

new QTextBlock QtGui.QTextDocument.FirstBlock

(

)

Returns the document's first text block.

This function was introduced in Qt 4.4.

new QTextFrame QtGui.QTextDocument.FrameAt

(

int

pos

)

new double QtGui.QTextDocument.IdealWidth

(

)

Returns the ideal width of the text document. The ideal width is the actually used width of the document without optional alignments taken into account. It is always <= size().width().

This function was introduced in Qt 4.2.

See also adjustSize() and textWidth.

new double QtGui.QTextDocument.indentWidth

(

)

new bool QtGui.QTextDocument.IsEmpty

(

)

Returns true if the document is empty; otherwise returns false.

new bool QtGui.QTextDocument.IsRedoAvailable

(

)

Returns true if redo is available; otherwise returns false.

See also isUndoAvailable() and availableRedoSteps().

new bool QtGui.QTextDocument.IsUndoAvailable

(

)

Returns true if undo is available; otherwise returns false.

See also isRedoAvailable() and availableUndoSteps().

new QTextBlock QtGui.QTextDocument.LastBlock

(

)

Returns the document's last (valid) text block.

This function was introduced in Qt 4.4.

new int QtGui.QTextDocument.LineCount

(

)

Returns the number of lines of this document (if the layout supports this). Otherwise, this is identical to the number of blocks.

This function was introduced in Qt 4.5.

See also blockCount() and characterCount().

virtual object QtGui.QTextDocument.LoadResource ( int  type, QUrl  name  )

protectedvirtual

Loads data of the specified type from the resource with the given name.

This function is called by the rich text engine to request data that isn't directly stored by QTextDocument, but still associated with it. For example, images are referenced indirectly by the name attribute of a QTextImageFormat object.

When called by Qt, type is one of the values of QTextDocument::ResourceType.

If the QTextDocument is a child object of a QTextEdit, QTextBrowser, or a QTextDocument itself then the default implementation tries to retrieve the data from the parent.

new void QtGui.QTextDocument.MarkContentsDirty	(	int	from,
		int	length
	)

Marks the contents specified by the given position and length as "dirty", informing the document that it needs to be laid out again.

new string QtGui.QTextDocument.metaInformation

(

QTextDocument.MetaInformation

info

)

Returns meta information about the document of the type specified by info.

See also setMetaInformation().

new QTextObject QtGui.QTextDocument.Object

(

int

objectIndex

)

Returns the text object associated with the given objectIndex.

new QTextObject QtGui.QTextDocument.ObjectForFormat

(

QTextFormat

arg1

)

Returns the text object associated with the format f.

new void QtGui.QTextDocument.OnBlockCountChanged ( int  newBlockCount )

protected

This signal is emitted when the total number of text blocks in the document changes. The value passed in newBlockCount is the new total.

This function was introduced in Qt 4.3.

new void QtGui.QTextDocument.OnContentsChange ( int  from, int  charsRemoves, int  charsAdded  )

protected

This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.

Information is provided about the position of the character in the document where the change occurred, the number of characters removed (charsRemoved), and the number of characters added (charsAdded).

The signal is emitted before the document's layout manager is notified about the change. This hook allows you to implement syntax highlighting for the document.

See also QAbstractTextDocumentLayout::documentChanged() and contentsChanged().

new void QtGui.QTextDocument.OnContentsChanged ( )

protected

This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.

See also contentsChange().

new void QtGui.QTextDocument.OnCursorPositionChanged ( QTextCursor  cursor )

protected

This signal is emitted whenever the position of a cursor changed due to an editing operation. The cursor that changed is passed in cursor. If you need a signal when the cursor is moved with the arrow keys you can use the cursorPositionChanged() signal in QTextEdit.

new void QtGui.QTextDocument.OnDocumentLayoutChanged ( )

protected

This signal is emitted when a new document layout is set.

This function was introduced in Qt 4.4.

See also setDocumentLayout().

new void QtGui.QTextDocument.OnModificationChanged ( bool  m )

protected

This signal is emitted whenever the content of the document changes in a way that affects the modification state. If changed is true, the document has been modified; otherwise it is false.

For example, calling setModified(false) on a document and then inserting text causes the signal to get emitted. If you undo that operation, causing the document to return to its original unmodified state, the signal will get emitted again.

new void QtGui.QTextDocument.OnRedoAvailable ( bool  arg1 )

protected

This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false).

new void QtGui.QTextDocument.OnUndoAvailable ( bool  arg1 )

protected

This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false).

See the Qt Undo Framework documentation for details.

See also undo() and isUndoRedoEnabled().

new void QtGui.QTextDocument.OnUndoCommandAdded ( )

protected

This signal is emitted every time a new level of undo is added to the QTextDocument.

This function was introduced in Qt 4.4.

new int QtGui.QTextDocument.PageCount

(

)

returns the number of pages in this document.

new void QtGui.QTextDocument.Print

(

QPrinter

printer

)

Prints the document to the given printer. The QPrinter must be set up before being used with this function.

This is only a convenience method to print the whole document to the printer.

If the document is already paginated through a specified height in the pageSize() property it is printed as-is.

If the document is not paginated, like for example a document used in a QTextEdit, then a temporary copy of the document is created and the copy is broken into multiple pages according to the size of the QPrinter's paperRect(). By default a 2 cm margin is set around the document contents. In addition the current page number is printed at the bottom of each page.

Note that QPrinter::Selection is not supported as print range with this function since the selection is a property of QTextCursor. If you have a QTextEdit associated with your QTextDocument then you can use QTextEdit's print() function because QTextEdit has access to the user's selection.

See also QTextEdit::print().

new void QtGui.QTextDocument.Redo

(

)

This is an overloaded function.

Redoes the last editing operation on the document if redo is available.

new void QtGui.QTextDocument.Redo

(

QTextCursor

cursor

)

Redoes the last editing operation on the document if redo is available.

The provided cursor is positioned at the end of the location where the edition operation was redone.

This function was introduced in Qt 4.2.

new object QtGui.QTextDocument.Resource	(	int	type,
		QUrl	name
	)

Returns data of the specified type from the resource with the given name.

This function is called by the rich text engine to request data that isn't directly stored by QTextDocument, but still associated with it. For example, images are referenced indirectly by the name attribute of a QTextImageFormat object.

Resources are cached internally in the document. If a resource can not be found in the cache, loadResource is called to try to load the resource. loadResource should then use addResource to add the resource to the cache.

See also QTextDocument::ResourceType.

new int QtGui.QTextDocument.Revision

(

)

Returns the document's revision (if undo is enabled).

The revision is guaranteed to increase when a document that is not modified is edited.

This function was introduced in Qt 4.4.

See also QTextBlock::revision() and isModified().

new QTextFrame QtGui.QTextDocument.RootFrame

(

)

Returns the document's root frame.

new void QtGui.QTextDocument.SetDocumentMargin

(

double

margin

)

new void QtGui.QTextDocument.SetHtml

(

string

html

)

Replaces the entire contents of the document with the given HTML-formatted text in the html string.

The HTML formatting is respected as much as possible; for example, "<b>bold</b> text" will produce text where the first word has a font weight that gives it a bold appearance: "bold text".

Note: It is the responsibility of the caller to make sure that the text is correctly decoded when a QString containing HTML is created and passed to setHtml().

See also setPlainText() and Supported HTML Subset.

new void QtGui.QTextDocument.SetIndentWidth

(

double

width

)

new void QtGui.QTextDocument.SetMetaInformation	(	QTextDocument.MetaInformation	info,
		string	arg2
	)

Sets the document's meta information of the type specified by info to the given string.

See also metaInformation().

new void QtGui.QTextDocument.SetPlainText

(

string

text

)

Replaces the entire contents of the document with the given plain text.

See also setHtml().

new void QtGui.QTextDocument.SetTextWidth

(

double

width

)

new double QtGui.QTextDocument.textWidth

(

)

new string QtGui.QTextDocument.ToHtml

(

)

Returns a string containing an HTML representation of the document.

The encoding parameter specifies the value for the charset attribute in the html header. For example if 'utf-8' is specified then the beginning of the generated html will look like this:

<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head><body>...

If no encoding is specified then no such meta information is generated.

If you later on convert the returned html string into a byte array for transmission over a network or when saving to disk you should specify the encoding you're going to use for the conversion to a byte array here.

See also Supported HTML Subset.

new string QtGui.QTextDocument.ToHtml

(

QByteArray

encoding

)

Returns a string containing an HTML representation of the document.

The encoding parameter specifies the value for the charset attribute in the html header. For example if 'utf-8' is specified then the beginning of the generated html will look like this:

<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head><body>...

If no encoding is specified then no such meta information is generated.

If you later on convert the returned html string into a byte array for transmission over a network or when saving to disk you should specify the encoding you're going to use for the conversion to a byte array here.

See also Supported HTML Subset.

new string QtGui.QTextDocument.ToPlainText

(

)

Returns the plain text contained in the document. If you want formatting information use a QTextCursor instead.

See also toHtml().

static string QtGui.QTextDocument.Tr ( string  s, string  c = null  )

static

static string QtGui.QTextDocument.Tr ( string  s, string  c, int  n  )

static

static string QtGui.QTextDocument.TrUtf8 ( string  s, string  c = null  )

static

static string QtGui.QTextDocument.TrUtf8 ( string  s, string  c, int  n  )

static

new void QtGui.QTextDocument.Undo

(

)

This is an overloaded function.

new void QtGui.QTextDocument.Undo

(

QTextCursor

cursor

)

Undoes the last editing operation on the document if undo is available. The provided cursor is positioned at the end of the location where the edition operation was undone.

See the Qt Undo Framework documentation for details.

This function was introduced in Qt 4.2.

See also undoAvailable() and isUndoRedoEnabled().

Property Documentation

new int QtGui.QTextDocument.BlockCount

get

Slot<System.Int32> QtGui.QTextDocument.BlockCountChanged

addremove

This signal is emitted when the total number of text blocks in the document changes. The value passed in newBlockCount is the new total.

This function was introduced in Qt 4.3.

Slot<System.Int32,System.Int32,System.Int32> QtGui.QTextDocument.ContentsChange

addremove

This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.

Information is provided about the position of the character in the document where the change occurred, the number of characters removed (charsRemoved), and the number of characters added (charsAdded).

The signal is emitted before the document's layout manager is notified about the change. This hook allows you to implement syntax highlighting for the document.

See also QAbstractTextDocumentLayout::documentChanged() and contentsChanged().

Slot QtGui.QTextDocument.ContentsChanged

addremove

This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.

See also contentsChange().

Slot<QTextCursor> QtGui.QTextDocument.CursorPositionChanged

addremove

This signal is emitted whenever the position of a cursor changed due to an editing operation. The cursor that changed is passed in cursor. If you need a signal when the cursor is moved with the arrow keys you can use the cursorPositionChanged() signal in QTextEdit.

new Qt.CursorMoveStyle QtGui.QTextDocument.DefaultCursorMoveStyle

getset

The default cursor movement style is used by all QTextCursor objects created from the document. The default is Qt::LogicalMoveStyle.

This function was introduced in Qt 4.8.

Sets the default cursor movement style to the given style.

This function was introduced in Qt 4.8.

new QFont QtGui.QTextDocument.DefaultFont

getset

This property holds the default font used to display the document's text.

new string QtGui.QTextDocument.DefaultStyleSheet

getset

new QTextOption QtGui.QTextDocument.DefaultTextOption

getset

new QAbstractTextDocumentLayout QtGui.QTextDocument.DocumentLayout

getset

Returns the document layout for this document.

Sets the document to use the given layout. The previous layout is deleted.

Slot QtGui.QTextDocument.DocumentLayoutChanged

addremove

This signal is emitted when a new document layout is set.

This function was introduced in Qt 4.4.

See also setDocumentLayout().

new double QtGui.QTextDocument.DocumentMargin

getset

new IQTextDocumentSignals QtGui.QTextDocument.Emit

getprotected

new double QtGui.QTextDocument.IndentWidth

getset

new int QtGui.QTextDocument.MaximumBlockCount

getset

This property specifies the limit for blocks in the document.

Specifies the maximum number of blocks the document may have. If there are more blocks in the document that specified with this property blocks are removed from the beginning of the document.

A negative or zero value specifies that the document may contain an unlimited amount of blocks.

The default value is 0.

Note that setting this property will apply the limit immediately to the document contents.

Setting this property also disables the undo redo history.

This property is undefined in documents with tables or frames.

This property was introduced in Qt 4.2.

Slot<System.Boolean> QtGui.QTextDocument.ModificationChanged

addremove

This signal is emitted whenever the content of the document changes in a way that affects the modification state. If changed is true, the document has been modified; otherwise it is false.

For example, calling setModified(false) on a document and then inserting text causes the signal to get emitted. If you undo that operation, causing the document to return to its original unmodified state, the signal will get emitted again.

new bool QtGui.QTextDocument.Modified

getset

This property holds whether the document has been modified by the user.

By default, this property is false.

new QSizeF QtGui.QTextDocument.PageSize

getset

This property holds the page size that should be used for laying out the document.

By default, for a newly-created, empty document, this property contains an undefined size.

Slot<System.Boolean> QtGui.QTextDocument.RedoAvailable

addremove

This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false).

new QSizeF QtGui.QTextDocument.Size

get

new QMetaObject QtGui.QTextDocument.StaticMetaObject

staticget

new double QtGui.QTextDocument.TextWidth

getset

Slot<System.Boolean> QtGui.QTextDocument.UndoAvailable

addremove

This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false).

See the Qt Undo Framework documentation for details.

See also undo() and isUndoRedoEnabled().

Slot QtGui.QTextDocument.UndoCommandAdded

addremove

This signal is emitted every time a new level of undo is added to the QTextDocument.

This function was introduced in Qt 4.4.

new bool QtGui.QTextDocument.UndoRedoEnabled

getset

This property holds whether undo/redo are enabled for this document.

This defaults to true. If disabled, the undo stack is cleared and no items will be added to it.

new bool QtGui.QTextDocument.UseDesignMetrics

getset

This property holds whether the document uses design metrics of fonts to improve the accuracy of text layout.

If this property is set to true, the layout will use design metrics. Otherwise, the metrics of the paint device as set on QAbstractTextDocumentLayout::setPaintDevice() will be used.

Using design metrics makes a layout have a width that is no longer dependent on hinting and pixel-rounding. This means that WYSIWYG text layout becomes possible because the width scales much more linearly based on paintdevice metrics than it would otherwise.

By default, this property is false.

This property was introduced in Qt 4.1.