|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.gui.QTextCursor
public class QTextCursor
The QTextCursor class offers an API to access and modify QTextDocuments.
Text cursors are objects that are used to access and modify the contents and underlying structure of text documents via a programming interface that mimics the behavior of a cursor in a text editor. QTextCursor contains information about both the cursor's position within a QTextDocument and any selection that it has made.
QTextCursor is modeled on the way a text cursor behaves in a text editor, providing a programmatic means of performing standard actions through the user interface. A document can be thought of as a single string of characters with the cursor's position being between any two characters (or at the very beginning or very end of the document). Documents can also contain tables, lists, images, and other objects in addition to text but, from the developer's point of view, the document can be treated as one long string. Some portions of that string can be considered to lie within particular blocks (e.g. paragraphs), or within a table's cell, or a list's item, or other structural elements. When we refer to "current character" we mean the character immediately after the cursor position in the document; similarly the "current block" is the block that contains the cursor position.
A QTextCursor also has an anchor position. The text that is between the anchor and the position is the selection. If anchor == position there is no selection.
The cursor position can be changed programmatically using setPosition and movePosition; the latter can also be used to select text. For selections see selectionStart, selectionEnd, hasSelection, clearSelection, and removeSelectedText.
If the position is at the start of a block atBlockStart returns true; and if it is at the end of a block atBlockEnd returns true. The format of the current character is returned by charFormat, and the format of the current block is returned by blockFormat.
Formatting can be applied to the current text document using the setCharFormat, mergeCharFormat, setBlockFormat and mergeBlockFormat functions. The 'set' functions will replace the cursor's current character or block format, while the 'merge' functions add the given format properties to the cursor's current format. If the cursor has a selection the given format is applied to the current selection. Note that when only parts of a block is selected the block format is applied to the entire block. The text at the current character position can be turned into a list using createList.
Deletions can be achieved using deleteChar, deletePreviousChar, and removeSelectedText.
Text strings can be inserted into the document with the insertText function, blocks (representing new paragraphs) can be inserted with insertBlock.
Existing fragments of text can be inserted with insertFragment but, if you want to insert pieces of text in various formats, it is usually still easier to use insertText and supply a character format.
Various types of higher-level structure can also be inserted into the document with the cursor:
Actions can be grouped (i.e. treated as a single action for undo/redo) using beginEditBlock and endEditBlock.
Cursor movements are limited to valid cursor positions. In Latin writing this is usually after every character in the text. In some other writing systems cursor movements are limited to "clusters" (e.g. a syllable in Devanagari, or a base letter plus diacritics). Functions such as movePosition and deleteChar limit cursor movement to these valid positions.
Nested Class Summary | |
---|---|
static class |
QTextCursor.MoveMode
If the anchor is kept where it is and the position is moved, the text in between will be selected. |
static class |
QTextCursor.MoveOperation
Press link for info on QTextCursor.MoveOperation |
static class |
QTextCursor.SelectionType
This enum describes the types of selection that can be applied with the select function. |
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter |
---|
QSignalEmitter.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1<A>, QSignalEmitter.Signal2<A,B>, QSignalEmitter.Signal3<A,B,C>, QSignalEmitter.Signal4<A,B,C,D>, QSignalEmitter.Signal5<A,B,C,D,E>, QSignalEmitter.Signal6<A,B,C,D,E,F>, QSignalEmitter.Signal7<A,B,C,D,E,F,G>, QSignalEmitter.Signal8<A,B,C,D,E,F,G,H>, QSignalEmitter.Signal9<A,B,C,D,E,F,G,H,I> |
Constructor Summary | |
---|---|
QTextCursor()
Constructs a null cursor. |
|
QTextCursor(QTextBlock block)
Constructs a cursor pointing to the beginning of the block. |
|
QTextCursor(QTextCursor cursor)
Constructs a new cursor that is a copy of cursor. |
|
QTextCursor(QTextDocument document)
Constructs a cursor pointing to the beginning of the document. |
|
QTextCursor(QTextFrame frame)
Constructs a cursor pointing to the beginning of the frame. |
Method Summary | |
---|---|
int |
anchor()
Returns the anchor position; this is the same as position unless there is a selection in which case position marks one end of the selection and anchor marks the other end. |
boolean |
atBlockEnd()
Returns true if the cursor is at the end of a block; otherwise returns false. |
boolean |
atBlockStart()
Returns true if the cursor is at the start of a block; otherwise returns false. |
boolean |
atEnd()
Returns true if the cursor is at the end of the document; otherwise returns false. |
boolean |
atStart()
Returns true if the cursor is at the start of the document; otherwise returns false. |
void |
beginEditBlock()
Indicates the start of a block of editing operations on the document that should appear as a single operation from an undo/redo point of view. |
QTextBlock |
block()
Returns the block that contains the cursor. |
QTextCharFormat |
blockCharFormat()
Returns the block character format of the block the cursor is in. |
QTextBlockFormat |
blockFormat()
Returns the block format of the block the cursor is in. |
int |
blockNumber()
Returns the number of the block the cursor is in. |
QTextCharFormat |
charFormat()
Returns the format of the character immediately before the cursor position. |
void |
clearSelection()
Clears the current selection by setting the anchor to the cursor position. |
int |
columnNumber()
Returns the position of the cursor within its containing line. |
int |
compareTo(java.lang.Object other)
|
QTextList |
createList(QTextListFormat.Style style)
Creates and returns a new list with the given style, making the cursor's current paragraph the first list item. |
QTextList |
createList(QTextListFormat format)
Creates and returns a new list with the given format, and makes the current paragraph the cursor is in the first list item. |
QTextFrame |
currentFrame()
Returns a pointer to the current frame. |
QTextList |
currentList()
Returns the current list if the cursor position is inside a block that is part of a list; otherwise returns 0. |
QTextTable |
currentTable()
Returns a pointer to the current table if the cursor position is inside a block that is part of a table; otherwise returns 0. |
void |
deleteChar()
If there is no selected text, deletes the character at the current cursor position; otherwise deletes the selected text. |
void |
deletePreviousChar()
If there is no selected text, deletes the character before the current cursor position; otherwise deletes the selected text. |
void |
endEditBlock()
Indicates the end of a block of editing operations on the document that should appear as a single operation from an undo/redo point of view. |
boolean |
equals(java.lang.Object other)
|
static QTextCursor |
fromNativePointer(QNativePointer nativePointer)
This function returns the QTextCursor instance pointed to by nativePointer |
boolean |
hasComplexSelection()
Returns true if the cursor contains a selection that is not simply a range from selectionStart to selectionEnd; otherwise returns false. |
boolean |
hasSelection()
Returns true if the cursor contains a selection; otherwise returns false. |
void |
insertBlock()
Inserts a new empty block at the cursor position with the current blockFormat and charFormat. |
void |
insertBlock(QTextBlockFormat format)
Inserts a new empty block at the cursor position with block format format and the current charFormat as block char format. |
void |
insertBlock(QTextBlockFormat format,
QTextCharFormat charFormat)
Inserts a new empty block at the cursor position with block format format and charFormat as block char format. |
void |
insertFragment(QTextDocumentFragment fragment)
Inserts the text fragment at the current position. |
QTextFrame |
insertFrame(QTextFrameFormat format)
Inserts a frame with the given format at the current cursor position, moves the cursor position inside the frame, and returns the frame. |
void |
insertHtml(java.lang.String html)
Inserts the text html at the current position. |
void |
insertImage(QTextImageFormat format)
Inserts the image defined by format at the current position. |
void |
insertImage(QTextImageFormat format,
QTextFrameFormat.Position alignment)
Inserts the image defined by the given format at the cursor's current position with the specified alignment. |
void |
insertImage(java.lang.String name)
Convenience method for inserting the image with the given name at the current position. |
QTextList |
insertList(QTextListFormat.Style style)
Inserts a new block at the current position and makes it the first list item of a newly created list with the given style. |
QTextList |
insertList(QTextListFormat format)
Inserts a new block at the current position and makes it the first list item of a newly created list with the given format. |
QTextTable |
insertTable(int rows,
int cols)
Creates a new table with the given number of rows and cols, inserts it at the current cursor position in the document, and returns the table object. |
QTextTable |
insertTable(int rows,
int cols,
QTextTableFormat format)
Creates a new table with the given number of rows and cols in the specified format, inserts it at the current cursor position in the document, and returns the table object. |
void |
insertText(java.lang.String text)
Inserts text at the current position, using the current character format. |
void |
insertText(java.lang.String text,
QTextCharFormat format)
Inserts text at the current position with the given format. |
boolean |
isCopyOf(QTextCursor other)
Returns true if this cursor and other are copies of each other, i.e. one of them was created as a copy of the other and neither has moved since. |
boolean |
isNull()
Returns true if the cursor is null; otherwise returns false. |
void |
joinPreviousEditBlock()
Like beginEditBlock indicates the start of a block of editing operations that should appear as a single operation for undo/redo. |
void |
mergeBlockCharFormat(QTextCharFormat modifier)
Modifies the block char format of the current block (or all blocks that are contained in the selection) with the block format specified by modifier. |
void |
mergeBlockFormat(QTextBlockFormat modifier)
Modifies the block format of the current block (or all blocks that are contained in the selection) with the block format specified by modifier. |
void |
mergeCharFormat(QTextCharFormat modifier)
Merges the cursor's current character format with the properties described by format modifier. |
boolean |
movePosition(QTextCursor.MoveOperation op)
Equivalent to movePosition(op, MoveAnchor, 1). |
boolean |
movePosition(QTextCursor.MoveOperation op,
QTextCursor.MoveMode arg__2)
Equivalent to movePosition(op, arg__2, 1). |
boolean |
movePosition(QTextCursor.MoveOperation op,
QTextCursor.MoveMode arg__2,
int n)
Moves the cursor by performing the given op n times, using the specified arg__2, and returns true if all operations were completed successfully; otherwise returns false. |
static QNativePointer |
nativePointerArray(QTextCursor[] array)
This function returns a QNativePointer that is pointing to the specified QTextCursor array. |
int |
position()
Returns the absolute position of the cursor within the document. |
void |
removeSelectedText()
If there is a selection, its content is deleted; otherwise does nothing. |
void |
select(QTextCursor.SelectionType selection)
Selects text in the document according to the given selection. |
QTableArea |
selectedTableCells()
Returns the selected table cells as a QTableArea. |
java.lang.String |
selectedText()
Returns the current selection's text (which may be empty). |
QTextDocumentFragment |
selection()
Returns the current selection (which may be empty) with all its formatting information. |
int |
selectionEnd()
Returns the end of the selection or position if the cursor doesn't have a selection. |
int |
selectionStart()
Returns the start of the selection or position if the cursor doesn't have a selection. |
void |
setBlockCharFormat(QTextCharFormat format)
Sets the block char format of the current block (or all blocks that are contained in the selection) to format. |
void |
setBlockFormat(QTextBlockFormat format)
Sets the block format of the current block (or all blocks that are contained in the selection) to format. |
void |
setCharFormat(QTextCharFormat format)
Sets the cursor's current character format to the given format. |
void |
setPosition(int pos)
Equivalent to setPosition(pos, MoveAnchor). |
void |
setPosition(int pos,
QTextCursor.MoveMode mode)
Moves the cursor to the absolute position in the document specified by pos using a MoveMode specified by mode. |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread |
Methods inherited from class java.lang.Object |
---|
clone, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Constructor Detail |
---|
public QTextCursor(QTextFrame frame)
Constructs a cursor pointing to the beginning of the frame.
public QTextCursor(QTextCursor cursor)
Constructs a new cursor that is a copy of cursor.
public QTextCursor()
Constructs a null cursor.
public QTextCursor(QTextBlock block)
Constructs a cursor pointing to the beginning of the block.
public QTextCursor(QTextDocument document)
Constructs a cursor pointing to the beginning of the document.
Method Detail |
---|
public final int anchor()
Returns the anchor position; this is the same as position unless there is a selection in which case position marks one end of the selection and anchor marks the other end. Just like the cursor position, the anchor position is between characters.
public final boolean atBlockEnd()
Returns true if the cursor is at the end of a block; otherwise returns false.
public final boolean atBlockStart()
Returns true if the cursor is at the start of a block; otherwise returns false.
public final boolean atEnd()
Returns true if the cursor is at the end of the document; otherwise returns false.
public final boolean atStart()
Returns true if the cursor is at the start of the document; otherwise returns false.
public final void beginEditBlock()
Indicates the start of a block of editing operations on the document that should appear as a single operation from an undo/redo point of view.
For example:
QTextCursor cursor(textDocument); cursor.beginEditBlock(); cursor.insertText("Hello"); cursor.insertText("World"); cursor.endEditBlock(); textDocument->undo();
The call to undo() will cause both insertions to be undone, causing both "World" and "Hello" to be removed.
public final QTextBlock block()
Returns the block that contains the cursor.
public final QTextCharFormat blockCharFormat()
Returns the block character format of the block the cursor is in.
The block char format is the format used when inserting text at the beginning of an empty block.
public final QTextBlockFormat blockFormat()
Returns the block format of the block the cursor is in.
public final int blockNumber()
Returns the number of the block the cursor is in.
Note that this function only makes sense in documents without complex objects such as tables or frames.
public final QTextCharFormat charFormat()
Returns the format of the character immediately before the cursor position. If the cursor is positioned at the beginning of a text block that is not empty then the format of the character immediately after the cursor is returned.
public final void clearSelection()
Clears the current selection by setting the anchor to the cursor position.
Note that it does not delete the text of the selection.
public final int columnNumber()
Returns the position of the cursor within its containing line.
public final QTextList createList(QTextListFormat format)
Creates and returns a new list with the given format, and makes the current paragraph the cursor is in the first list item.
public final QTextList createList(QTextListFormat.Style style)
Creates and returns a new list with the given style, making the cursor's current paragraph the first list item.
The style to be used is defined by the QTextListFormat::Style enum.
public final QTextFrame currentFrame()
Returns a pointer to the current frame. Returns 0 if the cursor is invalid.
public final QTextList currentList()
Returns the current list if the cursor position is inside a block that is part of a list; otherwise returns 0.
public final QTextTable currentTable()
Returns a pointer to the current table if the cursor position is inside a block that is part of a table; otherwise returns 0.
public final void deleteChar()
If there is no selected text, deletes the character at the current cursor position; otherwise deletes the selected text.
public final void deletePreviousChar()
If there is no selected text, deletes the character before the current cursor position; otherwise deletes the selected text.
public final void endEditBlock()
Indicates the end of a block of editing operations on the document that should appear as a single operation from an undo/redo point of view.
public final boolean hasComplexSelection()
Returns true if the cursor contains a selection that is not simply a range from selectionStart to selectionEnd; otherwise returns false.
Complex selections are ones that span at least two cells in a table; their extent is specified by selectedTableCells().
public final boolean hasSelection()
Returns true if the cursor contains a selection; otherwise returns false.
public final void insertBlock(QTextBlockFormat format)
Inserts a new empty block at the cursor position with block format format and the current charFormat as block char format.
public final void insertBlock(QTextBlockFormat format, QTextCharFormat charFormat)
Inserts a new empty block at the cursor position with block format format and charFormat as block char format.
public final void insertBlock()
Inserts a new empty block at the cursor position with the current blockFormat and charFormat.
public final void insertFragment(QTextDocumentFragment fragment)
Inserts the text fragment at the current position.
public final QTextFrame insertFrame(QTextFrameFormat format)
Inserts a frame with the given format at the current cursor position, moves the cursor position inside the frame, and returns the frame.
If the cursor holds a selection, the whole selection is moved inside the frame.
public final void insertHtml(java.lang.String html)
Inserts the text html at the current position. The text is interpreted as HTML.
Note: When using this function with a style sheet, the style sheet will only apply to the current block in the document. In order to apply a style sheet throughout a document, use QTextDocument::setDefaultStyleSheet() instead.
public final void insertImage(QTextImageFormat format, QTextFrameFormat.Position alignment)
Inserts the image defined by the given format at the cursor's current position with the specified alignment.
public final void insertImage(java.lang.String name)
Convenience method for inserting the image with the given name at the current position.
QImage img = ... textDocument->addResource(QTextDocument::ImageResource, QUrl("myimage"), img); cursor.insertImage("myimage");
public final void insertImage(QTextImageFormat format)
Inserts the image defined by format at the current position.
public final QTextList insertList(QTextListFormat format)
Inserts a new block at the current position and makes it the first list item of a newly created list with the given format. Returns the created list.
public final QTextList insertList(QTextListFormat.Style style)
Inserts a new block at the current position and makes it the first list item of a newly created list with the given style. Returns the created list.
public final QTextTable insertTable(int rows, int cols, QTextTableFormat format)
Creates a new table with the given number of rows and cols in the specified format, inserts it at the current cursor position in the document, and returns the table object. The cursor is moved to the beginning of the first cell.
There must be at least one row and one column in the table.
public final QTextTable insertTable(int rows, int cols)
Creates a new table with the given number of rows and cols, inserts it at the current cursor position in the document, and returns the table object. The cursor is moved to the beginning of the first cell.
There must be at least one row and one column in the table.
public final void insertText(java.lang.String text)
Inserts text at the current position, using the current character format.
If there is a selection, the selection is deleted and replaced by text, for example:
cursor.clearSelection(); cursor.movePosition(QTextCursor::NextWord, QTextCursor::KeepAnchor); cursor.insertText("Hello World");
This clears any existing selection, selects the word at the cursor (i.e. from position forward), and replaces the selection with the phrase "Hello World".
Any ASCII linefeed characters (\n) in the inserted text are transformed into unicode block separators, corresponding to insertBlock calls.
public final void insertText(java.lang.String text, QTextCharFormat format)
Inserts text at the current position with the given format.
public final boolean isCopyOf(QTextCursor other)
Returns true if this cursor and other are copies of each other, i.e. one of them was created as a copy of the other and neither has moved since. This is much stricter than equality.
public final boolean isNull()
Returns true if the cursor is null; otherwise returns false. A null cursor is created by the default constructor.
public final void joinPreviousEditBlock()
Like beginEditBlock indicates the start of a block of editing operations that should appear as a single operation for undo/redo. However unlike beginEditBlock it does not start a new block but reverses the previous call to endEditBlock and therefore makes following operations part of the previous edit block created.
For example:
QTextCursor cursor(textDocument); cursor.beginEditBlock(); cursor.insertText("Hello"); cursor.insertText("World"); cursor.endEditBlock(); ... cursor.joinPreviousEditBlock(); cursor.insertText("Hey"); cursor.endEditBlock(); textDocument->undo();
The call to undo() will cause all three insertions to be undone.
public final void mergeBlockCharFormat(QTextCharFormat modifier)
Modifies the block char format of the current block (or all blocks that are contained in the selection) with the block format specified by modifier.
public final void mergeBlockFormat(QTextBlockFormat modifier)
Modifies the block format of the current block (or all blocks that are contained in the selection) with the block format specified by modifier.
public final void mergeCharFormat(QTextCharFormat modifier)
Merges the cursor's current character format with the properties described by format modifier. If the cursor has a selection, this function applies all the properties set in modifier to all the character formats that are part of the selection.
public final boolean movePosition(QTextCursor.MoveOperation op, QTextCursor.MoveMode arg__2)
Equivalent to movePosition(op, arg__2, 1).
public final boolean movePosition(QTextCursor.MoveOperation op)
Equivalent to movePosition(op, MoveAnchor, 1).
public final boolean movePosition(QTextCursor.MoveOperation op, QTextCursor.MoveMode arg__2, int n)
Moves the cursor by performing the given op n times, using the specified arg__2, and returns true if all operations were completed successfully; otherwise returns false.
For example, if this function is repeatedly used to seek to the end of the next word, it will eventually fail when the end of the document is reached.
By default, the move operation is performed once (n = 1).
If arg__2 is KeepAnchor, the cursor selects the text it moves over. This is the same effect that the user achieves when they hold down the Shift key and move the cursor with the cursor keys.
public final int position()
Returns the absolute position of the cursor within the document. The cursor is positioned between characters.
public final void removeSelectedText()
If there is a selection, its content is deleted; otherwise does nothing.
public final void select(QTextCursor.SelectionType selection)
Selects text in the document according to the given selection.
public final java.lang.String selectedText()
Returns the current selection's text (which may be empty). This only returns the text, with no rich text formatting information. If you want a document fragment (i.e. formatted rich text) use selection instead.
Note: If the selection obtained from an editor spans a line break, the text will contain a Unicode U+2029 paragraph separator character instead of a newline \n character. Use QString::replace() to replace these characters with newlines.
public final QTextDocumentFragment selection()
Returns the current selection (which may be empty) with all its formatting information. If you just want the selected text (i.e. plain text) use selectedText instead.
Note: Unlike QTextDocumentFragment::toPlainText(), selectedText may include special unicode characters such as QChar::ParagraphSeparator.
public final int selectionEnd()
Returns the end of the selection or position if the cursor doesn't have a selection.
public final int selectionStart()
Returns the start of the selection or position if the cursor doesn't have a selection.
public final void setBlockCharFormat(QTextCharFormat format)
Sets the block char format of the current block (or all blocks that are contained in the selection) to format.
public final void setBlockFormat(QTextBlockFormat format)
Sets the block format of the current block (or all blocks that are contained in the selection) to format.
public final void setCharFormat(QTextCharFormat format)
Sets the cursor's current character format to the given format. If the cursor has a selection, the given format is applied to the current selection.
public final void setPosition(int pos)
Equivalent to setPosition(pos, MoveAnchor).
public final void setPosition(int pos, QTextCursor.MoveMode mode)
Moves the cursor to the absolute position in the document specified by pos using a MoveMode specified by mode. The cursor is positioned between characters.
public static QTextCursor fromNativePointer(QNativePointer nativePointer)
nativePointer
- the QNativePointer of which object should be returned.public static QNativePointer nativePointerArray(QTextCursor[] array)
array
- the array that the returned pointer will point to.
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public int compareTo(java.lang.Object other)
compareTo
in interface java.lang.Comparable
public final QTableArea selectedTableCells()
|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |