Member Function Documentation

[protected] Document::Document(KTextEditor::DocumentPrivate *impl, const KPluginMetaData &data, QObject *parent)

Constructor.

Create a new document with parent.

Pass it the internal implementation to store a d-pointer.

impl is the metadata pointer to use

data is TODO

parent is the parent object

See also KTextEditor::EditorPrivate::createDocument().

[signal] void Document::aboutToClose(KTextEditor::Document *document)

Warn anyone listening that the current document is about to close. At this point all of the information is still accessible, such as the text, cursors and ranges.

Any modifications made to the document at this point will be lost.

document is the document being closed

[signal] void Document::aboutToInvalidateMovingInterfaceContent(KTextEditor::Document *document)

This signal is emitted before the ranges of a document are invalidated and the revisions are deleted as the document is cleared (for example on load/reload). While this signal is emitted, the old document content is still valid and accessible before the clear.

document is the document which the interface belongs to which will invalidate its data

[signal] void Document::aboutToReload(KTextEditor::Document *document)

Warn anyone listening that the current document is about to reload. At this point all of the information is still accessible, such as the text, cursors and ranges.

Any modifications made to the document at this point will be lost.

document is the document being reloaded

[signal, since 5.91] void Document::aboutToSave(KTextEditor::Document *document)

Emitted just before the document will be saved Any modifications made to the document at this point will get stored on disk.

document is the document that was reloaded.

This function was introduced in 5.91.

[pure virtual] void Document::addMark(int line, uint markType)

Add marks of type markType to line. Existing marks on this line are preserved. If the mark markType already is set, nothing happens.

line is the line number

markType is the mark type

See also removeMark() and setMark().

[pure virtual] KTextEditor::AnnotationModel *Document::annotationModel() const

Returns the current AnnotationModel or 0 if there's none set

See also setAnnotationModel().

[pure virtual] QChar Document::characterAt(KTextEditor::Cursor position) const

Get the character at a cursor position.

position is the location of the character to retrieve

Returns the requested character, or QChar() for invalid cursors.

See also setText().

[pure virtual] QByteArray Document::checksum() const

Get the git hash of the Document's contents on disk. The returned hash equals the git hash of the file written to disk. If the document is a remote document, the checksum may not be available. In this case, QByteArray::isNull() returns true.

git hash is defined as:

sha1("blob " + filesize + "\0" + filecontent)

Returns the git hash of the document

[pure virtual] bool Document::clear()

Remove the whole content of the document. Returns true on success, otherwise false

See also removeText() and removeLine().

[pure virtual] void Document::clearMark(int line)

Clear all marks set in the line.

line is the line number

See also KTextEditor::DocumentPrivate::clearMarks(), removeMark(), and addMark().

[pure virtual] void Document::clearMarks()

Clear all marks in the entire document.

TODO: dominik: add argument unit mask = 0

See also clearMark() and removeMark().

[signal, since 5.79] void Document::configChanged(KTextEditor::Document *document)

This signal is emitted whenever the current document configuration is changed.

document is the document reporting the configuration change

This function was introduced in 5.79.

[pure virtual] QStringList Document::configKeys() const

Get a list of all available keys.

[pure virtual] QVariant Document::configValue(const QString &key)

Get a value for the key.

See also setConfigValue().

[pure virtual] KTextEditor::View *Document::createView(QWidget *parent, KTextEditor::MainWindow *mainWindow = nullptr)

Create a new view attached to parent.

parent is the parent widget

mainWindow is the main window responsible for this view, if any

Returns the new view

[pure virtual, since 6.0] qsizetype Document::cursorToOffset(KTextEditor::Cursor c) const

Returns the offset for the given cursor position.

c is the cursor position

This function was introduced in 6.0.

[pure virtual] KSyntaxHighlighting::Theme::TextStyle Document::defaultStyleAt(KTextEditor::Cursor position) const

Get the default style of the character located at position. If position is not a valid text position, the default style KSyntaxHighlighting::Theme::TextStyle::Normal is returned.

position is the cursor position

Returns default style, see enum KSyntaxHighlighting::Theme::TextStyle

See also KTextEditor::ViewPrivate::defaultStyleAttribute() and KTextEditor::ViewPrivate::lineAttributes().

[pure virtual] void Document::discardDataRecovery()

If recover data is available, calling discardDataRecovery() will discard the recover data and the recover data is lost. If isDataRecoveryAvailable() returns false, calling this function does nothing.

See also isDataRecoveryAvailable() and recoverData().

[pure virtual] KTextEditor::Cursor Document::documentEnd() const

End position of the document. Returns The last column on the last line of the document

[pure virtual] QString Document::documentName() const

Get this document's name. The editor part should provide some meaningful name, like some unique "Untitled XYZ" for the document - without URL or basename for documents with url. Returns readable document name

[signal] void Document::documentNameChanged(KTextEditor::Document *document)

This signal is emitted whenever the document name changes.

document is document which changed its name

See also documentName().

KTextEditor::Range Document::documentRange() const

A Range which encompasses the whole document. Returns A range from the start to the end of the document

[pure virtual] bool Document::documentReload()

Reload the current file. The user will be prompted by the part on changes and more and can cancel this action if it can harm. Returns true if the reload has been done, otherwise false. If the document has no url set, it will just return false.

[pure virtual] bool Document::documentSave()

Save the current file. The user will be asked for a filename if needed and more. Returns true on success, i.e. the save has been done, otherwise false

[pure virtual] bool Document::documentSaveAs()

Save the current file to another location. The user will be asked for a filename and more. Returns true on success, i.e. the save has been done, otherwise false

[signal] void Document::documentSavedOrUploaded(KTextEditor::Document *document, bool saveAs)

This signal should be emitted after a document has been saved to disk or for remote files uploaded.

document is the document being saved or uploaded

saveAs should be set to true if the operation is a save as operation

[signal] void Document::documentUrlChanged(KTextEditor::Document *document)

This signal is emitted whenever the document URL changes.

document is the document which changed its URL

See also KParts::ReadOnlyPart::url().

[pure virtual] uint Document::editableMarks() const

Get which marks can be toggled by the user. The returned value is a mark mask containing all editable marks combined with a logical OR. Returns mark mask containing all editable marks

See also setEditableMarks().

[signal] void Document::editingFinished(KTextEditor::Document *document)

Emitted when an editing transaction has finished.

document is the document which emitted this signal

See also textChanged().

[signal] void Document::editingStarted(KTextEditor::Document *document)

Emitted when an editing transaction has started.

document is the document which emitted this signal

[pure virtual] QStringList Document::embeddedHighlightingModes() const

Get all available highlighting modes for the current document.

Each document can be highlighted using an arbitrary number of highlighting contexts. This method will return the names for each of the used modes.

Example: The "PHP (HTML)" mode includes the highlighting for PHP, HTML, CSS and JavaScript.

Returns Returns a list of embedded highlighting modes for the current Document.

See also KTextEditor::Document::highlightingMode().

[pure virtual] QString Document::encoding() const

Get the current chosen encoding. The return value is an empty string, if the document uses the default encoding of the editor and no own special encoding. Returns current encoding of the document

See also setEncoding().

KTextEditor::Cursor Document::endOfLine(int line) const

Get the end cursor position of line line.

line is the line number

See also lineLength() and line().

[pure virtual] QString Document::highlightingMode() const

Return the name of the currently used mode Returns name of the used mode

See also highlightingModes() and setHighlightingMode().

[pure virtual] QString Document::highlightingModeAt(KTextEditor::Cursor position)

Get the highlight mode used at a given position in the document.

Retrieve the name of the applied highlight mode at a given position in the current document.

Calling this might trigger re-highlighting up to the given line. Therefore this is not const.

See also highlightingModes().

[signal] void Document::highlightingModeChanged(KTextEditor::Document *document)

Emitted when the current document's highlighting mode changes.

document is the document reporting the highlighting mode change

See also setHighlightingMode().

[pure virtual] QString Document::highlightingModeSection(int index) const

Returns the name of the section for a highlight given its index in the highlight list (as returned by highlightModes()).

You can use this function to build a tree of the highlight names, organized in sections.

index is the index of the highlight in the list returned by modes()

[pure virtual] QStringList Document::highlightingModes() const

Returns a list of the names of all possible modes

See also highlightingMode() and setHighlightingMode().

[pure virtual] bool Document::insertLine(int line, const QString &text)

Insert line(s) at the given line number. The newline character '\n' is treated as line delimiter, so it is possible to insert multiple lines. To append lines at the end of the document, use

insertLine( lines(), text )

line is where to insert the text

text is the text to insert

Returns true on success, otherwise false

See also insertText().

[pure virtual] bool Document::insertLines(int line, const QStringList &text)

Insert line(s) at the given line number. The newline character '\n' is treated as line delimiter, so it is possible to insert multiple lines. To append lines at the end of the document, use

insertLine( lines(), text )

line is where to insert the text

text is the text to insert

Returns true on success, otherwise false

See also insertText().

[pure virtual] bool Document::insertText(KTextEditor::Cursor position, const QString &text, bool block = false)

Insert text at position.

position is where to insert the text

text is the text to insert

block if true, insert this text as a visual block of text rather than a linear sequence

Returns true on success, otherwise false

See also setText() and removeText().

[pure virtual] bool Document::insertText(KTextEditor::Cursor position, const QStringList &text, bool block = false)

Insert text at position.

position is where to insert the text

text is the text to insert

block if true, insert this text as a visual block of text rather than a linear sequence

Returns true on success, otherwise false

See also setText() and removeText().

[pure virtual] bool Document::isDataRecoveryAvailable() const

Returns whether a recovery is available for the current document.

See also recoverData() and discardDataRecovery().

[pure virtual] bool Document::isEditingTransactionRunning() const

Returns true if an editing transaction is currently running.

See also EditingTransaction.

[virtual] bool Document::isEmpty() const

Returns if the document is empty.

[pure virtual, since 5.0] bool Document::isLineModified(int line) const

Check whether line currently contains unsaved data. If line contains unsaved data, true is returned, otherwise false. When the user saves the file, a modified line turns into a saved line. In this case isLineModified() returns false and in its stead isLineSaved() returns true.

line is line number

This function was introduced in 5.0.

See also isLineSaved() and isLineTouched().

[pure virtual, since 5.0] bool Document::isLineSaved(int line) const

Check whether line currently contains only saved text. Saved text in this case implies that a line was touched at some point by the user and then then changes were either undone or the user saved the file.

In case line was touched and currently contains only saved data, true is returned, otherwise false.

line is the line number

This function was introduced in 5.0.

See also isLineModified() and isLineTouched().

[pure virtual, since 5.0] bool Document::isLineTouched(int line) const

Returns true if a line was touched since the file was opened. This equals the statement isLineModified() || isLineSaved().

line is the line number

This function was introduced in 5.0.

See also isLineModified() and isLineSaved().

[pure virtual, since 5.0] bool Document::isValidTextPosition(KTextEditor::Cursor cursor) const

Get whether cursor is a valid text position. A cursor position at (line, column) is valid, if

• line >= 0 and line < lines() holds, and
• column >= 0 and column <= lineLength(column).

The text position cursor is also invalid if it is inside a Unicode surrogate. Therefore, use this function when iterating over the characters of a line.

cursor is the cursor position to check for validity

Returns true, if cursor is a valid text position, otherwise false

This function was introduced in 5.0.

[pure virtual] qint64 Document::lastSavedRevision() const

Last revision the buffer got successful saved Returns last revision buffer got saved, -1 if none

[pure virtual] QString Document::line(int line) const

Get a single text line.

line is the requested line

Returns the requested line, or "" for invalid line numbers

See also text() and lineLength().

[pure virtual] int Document::lineLength(int line) const

Get the length of a given line in characters.

line is the line number

Returns the number of characters in the line or -1 if the line was invalid

See also line().

[signal] void Document::lineUnwrapped(KTextEditor::Document *document, int line)

Emitted when A line is unwrapped.

document is the document which emitted this signal

line line is where the unwrap occurred

[signal] void Document::lineWrapped(KTextEditor::Document *document, KTextEditor::Cursor position)

Emitted when a line of text is wrapped.

document is the document which emitted this signal

position is the where the wrap occurred

[pure virtual] int Document::lines() const

Returns the current number of lines in the document

[pure virtual] void Document::lockRevision(qint64 revision)

Lock a revision, this will keep it around until released again. But all revisions will always be cleared on buffer clear() (and therefor load())

revision is the revision to lock

[pure virtual] uint Document::mark(int line)

Get all marks set on the line.

line is the line number

Returns a uint representing of the marks set in line concatenated by logical OR

See also setMark(), addMark(), and removeMark().

[signal] void Document::markChanged(KTextEditor::Document *document, KTextEditor::Mark mark, KTextEditor::Document::MarkChangeAction action)

The document emits this signal whenever the mark changes.

document is the document which emitted the signal

mark is the changed mark

action is the action (either removed or added)

See also marksChanged().

[signal] void Document::markClicked(KTextEditor::Document *document, KTextEditor::Mark mark, bool &handled)

The document emits this signal whenever the mark is left-clicked.

document is the document which emitted the signal

mark is the mark that was right-clicked

handled is set this to 'true' if this event was handled externally, and kate should not handle the left click.

[signal] void Document::markContextMenuRequested(KTextEditor::Document *document, KTextEditor::Mark mark, QPoint pos, bool &handled)

The document emits this signal whenever the mark is right-clicked to show a context menu. The receiver may show an own context menu instead of the kate internal one.

document is the document which emitted the signal

mark is the mark that was right-clicked

pos is the position where the menu should be started

handled is set this to 'true' if this event was handled externally, and kate should not create it's own context menu.

[pure virtual] QString Document::markDescription(KTextEditor::Document::MarkTypes mark) const

Get the mark's description to text.

mark is the mark

Returns text of the given mark or QString(), if the entry does not exist

See also setMarkDescription().

[pure virtual] QIcon Document::markIcon(KTextEditor::Document::MarkTypes markType) const

Returns a mark type's icon.

markType is the mark type. If the icon does not exist the resulting is null (check with QIcon::isNull()).

See also setMarkIcon() and setMarkDescription().

[signal] void Document::markToolTipRequested(KTextEditor::Document *document, KTextEditor::Mark mark, QPoint position, bool &handled)

The document emits this signal whenever the mark is hovered using the mouse, and the receiver may show a tooltip.

document is the document which emitted the signal

mark is the mark that was hovered

position is the mouse position during the hovering

handled set this to 'true' if this event was handled externally

[pure virtual] const QHash<int, KTextEditor::Mark *> &Document::marks()

Get a hash holding all marks in the document. The hash key for a mark is its line. Returns a hash holding all marks in the document

KF6 TODO: Change Mark* to Mark. No need for pointer here.

[signal] void Document::marksChanged(KTextEditor::Document *document)

The document emits this signal whenever a mark mask changed.

document is document which emitted this signal

See also markChanged().

[pure virtual] QString Document::mimeType()

Returns this document's mimetype.

[pure virtual] QString Document::mode() const

Return the name of the currently used mode Returns name of the used mode

See also modes() and setMode().

[signal] void Document::modeChanged(KTextEditor::Document *document)

Emitted when the current document's mode changes.

document is the document reporting the mode change

See also setMode().

[pure virtual] QString Document::modeSection(int index) const

Returns the name of the section for a mode given its index in the highlight list (as returned by modes()).

You can use this function to build a tree of the mode names, organized in sections.

index is the index of the highlight in the list returned by modes()

[pure virtual] QStringList Document::modes() const

Returns a list of the names of all possible modes

See also mode() and setMode().

[signal] void Document::modifiedChanged(KTextEditor::Document *document)

This signal is emitted whenever the document's buffer changed from either state unmodified to modified or vice versa.

document is the document which changed its modified state

See also KParts::ReadWritePart::isModified() and KParts::ReadWritePart::setModified().

[signal] void Document::modifiedOnDisk(KTextEditor::Document *document, bool isModified, KTextEditor::Document::ModifiedOnDiskReason reason)

This signal is emitted whenever the document changed its modified-on-disk state.

document is the Document object that represents the file on disk

isModified if true, the file was modified rather than created or deleted

reason is the reason why the signal was emitted

See also setModifiedOnDisk().

[pure virtual] KTextEditor::MovingCursor *Document::newMovingCursor(KTextEditor::Cursor position, KTextEditor::MovingCursor::InsertBehavior insertBehavior = MovingCursor::MoveOnInsert)

Create a new moving cursor for this document.

position is the position of the new moving cursor

insertBehavior describes the insertion behavior

Returns new moving cursor for the document

[pure virtual] KTextEditor::MovingRange *Document::newMovingRange(KTextEditor::Range range, KTextEditor::MovingRange::InsertBehaviors insertBehaviors = MovingRange::DoNotExpand, KTextEditor::MovingRange::EmptyBehavior emptyBehavior = MovingRange::AllowEmpty)

Create a new moving range for this document. Ownership of the range that is returned belongs to the caller

range range of the moving range to create

insertBehaviors insertion behaviors

emptyBehavior behavior on becoming empty

Returns new moving range for the document

[pure virtual, since 6.0] KTextEditor::Cursor Document::offsetToCursor(qsizetype offset) const

Returns the cursor position for a given offset

This function was introduced in 6.0.

bool Document::openingError() const

True, eg if the file for opening could not be read This doesn't have to handle the KPart job canceled cases. Returns was there some problem loading the file?

[pure virtual] bool Document::postMessage(KTextEditor::Message *message)

Post message to the Document and its View%s. If multiple Message%s are posted, the one with the highest priority is shown first.

Usually, you can simply forget the pointer, as the Message is deleted automatically, once it is processed or the document gets closed.

If the Document does not have a View yet, the Message is queued and shown, once a View for the Document is created.

message the message to show

Returns true, if message was posted. false, if message == 0.

[pure virtual] bool Document::print()

Print the document. This should result in showing the print dialog.

Returns true if document was printed

[pure virtual] void Document::printPreview()

Shows the print preview dialog/

[pure virtual] void Document::readSessionConfig(const KConfigGroup &config, const QSet<QString> &flags = QSet<QString>())

Read session settings from the given config.

Known flags:

config is the KConfigGroup to read the session settings from

flags are optional settings to read (any combination of the flags from the Known Flags list). Unknown flags are ignored.

See also writeSessionConfig().

[signal] void Document::readWriteChanged(KTextEditor::Document *document)

This signal is emitted whenever the readWrite state of a document changes.

document is the document whose read/write property changed

See also KParts::ReadWritePart::setReadWrite().

[pure virtual] void Document::recoverData()

If recover data is available, calling recoverData() will trigger the recovery of the data. If isDataRecoveryAvailable() returns false, calling this function does nothing.

See also isDataRecoveryAvailable() and discardDataRecovery().

[signal, since 4.6] void Document::reloaded(KTextEditor::Document *document)

Emitted after the current document was reloaded. At this point, some information might have been invalidated, like for example the editing history.

document is the document that was reloaded.

This function was introduced in 4.6.

[pure virtual] bool Document::removeLine(int line)

Remove line from the document.

line is the line to remove

Returns true on success, otherwise false

See also removeText() and clear().

[pure virtual] void Document::removeMark(int line, uint markType)

Remove the mark mask of type markType from line.

line is the line number

markType is the mark type to be removed

See also clearMark().

[pure virtual] bool Document::removeText(KTextEditor::Range range, bool block = false)

Remove the text specified in range.

range is the range of text to remove

block if true, remove a text block on the basis of columns, rather than everything inside range

Returns true on success, otherwise false

See also setText() and insertText().

[virtual] bool Document::replaceText(KTextEditor::Range range, const QString &text, bool block = false)

Replace text from range with specified text.

range is the range of text to replace

text is the replacement text

block if true, replace text as a visual block of text rather than a linear sequence

Returns true on success, otherwise false

See also setText(), removeText(), and insertText().

[virtual] bool Document::replaceText(KTextEditor::Range range, const QStringList &text, bool block = false)

Replace text from range with specified text.

range is the range of text to replace

text is the replacement text

block if true, replace text as a visual block of text rather than a linear sequence

Returns true on success, otherwise false

See also setText(), removeText(), and insertText().

[static] int Document::reservedMarkersCount()

Get the number of predefined mark types we have so far.

[pure virtual] qint64 Document::revision() const

Current revision Returns current revision

[since 5.11] QList<KTextEditor::Range> Document::searchText(KTextEditor::Range range, const QString &pattern, const KTextEditor::SearchOptions options = Default) const

Searches the given input range for a text pattern.

Searches for a text pattern within the given input range. The kind of search performed depends on the options used. Use this function for plaintext searches as well as regular expression searches. If no match is found the first (and only) element in the vector return is the invalid range. When searching for regular expressions, the first element holds the range of the full match, the subsequent elements hold the ranges of the capturing parentheses.

range is the range to search in

pattern is the text pattern to search for

options defines the search options

Returns List of ranges (length >=1)

Author: Sebastian Pipping <webmaster@hartwork.org>

This function was introduced in 5.11.

[pure virtual] void Document::setAnnotationModel(KTextEditor::AnnotationModel *model)

Sets a new AnnotationModel for this document to provide annotation information for each line.

model is the new AnnotationModel

See also annotationModel().

[pure virtual] void Document::setConfigValue(const QString &key, const QVariant &value)

Set a the key's value to value.

See also configValue().

[pure virtual] void Document::setEditableMarks(uint markMask)

Set the mark mask the user is allowed to toggle to markMask. I.e. concatenate all editable marks with a logical OR. If the user should be able to add a bookmark and set a breakpoint with the context menu in the icon pane, you have to call

// iface is of Type KTextEditor::MarkInterface*
// only make bookmark and breakpoint editable
iface->setEditableMarks( MarkInterface::Bookmark |
                         MarkInterface::BreakpointActive );

// or preserve last settings, and add bookmark and breakpoint
iface->setEditableMarks( iface->editableMarks() |
                         MarkInterface::Bookmark |
                         MarkInterface::BreakpointActive );

markMask is the mark bitmask

See also editableMarks(), setMarkPixmap(), and setMarkDescription().

[pure virtual] bool Document::setEncoding(const QString &encoding)

Set the encoding for this document. This encoding will be used while loading and saving files, it will not affect the already existing content of the document, e.g. if the file has already been opened without the correct encoding, this will not fix it, you would for example need to trigger a reload for this.

encoding is new encoding for the document, the name must be accepted by QStringDecoder/QStringEncoder, if an empty encoding name is given, the part should fallback to its own default encoding, e.g. the system encoding or the global user settings

Returns true on success, or false, if the encoding could not be set.

See also encoding().

[pure virtual] bool Document::setHighlightingMode(const QString &name)

Set the current highlighting mode of the document by giving its name.

name is the name of the highlighting mode to use for this document

Returns true on success, otherwise false

See also highlightingMode(), highlightingModes(), and highlightingModeChanged().

[pure virtual] void Document::setMark(int line, uint markType)

Set the line's mark types to markType. If line already contains a mark of the given type it has no effect. All other marks are deleted before the mark is set. You can achieve the same by calling

clearMark(line);
addMark(line, markType);

line is the line number

markType is the mark type

See also clearMark(), addMark(), and mark().

[pure virtual] void Document::setMarkDescription(KTextEditor::Document::MarkTypes mark, const QString &text)

Set the mark's description to text.

mark is the mark to describe

text is the mark's new description

See also markDescription() and setMarkPixmap().

[pure virtual] void Document::setMarkIcon(KTextEditor::Document::MarkTypes markType, const QIcon &icon)

Set a mark's icon to icon.

markType is the mark type to which the icon will be attached

icon is the new icon

See also markIcon() and setMarkDescription().

[pure virtual] bool Document::setMode(const QString &name)

Set the current mode of the document by giving its name.

name is the name of the mode to use for this document

Returns true on success, otherwise false

See also mode(), modes(), and modeChanged().

[pure virtual] void Document::setModifiedOnDisk(KTextEditor::Document::ModifiedOnDiskReason reason)

Sets the document's modified-on-disk state to reason. KTextEditor implementations should emit the signal modifiedOnDisk() along with the reason. When the document is in a clean state again the reason should be ModifiedOnDiskReason::OnDiskUnmodified.

reason is the modified-on-disk reason.

See also ModifiedOnDiskReason and modifiedOnDisk().

[pure virtual] void Document::setModifiedOnDiskWarning(bool on)

Controls whether the editor should show a warning dialog whenever a file was modified on disk.

on true, the editor should show a warning dialog for files modified on disk

[pure virtual] bool Document::setText(const QString &text)

Set the given text as new document content.

text is the new document text

Returns true on success, otherwise false

See also text().

[pure virtual] bool Document::setText(const QStringList &text)

Set the given text as new document content.

text is the new document text

Returns true on success, otherwise false

See also text().

[pure virtual] QString Document::text() const

Get the document content. Returns the complete document content

See also setText().

[pure virtual] QString Document::text(KTextEditor::Range range, bool block = false) const

Get the document content within the given range.

range is the range of text to retrieve

block Set this to true to receive text in a visual block, rather than everything inside range.

Returns the requested text part, or QString() for invalid ranges.

See also setText().

[signal] void Document::textChanged(KTextEditor::Document *document)

Emitted when text is changed in a document.

document is the document which emitted this signal

See also text() and textLine().

[signal] void Document::textInserted(KTextEditor::Document *document, KTextEditor::Cursor position, const QString &text)

Emitted when text is inserted into a document.

document is the document which emitted this signal

position is where the insertion occurred

text is the inserted text

[pure virtual] QStringList Document::textLines(KTextEditor::Range range, bool block = false) const

Get the document content within the given range.

range is the range of text to retrieve

block Set this to true to receive text in a visual block, rather than everything inside range.

Returns the requested text lines, or QStringList() for invalid ranges. no end of line termination is included.

See also setText().

[signal] void Document::textRemoved(KTextEditor::Document *document, KTextEditor::Range range, const QString &text)

Emitted when text is removed from a document.

document is the document which emitted this signal

range is where the removal occurred

text is the removed text

[pure virtual] qsizetype Document::totalCharacters() const

Get the count of characters in the document. A TAB character counts as only one character. Returns the number of characters in the document

See also lines().

[pure virtual] void Document::transformCursor(KTextEditor::Cursor &cursor, KTextEditor::MovingCursor::InsertBehavior insertBehavior, qint64 fromRevision, qint64 toRevision = -1)

Transform a cursor from one revision to an other.

cursor is the cursor to transform

insertBehavior is the behavior of this cursor on insert of text at its position

fromRevision is the first revision to transform

toRevision is the last revision to transform (default of -1 is current revision)

[pure virtual] void Document::transformCursor(int &line, int &column, KTextEditor::MovingCursor::InsertBehavior insertBehavior, qint64 fromRevision, qint64 toRevision = -1)

Transform a cursor from one revision to an other.

line is the line number of the cursor to transform

column is the column number of the cursor to transform

insertBehavior is the behavior of this cursor on insert of text at its position

fromRevision is the first revision to transform

toRevision is the last revision to transform (default of -1 is current revision)

[pure virtual] void Document::transformRange(KTextEditor::Range &range, KTextEditor::MovingRange::InsertBehaviors insertBehaviors, KTextEditor::MovingRange::EmptyBehavior emptyBehavior, qint64 fromRevision, qint64 toRevision = -1)

Transform a range from one revision to an other.

range is the range to transform

insertBehaviors is the behavior of this range on insert of text at its position

emptyBehavior is the behavior on becoming empty

fromRevision is the first revision to transform

toRevision is the last revision to transform (default of -1 is current revision)

[pure virtual] void Document::unlockRevision(qint64 revision)

Release a revision.

revision is the revision to release

[signal] void Document::viewCreated(KTextEditor::Document *document, KTextEditor::View *view)

This signal is emitted whenever the document creates a new view. It should be called for every view to help applications / plugins to attach to the view.

document is the document for which a new view is created

view is the new view

See also createView().

[pure virtual] QList<KTextEditor::View *> Document::views() const

Returns the views pre-casted to KTextEditor::View%s

[pure virtual] QString Document::wordAt(KTextEditor::Cursor cursor) const

Get the word at the text position cursor. The returned word is defined by the word boundaries to the left and right starting at cursor. The algorithm takes highlighting information into account, e.g. a dash ('-') in C++ is interpreted as word boundary, whereas e.g. CSS allows identifiers with dash ('-').

If cursor is not a valid text position or if there is no word under the requested position cursor, an empty string is returned.

cursor is the cursor position for the word

Returns the word under the cursor or an empty string if there is no word.

See also wordRangeAt() and characterAt().

[pure virtual] KTextEditor::Range Document::wordRangeAt(KTextEditor::Cursor cursor) const

Get the text range for the word located under the text position cursor. The returned word is defined by the word boundaries to the left and right starting at cursor. The algorithm takes highlighting information into account, e.g. a dash ('-') in C++ is interpreted as word boundary, whereas e.g. CSS allows identifiers with dash ('-').

If cursor is not a valid text position or if there is no word under the requested position cursor, an invalid text range is returned. If the text range is valid, it is always on a single line.

cursor is the cursor position for the word

Returns the Range spanning the word under the cursor or an invalid range if there is no word.

See also wordAt(), characterAt(), and KTextEditor::Range::isValid().

[pure virtual] void Document::writeSessionConfig(KConfigGroup &config, const QSet<QString> &flags = QSet<QString>())

Write session settings to the config. See readSessionConfig() for more details about available flags.

config is the KConfigGroup to write the session settings to

flags are optional settings to write from the Known Flags list documented in readSessionConfig(). Unknown flags are ignored.

See also readSessionConfig().