Qyoto  4.0.7
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties
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)
  More...
 
 QTextDocument (string text, QObject parent=null)
  More...
 
override void CreateProxy ()
 
new void AddResource (int type, QUrl name, object resource)
  More...
 
new void AdjustSize ()
  More...
 
new void AppendUndoItem (QAbstractUndoItem arg1)
 
new QTextBlock Begin ()
  More...
 
new QChar CharacterAt (int pos)
  More...
 
virtual void Clear ()
  More...
 
new void ClearUndoRedoStacks (QTextDocument.Stacks historyToClear=QTextDocument.Stacks.UndoAndRedoStacks)
  More...
 
new QTextDocument Clone (QObject parent=null)
  More...
 
new void DrawContents (QPainter painter)
  More...
 
new void DrawContents (QPainter painter, QRectF rect)
  More...
 
new QTextBlock End ()
  More...
 
new QTextCursor Find (QRegExp expr, QTextCursor from, QTextDocument.FindFlag options=0)
  More...
 
new QTextCursor Find (QRegExp expr, int from=0, QTextDocument.FindFlag options=0)
  More...
 
new QTextCursor Find (string subString, QTextCursor from, QTextDocument.FindFlag options=0)
  More...
 
new QTextCursor Find (string subString, int from=0, QTextDocument.FindFlag options=0)
  More...
 
new QTextBlock FindBlock (int pos)
  More...
 
new QTextBlock FindBlockByLineNumber (int blockNumber)
  More...
 
new QTextBlock FindBlockByNumber (int blockNumber)
  More...
 
new QTextFrame FrameAt (int pos)
 
new void MarkContentsDirty (int from, int length)
  More...
 
new string metaInformation (QTextDocument.MetaInformation info)
  More...
 
new QTextObject Object (int objectIndex)
  More...
 
new QTextObject ObjectForFormat (QTextFormat f)
  More...
 
new void Print (QPrinter printer)
  More...
 
new void Redo ()
  More...
 
new void Redo (QTextCursor cursor)
  More...
 
new object Resource (int type, QUrl name)
  More...
 
new void SetHtml (string html)
  More...
 
new void SetMetaInformation (QTextDocument.MetaInformation info, string @string)
  More...
 
new void SetPlainText (string text)
  More...
 
new string ToHtml ()
  More...
 
new string ToHtml (QByteArray encoding)
  More...
 
new string ToPlainText ()
  More...
 
new void Undo ()
  More...
 
new void Undo (QTextCursor cursor)
  More...
 
new void Dispose ()
 
- Public Member Functions inherited from QtCore.QObject
 QObject (QObject parent=null)
  More...
 
new bool BlockSignals (bool b)
  More...
 
new bool Connect (QObject sender, string signal, string member, Qt.ConnectionType type=Qt.ConnectionType.AutoConnection)
  More...
 
new void DeleteLater ()
  More...
 
new bool Disconnect (QObject receiver, string member=null)
  More...
 
new bool Disconnect (string signal=null, QObject receiver=null, string member=null)
  More...
 
new void DumpObjectInfo ()
  More...
 
new void DumpObjectTree ()
  More...
 
virtual bool OnEvent (QEvent e)
  More...
 
virtual bool EventFilter (QObject watched, QEvent @event)
  More...
 
new bool Inherits (string classname)
  More...
 
new void InstallEventFilter (QObject filterObj)
  More...
 
new void KillTimer (int id)
  More...
 
new object Property (string name)
  More...
 
new void RemoveEventFilter (QObject obj)
  More...
 
new bool SetProperty (string name, object value)
  More...
 
new void SetUserData (uint id, QObjectUserData data)
 
new int StartTimer (int interval)
  More...
 
new QObjectUserData UserData (uint id)
 
new void Dispose ()
 
- Public Member Functions inherited from QtCore.Qt
delegate QTextStream FuncQTextStreamQTextStream (QTextStream qTextStream)
 
delegate void ActionQtMsgTypeString (QtMsgType qtMsgType, string @string)
 
delegate QObject FuncQObject ()
 
delegate string FuncStringQByteArray (QByteArray qByteArray)
 
delegate QByteArray FuncQByteArrayString (string @string)
 

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)
  More...
 
static bool Connect (QObject sender, string signal, QObject receiver, string member, Qt.ConnectionType type=Qt.ConnectionType.AutoConnection)
  More...
 
static bool Disconnect (QObject sender, QMetaMethod signal, QObject receiver, QMetaMethod member)
  More...
 
static bool Disconnect (QObject sender, string signal, QObject receiver, string member)
  More...
 
static string Tr (string s, string c=null)
  More...
 
static string Tr (string s, string c, int n)
  More...
 
static string TrUtf8 (string s, string c=null)
  More...
 
static string TrUtf8 (string s, string c, int n)
  More...
 
- Static Public Member Functions inherited from QtCore.Qt
static QDataStream Write (QDataStream s, object p)
 
static QDataStream Write (QDataStream stream, QSizeF size)
  More...
 
static QDataStream Write (QDataStream stream, QPoint point)
  More...
 
static QTextStream Write (QTextStream s, Qt.FuncQTextStreamQTextStream f)
 
static QDataStream Write (QDataStream stream, QLineF line)
  More...
 
static QDataStream Write (QDataStream stream, QPointF point)
  More...
 
static QDataStream Write (QDataStream @out, QChar chr)
  More...
 
static QDataStream Write (QDataStream @out, QByteArray ba)
  More...
 
static QDataStream Write (QDataStream stream, QEasingCurve easing)
  More...
 
static QDataStream Write (QDataStream stream, QRectF rectangle)
  More...
 
static QDataStream Write (QDataStream @out, QDateTime dateTime)
  More...
 
static QDataStream Write (QDataStream @out, QUrl url)
  More...
 
static QDataStream Write (QDataStream @out, QTime time)
  More...
 
static QDataStream Write (QDataStream arg1, QLocale arg2)
 
static QDataStream Write (QDataStream @out, QBitArray ba)
  More...
 
static QDataStream Write (QDataStream s, QUuid id)
  More...
 
static QDataStream Write (QDataStream stream, QLine line)
  More...
 
static QDataStream Write (QDataStream @out, QDate date)
  More...
 
static QDataStream Write (QDataStream @out, QRegExp regExp)
  More...
 
static QDataStream Write (QDataStream stream, QRect rectangle)
  More...
 
static QDataStream Write (QDataStream stream, QSize size)
  More...
 
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)
  More...
 
static QDataStream Read (QDataStream @in, QChar chr)
  More...
 
static QDataStream Read (QDataStream arg1, QLocale arg2)
 
static QDataStream Read (QDataStream stream, QRect rectangle)
  More...
 
static QDataStream Read (QDataStream arg1, QEasingCurve arg2)
 
static QDataStream Read (QDataStream @in, QDate date)
  More...
 
static QDataStream Read (QDataStream @in, QUrl url)
  More...
 
static QDataStream Read (QDataStream s, QUuid id)
  More...
 
static QTextStream Read (QTextStream s, Qt.FuncQTextStreamQTextStream f)
 
static QDataStream Read (QDataStream stream, QLineF line)
  More...
 
static QDataStream Read (QDataStream stream, QRectF rectangle)
  More...
 
static QDataStream Read (QDataStream stream, QPointF point)
  More...
 
static QDataStream Read (QDataStream stream, QLine line)
  More...
 
static QDataStream Read (QDataStream @in, QBitArray ba)
  More...
 
static QDataStream Read (QDataStream stream, QSize size)
  More...
 
static QDataStream Read (QDataStream @in, QDateTime dateTime)
  More...
 
static QDataStream Read (QDataStream @in, QTime time)
  More...
 
static QDataStream Read (QDataStream stream, QPoint point)
  More...
 
static QDataStream Read (QDataStream @in, QRegExp regExp)
  More...
 
static QDataStream Read (QDataStream s, object p)
 
static QDataStream Read (QDataStream @in, QByteArray ba)
  More...
 
static QDataStream Read (QDataStream stream, QSizeF size)
  More...
 
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)
  More...
 
static double QAcos (double v)
  More...
 
static void QAddPostRoutine (System.Action ptr)
  More...
 
static double QAsin (double v)
  More...
 
static double QAtan (double v)
  More...
 
static double QAtan2 (double x, double y)
  More...
 
static void QBadAlloc ()
 
static int QCeil (double v)
  More...
 
static ushort QChecksum (string s, uint len)
  More...
 
static QByteArray QCompress (QByteArray data, int compressionLevel=-1)
  More...
 
static QByteArray QCompress (Pointer< byte > data, int nbytes, int compressionLevel=-1)
  More...
 
static double QCos (double v)
  More...
 
static double QExp (double v)
  More...
 
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)
  More...
 
static bool QFuzzyCompare (double p1, double p2)
  More...
 
static bool QFuzzyCompare (float p1, float p2)
  More...
 
static bool QFuzzyIsNull (double d)
 
static bool QFuzzyIsNull (float f)
 
static uint QHash (QBitArray key)
  More...
 
static uint QHash (QChar key)
  More...
 
static uint QHash (QStringRef key)
 
static uint QHash (QUrl url)
  More...
 
static uint QHash (QPersistentModelIndex index)
 
static uint QHash (QByteArray key)
  More...
 
static uint QHash (QModelIndex index)
 
static uint QHash (uint key)
  More...
 
static uint QHash (char key)
  More...
 
static uint QHash (byte key)
  More...
 
static uint QHash (short key)
  More...
 
static uint QHash (NativeLong key)
  More...
 
static uint QHash (ushort key)
  More...
 
static uint QHash (long key)
  More...
 
static uint QHash (ulong key)
  More...
 
static uint QHash (int key)
  More...
 
static uint QHash (string key)
  More...
 
static uint QHash (NativeULong key)
  More...
 
static Qt.ActionQtMsgTypeString QInstallMsgHandler (Qt.ActionQtMsgTypeString handler)
  More...
 
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)
  More...
 
static double QPow (double x, double y)
  More...
 
static void QRegisterStaticPluginInstanceFunction (Qt.FuncQObject function)
  More...
 
static void QRemovePostRoutine (System.Action arg1)
 
static int QRound (double d)
  More...
 
static long QRound64 (double d)
  More...
 
static double QSin (double v)
  More...
 
static double QSqrt (double v)
  More...
 
static bool QStringComparisonHelper (QStringRef s1, string s2)
 
static double QTan (double v)
  More...
 
static QByteArray QUncompress (QByteArray data)
  More...
 
static QByteArray QUncompress (Pointer< byte > data, int nbytes)
  More...
 
static void Qbswap_helper (Pointer< byte > src, Pointer< byte > dest, int size)
 
static QByteArray Qgetenv (string varName)
  More...
 
static bool Qputenv (string varName, QByteArray value)
  More...
 
static void Qsrand (uint seed)
  More...
 
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)
  More...
 
static Pointer< sbyte > Qstrcpy (Pointer< sbyte > dst, string src)
  More...
 
static Pointer< sbyte > Qstrdup (string src)
  More...
 
static int Qstricmp (string str1, string str2)
  More...
 
static uint Qstrlen (string str)
  More...
 
static int Qstrncmp (string str1, string str2, uint len)
  More...
 
static Pointer< sbyte > Qstrncpy (Pointer< sbyte > dst, string src, uint len)
  More...
 
static int Qstrnicmp (string str1, string str2, uint len)
  More...
 
static uint Qstrnlen (string str, uint maxlen)
  More...
 

Protected Member Functions

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

Properties

Slot< System.Int32,
System.Int32, System.Int32 > 
ContentsChange
  More...
 
Slot ContentsChanged
  More...
 
Slot< System.Boolean > UndoAvailable
  More...
 
Slot< System.Boolean > RedoAvailable
  More...
 
Slot UndoCommandAdded
  More...
 
Slot< System.Boolean > ModificationChanged
  More...
 
Slot< QTextCursorCursorPositionChanged
  More...
 
Slot< System.Int32 > BlockCountChanged
  More...
 
Slot DocumentLayoutChanged
  More...
 
Qt.CursorMoveStyle DefaultCursorMoveStyle [get, set]
  More...
 
QTextOption DefaultTextOption [get, set]
 
QAbstractTextDocumentLayout DocumentLayout [get, set]
  More...
 
System.Collections.Generic.List
< QTextFormat
AllFormats [get]
  More...
 
int AvailableRedoSteps [get]
  More...
 
int AvailableUndoSteps [get]
  More...
 
int CharacterCount [get]
  More...
 
QTextBlock FirstBlock [get]
  More...
 
double IdealWidth [get]
  More...
 
bool IsEmpty [get]
  More...
 
bool IsRedoAvailable [get]
  More...
 
bool IsUndoAvailable [get]
  More...
 
QTextBlock LastBlock [get]
  More...
 
int LineCount [get]
  More...
 
int PageCount [get]
  More...
 
int Revision [get]
  More...
 
QTextFrame RootFrame [get]
  More...
 
new bool UndoRedoEnabled [get, set]
  More...
 
new bool Modified [get, set]
  More...
 
new QSizeF PageSize [get, set]
  More...
 
new QFont DefaultFont [get, set]
  More...
 
new bool UseDesignMetrics [get, set]
  More...
 
new QSizeF Size [get]
  More...
 
new double TextWidth [get, set]
  More...
 
new int BlockCount [get]
  More...
 
new double IndentWidth [get, set]
  More...
 
new string DefaultStyleSheet [get, set]
  More...
 
new int MaximumBlockCount [get, set]
  More...
 
new double DocumentMargin [get, set]
  More...
 
static new QMetaObject StaticMetaObject [get]
 
new IQTextDocumentSignals Emit [get]
 
- Properties inherited from QtCore.QObject
virtual EventHandler
< QEventArgs< QChildEvent > > 
ChildEvent
  More...
 
virtual EventHandler
< QEventArgs< QEvent > > 
CustomEvent
  More...
 
virtual EventHandler
< QEventArgs< QEvent > > 
Event
  More...
 
virtual EventHandler
< QEventArgs< QTimerEvent > > 
TimerEvent
  More...
 
Slot< QObjectDestroyedObj
  More...
 
Slot Destroyed
  More...
 
QObject Parent [get, set]
  More...
 
System.Collections.Generic.List
< QObject
Children [get]
  More...
 
System.Collections.Generic.List
< QByteArray
DynamicPropertyNames [get]
  More...
 
bool IsWidgetType [get]
  More...
 
static uint RegisterUserData [get]
 
QObject Sender [get]
  More...
 
int SenderSignalIndex [get]
  More...
 
bool SignalsBlocked [get]
  More...
 
virtual System.IntPtr SmokeObject [get, set]
 
new string ObjectName [get, set]
  More...
 
static new QMetaObject StaticMetaObject [get]
  More...
 
static new QMetaObject StaticQtMetaObject [get]
 
new IQObjectSignals Emit [get]
 
- Properties inherited from QtCore.Qt
static string QAppName [get]
 
static double QInf [get]
 
static double QQNaN [get]
 
static double QSNaN [get]
 
static bool QSharedBuild [get]
 
static string QVersion [get]
  More...
 
static int Qrand [get]
  More...
 

Additional Inherited Members

- Static Public Attributes inherited from QtCore.Qt
</para > *< para > Creating QM
files suitable for use with
this[SmokeMethod("qtTrId(const
char*, int)")] static strin 
QtTrId )(string id, int n=-1)
 
- 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

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.

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.

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.

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.

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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 void QtGui.QTextDocument.AppendUndoItem ( QAbstractUndoItem  arg1)
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().

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.

Here is the caller graph for this function:

new void QtGui.QTextDocument.Dispose ( )
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, matching the regular expression, expr, 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. The FindCaseSensitively option is ignored for this overload, use QRegExp::caseSensitivity instead.

Returns a cursor with the match selected if a match 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 
)

This is an overloaded function.

Finds the next occurrence, matching the regular expression, expr, in the document. The search starts at the given position, and proceeds forwards through the document unless specified otherwise in the search options. The options control the type of search performed. The FindCaseSensitively option is ignored for this overload, use QRegExp::caseSensitivity instead.

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

If the position is 0 (the default) the search begins from the beginning of the document; otherwise it begins at the specified position.

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 
)

This is an overloaded function.

Finds the next occurrence of the string, subString, in the document. The search starts at the given position, 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 position is 0 (the default) the search begins from the beginning of the document; otherwise it begins at the specified position.

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 QTextFrame QtGui.QTextDocument.FrameAt ( int  pos)
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  f)

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  available)
protected

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

new void QtGui.QTextDocument.OnUndoAvailable ( bool  available)
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 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 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.SetMetaInformation ( QTextDocument.MetaInformation  info,
string @  string 
)

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

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

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

int QtGui.QTextDocument.AvailableRedoSteps
get

Returns the number of available redo steps.

This function was introduced in Qt 4.6.

See also isRedoAvailable().

int QtGui.QTextDocument.AvailableUndoSteps
get

Returns the number of available undo steps.

This function was introduced in Qt 4.6.

See also isUndoAvailable().

new int QtGui.QTextDocument.BlockCount
get

Returns the number of text blocks in the document.

The value of this property is undefined in documents with tables or frames.

By default, if defined, this property contains a value of 1.

This property was introduced in Qt 4.2.

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.

int QtGui.QTextDocument.CharacterCount
get

Returns the number of characters of this document.

This function was introduced in Qt 4.5.

See also blockCount() and characterAt().

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.

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

The default style sheet is applied to all newly HTML formatted text that is inserted into the document, for example using setHtml() or QTextCursor::insertHtml().

The style sheet needs to be compliant to CSS 2.1 syntax.

Note: Changing the default style sheet does not have any effect to the existing content of the document.

This property was introduced in Qt 4.2.

QTextOption QtGui.QTextDocument.DefaultTextOption
getset
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

The margin around the document. The default is 4.

This property was introduced in Qt 4.5.

new IQTextDocumentSignals QtGui.QTextDocument.Emit
getprotected
QTextBlock QtGui.QTextDocument.FirstBlock
get

Returns the document's first text block.

This function was introduced in Qt 4.4.

double QtGui.QTextDocument.IdealWidth
get

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
getset

Returns the width used for text list and text block indenting.

The indent properties of QTextListFormat and QTextBlockFormat specify multiples of this value. The default indent width is 40.

This property was introduced in Qt 4.4.

bool QtGui.QTextDocument.IsEmpty
get

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

bool QtGui.QTextDocument.IsRedoAvailable
get

Returns true if redo is available; otherwise returns false.

See also isUndoAvailable() and availableRedoSteps().

bool QtGui.QTextDocument.IsUndoAvailable
get

Returns true if undo is available; otherwise returns false.

See also isRedoAvailable() and availableUndoSteps().

QTextBlock QtGui.QTextDocument.LastBlock
get

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

This function was introduced in Qt 4.4.

int QtGui.QTextDocument.LineCount
get

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().

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.

int QtGui.QTextDocument.PageCount
get

returns the number of pages in this document.

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

int QtGui.QTextDocument.Revision
get

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().

QTextFrame QtGui.QTextDocument.RootFrame
get

Returns the document's root frame.

new QSizeF QtGui.QTextDocument.Size
get

Returns the actual size of the document. This is equivalent to documentLayout()->documentSize();

The size of the document can be changed either by setting a text width or setting an entire page size.

Note that the width is always >= pageSize().width().

By default, for a newly-created, empty document, this property contains a configuration-dependent size.

This property was introduced in Qt 4.2.

new QMetaObject QtGui.QTextDocument.StaticMetaObject
staticget
new double QtGui.QTextDocument.TextWidth
getset

The text width specifies the preferred width for text in the document. If the text (or content in general) is wider than the specified with it is broken into multiple lines and grows vertically. If the text cannot be broken into multiple lines to fit into the specified text width it will be larger and the size() and the idealWidth() property will reflect that.

If the text width is set to -1 then the text will not be broken into multiple lines unless it is enforced through an explicit line break or a new paragraph.

The default value is -1.

Setting the text width will also set the page height to -1, causing the document to grow or shrink vertically in a continuous way. If you want the document layout to break the text into multiple pages then you have to set the pageSize property instead.

This property was introduced in Qt 4.2.

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.