|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.core.QObject
com.trolltech.qt.gui.QTextDocument
public class QTextDocument
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 can be obtained by calling the 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.
QTextCursor
, QTextEdit
, and Rich Text Processing.
Nested Class Summary | |
---|---|
static class |
QTextDocument.FindFlag
This enum describes the options available to QTextDocument 's find function. |
static class |
QTextDocument.FindFlags
|
static class |
QTextDocument.MetaInformation
This enum describes the different types of meta information that can be added to a document. |
static class |
QTextDocument.ResourceType
This enum describes the types of resources that can be loaded by QTextDocument 's loadResource() function. |
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal |
---|
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal |
Field Summary | |
---|---|
QSignalEmitter.Signal1 |
blockCountChanged
This signal takes 1 generic argument(s). |
QSignalEmitter.Signal3 |
contentsChange
This signal takes 3 generic argument(s). |
QSignalEmitter.Signal0 |
contentsChanged
This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied. |
QSignalEmitter.Signal1 |
cursorPositionChanged
This signal takes 1 generic argument(s). |
QSignalEmitter.Signal0 |
documentLayoutChanged
This signal is emitted when a new document layout is set. |
QSignalEmitter.Signal1 |
modificationChanged
This signal takes 1 generic argument(s). |
QSignalEmitter.Signal1 |
redoAvailable
This signal takes 1 generic argument(s). |
QSignalEmitter.Signal1 |
undoAvailable
This signal takes 1 generic argument(s). |
QSignalEmitter.Signal0 |
undoCommandAdded
This signal is emitted every time a new level of undo is added to the QTextDocument. |
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal |
---|
currentSender |
Constructor Summary | |
---|---|
QTextDocument()
Constructs an empty QTextDocument with the given parent. |
|
QTextDocument(QObject parent)
Constructs an empty QTextDocument with the given parent. |
|
QTextDocument(java.lang.String text)
Constructs a QTextDocument containing the plain (unformatted) text specified, and with the given parent. |
|
QTextDocument(java.lang.String text,
QObject parent)
Constructs a QTextDocument containing the plain (unformatted) text specified, and with the given parent. |
Method Summary | |
---|---|
void |
addResource(int type,
QUrl name,
java.lang.Object resource)
Adds the resource resource to the resource cache, using type and name as identifiers. |
void |
adjustSize()
Adjusts the document to a reasonable size. |
java.util.List |
allFormats()
Returns a vector of text formats for all the formats used in the document. |
QTextBlock |
begin()
Returns the document's first text block. |
int |
blockCount()
Returns the number of text blocks in the document. |
char |
characterAt(int pos)
Returns the character at position pos, or a null character if the position is out of range. |
int |
characterCount()
Returns the number of characters of this document. |
void |
clear()
Clears the document. |
QTextDocument |
clone()
This method is reimplemented for internal reasons |
QTextDocument |
clone(QObject parent)
This method is reimplemented for internal reasons |
protected QTextObject |
createObject(QTextFormat f)
Creates and returns a new document object (a QTextObject ), based on the given format. |
QFont |
defaultFont()
This property holds the default font used to display the document's text. |
java.lang.String |
defaultStyleSheet()
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() . |
QTextOption |
defaultTextOption()
This property holds the default text option will be set on all QTextLayout s in the document.. |
QAbstractTextDocumentLayout |
documentLayout()
Returns the document layout for this document. |
double |
documentMargin()
The margin around the document. |
void |
drawContents(QPainter painter)
Draws the content of the document with painter p, clipped to rect. |
void |
drawContents(QPainter painter,
QRectF rect)
Draws the content of the document with painter p, clipped to rect. |
QTextBlock |
end()
This function returns a block to test for the end of the document while iterating over it. |
QTextCursor |
find(QRegExp expr)
This is an overloaded member function, provided for convenience. |
QTextCursor |
find(QRegExp expr,
int from)
This is an overloaded member function, provided for convenience. |
QTextCursor |
find(QRegExp expr,
int from,
QTextDocument.FindFlag[] options)
This is an overloaded method provided for convenience. |
QTextCursor |
find(QRegExp expr,
int from,
QTextDocument.FindFlags options)
This is an overloaded member function, provided for convenience. |
QTextCursor |
find(QRegExp expr,
QTextCursor from)
Finds the next occurrence, matching the regular expression, expr, in the document. |
QTextCursor |
find(QRegExp expr,
QTextCursor from,
QTextDocument.FindFlag[] options)
This is an overloaded method provided for convenience. |
QTextCursor |
find(QRegExp expr,
QTextCursor from,
QTextDocument.FindFlags options)
Finds the next occurrence, matching the regular expression, expr, in the document. |
QTextCursor |
find(java.lang.String subString)
This is an overloaded member function, provided for convenience. |
QTextCursor |
find(java.lang.String subString,
int from)
This is an overloaded member function, provided for convenience. |
QTextCursor |
find(java.lang.String subString,
int from,
QTextDocument.FindFlag[] options)
This is an overloaded method provided for convenience. |
QTextCursor |
find(java.lang.String subString,
int from,
QTextDocument.FindFlags options)
This is an overloaded member function, provided for convenience. |
QTextCursor |
find(java.lang.String subString,
QTextCursor from)
Finds the next occurrence of the string, subString, in the document. |
QTextCursor |
find(java.lang.String subString,
QTextCursor from,
QTextDocument.FindFlag[] options)
This is an overloaded method provided for convenience. |
QTextCursor |
find(java.lang.String subString,
QTextCursor from,
QTextDocument.FindFlags options)
Finds the next occurrence of the string, subString, in the document. |
QTextBlock |
findBlock(int pos)
Returns the text block that contains the pos-th character. |
QTextBlock |
findBlockByLineNumber(int blockNumber)
Returns the text block that contains the specified lineNumber. |
QTextBlock |
findBlockByNumber(int blockNumber)
Returns the text block with the specified blockNumber. |
QTextBlock |
firstBlock()
Returns the document's first text block. |
double |
idealWidth()
Returns the ideal width of the text document. |
double |
indentWidth()
Returns the width used for text list and text block indenting. |
boolean |
isEmpty()
Returns true if the document is empty; otherwise returns false. |
boolean |
isModified()
This property holds whether the document has been modified by the user. |
boolean |
isRedoAvailable()
Returns true if redo is available; otherwise returns false. |
boolean |
isUndoAvailable()
Returns true if undo is available; otherwise returns false. |
boolean |
isUndoRedoEnabled()
This property holds whether undo/redo are enabled for this document. |
QTextBlock |
lastBlock()
Returns the document's last (valid) text block. |
int |
lineCount()
Returns the number of lines of this document (if the layout supports this). |
protected java.lang.Object |
loadResource(int type,
QUrl name)
Loads data of the specified type from the resource with the given name. |
void |
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. |
int |
maximumBlockCount()
This property Specifies the limit for blocks in the document. |
java.lang.String |
metaInformation(QTextDocument.MetaInformation info)
Returns meta information about the document of the type specified by info. |
QTextObject |
object(int objectIndex)
Returns the text object associated with the given objectIndex. |
QTextObject |
objectForFormat(QTextFormat arg__1)
Returns the text object associated with the format f. |
int |
pageCount()
returns the number of pages in this document. |
QSizeF |
pageSize()
This property holds the page size that should be used for laying out the document. |
void |
print(QPrinter printer)
Prints the document to the given printer. |
void |
redo()
This is an overloaded member function, provided for convenience. |
void |
redo(QTextCursor cursor)
Redoes the last editing operation on the document if QTextDocument.isRedoAvailable() redo is available. |
java.lang.Object |
resource(int type,
QUrl name)
Returns data of the specified type from the resource with the given name. |
int |
revision()
Returns the document's revision (if undo is enabled). |
QTextFrame |
rootFrame()
Returns the document's root frame. |
void |
setDefaultFont(QFont font)
This property holds the default font used to display the document's text. |
void |
setDefaultStyleSheet(java.lang.String sheet)
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() . |
void |
setDefaultTextOption(QTextOption option)
This property holds the default text option will be set on all QTextLayout s in the document.. |
void |
setDocumentLayout(QAbstractTextDocumentLayout layout)
Sets the document to use the given layout. |
void |
setDocumentMargin(double margin)
The margin around the document. |
void |
setHtml(java.lang.String html)
Replaces the entire contents of the document with the given HTML-formatted text in the html string. |
void |
setIndentWidth(double width)
Returns the width used for text list and text block indenting. |
void |
setMaximumBlockCount(int maximum)
This property Specifies the limit for blocks in the document. |
void |
setMetaInformation(QTextDocument.MetaInformation info,
java.lang.String arg__2)
Sets the document's meta information of the type specified by info to the given string. |
void |
setModified()
This property holds whether the document has been modified by the user. |
void |
setModified(boolean m)
This property holds whether the document has been modified by the user. |
void |
setPageSize(QSizeF size)
This property holds the page size that should be used for laying out the document. |
void |
setPlainText(java.lang.String text)
Replaces the entire contents of the document with the given plain text. |
void |
setTextWidth(double width)
The text width specifies the preferred width for text in the document. |
void |
setUndoRedoEnabled(boolean enable)
This property holds whether undo/redo are enabled for this document. |
void |
setUseDesignMetrics(boolean b)
If b is true then the layout will use design metrics; otherwise it will use the metrics of the paint device (which is the default behavior). |
QSizeF |
size()
Returns the actual size of the document. |
double |
textWidth()
The text width specifies the preferred width for text in the document. |
java.lang.String |
toHtml()
Returns a string containing an HTML representation of the document. |
java.lang.String |
toHtml(QByteArray encoding)
Returns a string containing an HTML representation of the document. |
java.lang.String |
toPlainText()
Returns the plain text contained in the document. |
void |
undo()
This is an overloaded member function, provided for convenience. |
void |
undo(QTextCursor cursor)
Undoes the last editing operation on the document if undo is available. |
boolean |
useDesignMetrics()
Returns true if this QTextDocument uses design metrics. |
Methods inherited from class com.trolltech.qt.core.QObject |
---|
childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread |
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal |
---|
__qt_signalInitialization |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Field Detail |
---|
public final QSignalEmitter.Signal1 blockCountChanged
This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <java.lang.Integer(named: newBlockCount)>:
This signal is emitted when the total number of text blocks in the document changes. The value passed in newBlockCount is the new total.
public final QSignalEmitter.Signal3 contentsChange
This signal takes 3 generic argument(s). We list their type and the name they go by in the description of this signal. <java.lang.Integer(named: position), java.lang.Integer(named: charsRemoved), java.lang.Integer(named: charsAdded)>:
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.
QAbstractTextDocumentLayout::documentChanged()
, and contentsChanged()
.
public final QSignalEmitter.Signal0 contentsChanged
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.
QAbstractTextDocumentLayout::documentChanged()
, and contentsChanged()
.
public final QSignalEmitter.Signal1 cursorPositionChanged
This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <com.trolltech.qt.gui.QTextCursor(named: cursor)>:
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
.
public final QSignalEmitter.Signal0 documentLayoutChanged
setDocumentLayout()
.
public final QSignalEmitter.Signal1 modificationChanged
This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <java.lang.Boolean(named: changed)>:
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.
public final QSignalEmitter.Signal1 redoAvailable
This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <java.lang.Boolean(named: available)>:
This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false).
public final QSignalEmitter.Signal1 undoAvailable
This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <java.lang.Boolean(named: available)>:
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.
undo()
, and isUndoRedoEnabled()
.
public final QSignalEmitter.Signal0 undoCommandAdded
Constructor Detail |
---|
public QTextDocument()
public QTextDocument(QObject parent)
public QTextDocument(java.lang.String text)
public QTextDocument(java.lang.String text, QObject parent)
Method Detail |
---|
public final void addResource(int type, QUrl name, java.lang.Object resource)
QTextDocument::ResourceType
. For example, you can add an image as a resource in order to reference it from within the document:
The following code example is written in c++.
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\" />");
public final void adjustSize()
idealWidth()
, textWidth
, and size
.
public final java.util.List allFormats()
public final QTextBlock begin()
firstBlock()
.
public final int blockCount()
The value of this property is undefined in documents with tables or frames.
By default, if defined, this property contains a value of 1.
lineCount()
, and characterCount()
.
public final char characterAt(int pos)
characterCount()
.
public final int characterCount()
blockCount()
, and characterAt()
.
public final QTextDocument clone()
clone
in class java.lang.Object
public final QTextDocument clone(QObject parent)
public final QFont defaultFont()
public final java.lang.String defaultStyleSheet()
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.
public final QTextOption defaultTextOption()
QTextLayout
s in the document.. When QTextBlock
s are created, the defaultTextOption
is set on their QTextLayout
. This allows setting global properties for the document such as the default word wrap mode.
public final QAbstractTextDocumentLayout documentLayout()
setDocumentLayout()
.
public final double documentMargin()
public final void drawContents(QPainter painter)
public final void drawContents(QPainter painter, QRectF rect)
public final QTextBlock end()
for (QTextBlock it = doc.begin(); it != doc.end(); it = it.next()) System.out.println(it.text());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. lastBlock()
.
public final QTextCursor find(QRegExp expr, QTextCursor from, QTextDocument.FindFlag[] options)
public final QTextCursor find(QRegExp expr, QTextCursor from)
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.
public final QTextCursor find(QRegExp expr, QTextCursor from, QTextDocument.FindFlags options)
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.
public final QTextCursor find(QRegExp expr, int from, QTextDocument.FindFlag[] options)
public final QTextCursor find(QRegExp expr, int from)
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.
public final QTextCursor find(QRegExp expr)
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.
public final QTextCursor find(QRegExp expr, int from, QTextDocument.FindFlags options)
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.
public final QTextCursor find(java.lang.String subString, QTextCursor from, QTextDocument.FindFlag[] options)
public final QTextCursor find(java.lang.String subString, QTextCursor from)
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.
public final QTextCursor find(java.lang.String subString, QTextCursor from, QTextDocument.FindFlags options)
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.
public final QTextCursor find(java.lang.String subString, int from, QTextDocument.FindFlag[] options)
public final QTextCursor find(java.lang.String subString, int from)
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.
public final QTextCursor find(java.lang.String subString)
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.
public final QTextCursor find(java.lang.String subString, int from, QTextDocument.FindFlags options)
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.
public final QTextBlock findBlock(int pos)
public final QTextBlock findBlockByLineNumber(int blockNumber)
QTextBlock::firstLineNumber()
.
public final QTextBlock findBlockByNumber(int blockNumber)
QTextBlock::blockNumber()
.
public final QTextBlock firstBlock()
public final double idealWidth()
size()
.width(). adjustSize()
, and textWidth
.
public final double indentWidth()
The indent properties of QTextListFormat
and QTextBlockFormat
specify multiples of this value. The default indent width is 40.
public final boolean isEmpty()
public final boolean isModified()
modificationChanged()
.
public final boolean isRedoAvailable()
public final boolean isUndoAvailable()
public final boolean isUndoRedoEnabled()
public final QTextBlock lastBlock()
public final int lineCount()
blockCount()
, and characterCount()
.
public final void markContentsDirty(int from, int length)
public final int maximumBlockCount()
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.
public final java.lang.String metaInformation(QTextDocument.MetaInformation info)
setMetaInformation()
.
public final QTextObject object(int objectIndex)
public final QTextObject objectForFormat(QTextFormat arg__1)
public final int pageCount()
public final QSizeF pageSize()
modificationChanged()
.
public final void print(QPrinter printer)
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.
QTextEdit::print()
.
public final void redo()
Redoes the last editing operation on the document if redo is available
.
public final java.lang.Object resource(int type, QUrl 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.
QTextDocument::ResourceType
.
public final int revision()
The revision is guaranteed to increase when a document that is not modified is edited.
QTextBlock::revision()
, and isModified()
.
public final QTextFrame rootFrame()
public final void setDefaultFont(QFont font)
public final void setDefaultStyleSheet(java.lang.String sheet)
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.
public final void setDefaultTextOption(QTextOption option)
QTextLayout
s in the document.. When QTextBlock
s are created, the defaultTextOption
is set on their QTextLayout
. This allows setting global properties for the document such as the default word wrap mode.
public final void setDocumentLayout(QAbstractTextDocumentLayout layout)
documentLayoutChanged()
.
public final void setDocumentMargin(double margin)
public final void setHtml(java.lang.String html)
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()
.
setPlainText()
, and Supported HTML Subset.
public final void setIndentWidth(double width)
The indent properties of QTextListFormat
and QTextBlockFormat
specify multiples of this value. The default indent width is 40.
public final void setMaximumBlockCount(int maximum)
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.
public final void setMetaInformation(QTextDocument.MetaInformation info, java.lang.String arg__2)
metaInformation()
.
public final void setModified()
modificationChanged()
.
public final void setModified(boolean m)
modificationChanged()
.
public final void setPageSize(QSizeF size)
modificationChanged()
.
public final void setPlainText(java.lang.String text)
setHtml()
.
public final void setTextWidth(double width)
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.
size()
, idealWidth()
, and pageSize()
.
public final void setUndoRedoEnabled(boolean enable)
public final void setUseDesignMetrics(boolean b)
public final QSizeF size()
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.
setTextWidth()
, setPageSize()
, and idealWidth()
.
public final double textWidth()
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.
size()
, idealWidth()
, and pageSize()
.
public final java.lang.String toHtml()
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:Error parsing snippet. 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.
public final java.lang.String toHtml(QByteArray encoding)
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:Error parsing snippet. 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.
public final java.lang.String toPlainText()
QTextCursor
instead. toHtml()
.
public final void undo()
public final boolean useDesignMetrics()
public void clear()
protected QTextObject createObject(QTextFormat f)
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.
protected java.lang.Object loadResource(int type, QUrl 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.
public final void redo(QTextCursor cursor)
The provided cursor is positioned at the end of the location where the edition operation was redone.
public final void undo(QTextCursor cursor)
See the \l {Overview of Qt's Undo Framework}{Qt Undo Framework} documentation for details.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |