KDE 4.5 API Reference Kate
KateDocument Class Reference
#include <katedocument.h>
Detailed Description
Definition at line 74 of file katedocument.h.
Member Typedef Documentation
| typedef QList<QPair<int, int> > KateDocument::OffsetList |
Definition at line 1168 of file katedocument.h.
Member Enumeration Documentation
Definition at line 1181 of file katedocument.h.
Constructor & Destructor Documentation
| KateDocument::KateDocument | ( | bool | bSingleViewMode = false, |
|
| bool | bBrowserView = false, |
|||
| bool | bReadOnly = false, |
|||
| QWidget * | parentWidget = 0, |
|||
| QObject * | parent = 0 | |||
| ) | [explicit] |
Definition at line 163 of file katedocument.cpp.
| KateDocument::~KateDocument | ( | ) |
Member Function Documentation
| void KateDocument::aboutToDeleteMovingInterfaceContent | ( | KTextEditor::Document * | document | ) | [signal] |
This signal is emitted before the cursors/ranges/revisions of a document are destroyed as the document is deleted.
- Parameters:
-
document the document which the interface belongs too which is in the process of being deleted
Reimplemented from KTextEditor::MovingInterface.
| void KateDocument::aboutToInvalidateMovingInterfaceContent | ( | KTextEditor::Document * | document | ) | [signal] |
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, still the old document content is around before the clear.
- Parameters:
-
document the document which the interface belongs too which will invalidate its data
Reimplemented from KTextEditor::MovingInterface.
| void KateDocument::aboutToRemoveText | ( | const KTextEditor::Range & | ) | [signal] |
| KateView * KateDocument::activeKateView | ( | ) | const |
Definition at line 4753 of file katedocument.cpp.
| virtual KTextEditor::View* KateDocument::activeView | ( | ) | const [inline, virtual] |
| void KateDocument::addActionsToDocument | ( | KTextEditor::SmartRange * | topRange | ) | [virtual] |
| void KateDocument::addActionsToView | ( | KTextEditor::View * | view, | |
| KTextEditor::SmartRange * | topRange | |||
| ) | [virtual] |
| void KateDocument::addHighlightToDocument | ( | KTextEditor::SmartRange * | topRange, | |
| bool | supportDynamic | |||
| ) | [virtual] |
| void KateDocument::addHighlightToView | ( | KTextEditor::View * | view, | |
| KTextEditor::SmartRange * | topRange, | |||
| bool | supportDynamic | |||
| ) | [virtual] |
| void KateDocument::addMark | ( | int | line, | |
| uint | markType | |||
| ) | [virtual, slot] |
| void KateDocument::addView | ( | KTextEditor::View * | view | ) |
Definition at line 2603 of file katedocument.cpp.
| void KateDocument::align | ( | KateView * | view, | |
| const KTextEditor::Range & | range | |||
| ) |
Definition at line 3008 of file katedocument.cpp.
| KTextEditor::AnnotationModel * KateDocument::annotationModel | ( | ) | const [virtual] |
| void KateDocument::annotationModelChanged | ( | KTextEditor::AnnotationModel * | , | |
| KTextEditor::AnnotationModel * | ||||
| ) | [signal] |
| void KateDocument::attributeDynamic | ( | KTextEditor::Attribute::Ptr | a | ) | [protected, virtual] |
| void KateDocument::attributeNotDynamic | ( | KTextEditor::Attribute::Ptr | a | ) | [protected, virtual] |
| void KateDocument::backspace | ( | KateView * | view, | |
| const KTextEditor::Cursor & | c | |||
| ) |
Definition at line 2808 of file katedocument.cpp.
| void KateDocument::bomSetByUser | ( | ) |
Set that the BOM marker is forced via the tool menu.
Definition at line 1671 of file katedocument.cpp.
| bool KateDocument::browserView | ( | ) | const [inline] |
Definition at line 125 of file katedocument.h.
| KateBuffer& KateDocument::buffer | ( | ) | [inline] |
Get access to buffer of this document.
Is needed to create cursors and ranges for example.
- Returns:
- document buffer
Definition at line 988 of file katedocument.h.
| void KateDocument::bufferHlChanged | ( | ) |
Definition at line 1654 of file katedocument.cpp.
| QChar KateDocument::character | ( | const KTextEditor::Cursor & | position | ) | const [virtual] |
| void KateDocument::charactersSemiInteractivelyInserted | ( | const KTextEditor::Cursor & | position, | |
| const QString & | text | |||
| ) | [signal] |
Definition at line 4663 of file katedocument.cpp.
| bool KateDocument::clear | ( | ) | [virtual, slot] |
| void KateDocument::clearDictionaryRanges | ( | ) | [slot] |
Definition at line 5153 of file katedocument.cpp.
| void KateDocument::clearDocumentActions | ( | ) | [virtual] |
| void KateDocument::clearDocumentHighlights | ( | ) | [virtual] |
| void KateDocument::clearMark | ( | int | line | ) | [virtual, slot] |
| void KateDocument::clearMarks | ( | ) | [virtual, slot] |
| void KateDocument::clearMisspellingForWord | ( | const QString & | word | ) |
Definition at line 5298 of file katedocument.cpp.
| void KateDocument::clearSmartInterface | ( | ) | [virtual] |
| void KateDocument::clearViewActions | ( | KTextEditor::View * | view | ) | [virtual] |
| void KateDocument::clearViewHighlights | ( | KTextEditor::View * | view | ) | [virtual] |
| bool KateDocument::closeUrl | ( | ) | [virtual] |
we are about to invalidate all cursors/ranges/.. => m_buffer->clear will do so
Reimplemented from KParts::ReadWritePart.
Definition at line 2454 of file katedocument.cpp.
| void KateDocument::codeFoldingUpdated | ( | ) | [signal] |
| void KateDocument::comment | ( | KateView * | view, | |
| uint | line, | |||
| uint | column, | |||
| int | change | |||
| ) |
Definition at line 3378 of file katedocument.cpp.
| int KateDocument::computePositionWrtOffsets | ( | const OffsetList & | offsetList, | |
| int | pos | |||
| ) |
Definition at line 5365 of file katedocument.cpp.
| KateDocumentConfig* KateDocument::config | ( | ) | const [inline] |
Definition at line 1034 of file katedocument.h.
| KateDocumentConfig* KateDocument::config | ( | ) | [inline] |
| void KateDocument::configChanged | ( | ) | [signal] |
| QStringList KateDocument::configKeys | ( | ) | const [virtual] |
| bool KateDocument::containsCharacterEncoding | ( | const KTextEditor::Range & | range | ) |
Definition at line 5339 of file katedocument.cpp.
| KTextEditor::View * KateDocument::createView | ( | QWidget * | parent | ) | [virtual] |
| int KateDocument::currentRevision | ( | ) | const [virtual] |
| QString KateDocument::decodeCharacters | ( | const KTextEditor::Range & | range, | |
| KateDocument::OffsetList & | decToEncOffsetList, | |||
| KateDocument::OffsetList & | encToDecOffsetList | |||
| ) |
The first OffsetList is from decoded to encoded, and the second OffsetList from encoded to decoded.
Definition at line 5377 of file katedocument.cpp.
| QString KateDocument::defaultDictionary | ( | ) | const |
Definition at line 5143 of file katedocument.cpp.
| void KateDocument::defaultDictionaryChanged | ( | KateDocument * | document | ) | [signal] |
| KTextEditor::Attribute::Ptr KateDocument::defaultStyle | ( | const KTextEditor::HighlightInterface::DefaultStyle | ds | ) | const [virtual] |
TODO: move attributes to document, they are not view-dependant
Implements KTextEditor::HighlightInterface.
Definition at line 5465 of file katedocument.cpp.
| void KateDocument::del | ( | KateView * | view, | |
| const KTextEditor::Cursor & | c | |||
| ) |
Definition at line 2892 of file katedocument.cpp.
| void KateDocument::deleteCursors | ( | ) | [virtual] |
| void KateDocument::deleteDictionaryRange | ( | KTextEditor::MovingRange * | movingRange | ) | [protected] |
Definition at line 5322 of file katedocument.cpp.
| void KateDocument::deleteRanges | ( | ) | [virtual] |
| QString KateDocument::dictionaryForMisspelledRange | ( | const KTextEditor::Range & | range | ) | const |
Definition at line 5288 of file katedocument.cpp.
| QList< QPair< KTextEditor::MovingRange *, QString > > KateDocument::dictionaryRanges | ( | ) | const |
Definition at line 5148 of file katedocument.cpp.
| void KateDocument::dictionaryRangesPresent | ( | bool | yesNo | ) | [signal] |
| const QList< KTextEditor::SmartRange * > KateDocument::documentActions | ( | ) | const [virtual] |
| KTextEditor::Cursor KateDocument::documentEnd | ( | ) | const [virtual] |
| const QList< KTextEditor::SmartRange * > KateDocument::documentHighlights | ( | ) | const [virtual] |
| virtual const QString& KateDocument::documentName | ( | ) | const [inline, virtual] |
| bool KateDocument::documentReload | ( | ) | [virtual, slot] |
Reloads the current document from disk if possible.
Implements KTextEditor::Document.
Definition at line 3918 of file katedocument.cpp.
| bool KateDocument::documentSave | ( | ) | [virtual, slot] |
| bool KateDocument::documentSaveAs | ( | ) | [virtual, slot] |
| void KateDocument::dumpRegionTree | ( | ) | [protected, slot] |
Definition at line 4064 of file katedocument.cpp.
| uint KateDocument::editableMarks | ( | ) | const [virtual] |
| void KateDocument::editBegin | ( | Kate::EditSource | editSource = Kate::NoEditSource |
) | [inline] |
| void KateDocument::editEnd | ( | ) |
| bool KateDocument::editInsertLine | ( | int | line, | |
| const QString & | s, | |||
| Kate::EditSource | editSource = Kate::NoEditSource | |||
| ) |
Insert a string at the given line.
- Parameters:
-
line line number s string to insert
- Returns:
- true on success
Definition at line 1353 of file katedocument.cpp.
| bool KateDocument::editInsertText | ( | int | line, | |
| int | col, | |||
| const QString & | s, | |||
| Kate::EditSource | editSource = Kate::NoEditSource | |||
| ) |
Add a string in the given line/column.
- Parameters:
-
line line number col column s string to be inserted
- Returns:
- true on success
Definition at line 1109 of file katedocument.cpp.
| void KateDocument::editLineUnWrapped | ( | int | line, | |
| int | col | |||
| ) | [signal] |
Emitted each time text from nextLine was upwrapped onto line.
| void KateDocument::editLineWrapped | ( | int | line, | |
| int | col, | |||
| int | len | |||
| ) | [signal] |
Emmitted when text from line was wrapped at position pos onto line nextLine.
Mark line as autowrapped.
This is necessary if static word warp is enabled, because we have to know whether to insert a new line or add the wrapped words to the followin line.
- Parameters:
-
line line number autowrapped autowrapped?
- Returns:
- true on success
Definition at line 1187 of file katedocument.cpp.
| KTextEditor::Editor * KateDocument::editor | ( | ) | [virtual] |
| bool KateDocument::editRemoveLine | ( | int | line, | |
| Kate::EditSource | editSource = Kate::NoEditSource | |||
| ) |
Remove a line.
- Parameters:
-
line line number
- Returns:
- true on success
Definition at line 1421 of file katedocument.cpp.
| bool KateDocument::editRemoveLines | ( | int | from, | |
| int | to, | |||
| Kate::EditSource | editSource = Kate::NoEditSource | |||
| ) |
Definition at line 1426 of file katedocument.cpp.
| bool KateDocument::editRemoveText | ( | int | line, | |
| int | col, | |||
| int | len, | |||
| Kate::EditSource | editSource = Kate::NoEditSource | |||
| ) |
Remove a string in the given line/column.
- Parameters:
-
line line number col column len length of text to be removed
- Returns:
- true on success
Definition at line 1149 of file katedocument.cpp.
| void KateDocument::editStart | ( | Kate::EditSource | editSource = Kate::NoEditSource |
) |
Enclose editor actions with editStart() and editEnd() to group them.
- Parameters:
-
editSource the source for the grouped edit actions.
Definition at line 890 of file katedocument.cpp.
Unwrap line.
If removeLine is true, we force to join the lines. If removeLine is true, length is ignored (eg not needed).
- Parameters:
-
line line number removeLine if true, force to remove the next line
- Returns:
- true on success
Definition at line 1286 of file katedocument.cpp.
Wrap line.
If newLine is true, ignore the textline's flag KateTextLine::flagAutoWrapped and force a new line. Whether a new line was needed/added you can grab with newLineAdded.
- Parameters:
-
line line number col column newLine if true, force a new line newLineAdded return value is true, if new line was added (may be 0)
- Returns:
- true on success
Definition at line 1211 of file katedocument.cpp.
| QStringList KateDocument::embeddedHighlightingModes | ( | ) | const [virtual] |
| const QString & KateDocument::encoding | ( | ) | const [virtual] |
| virtual bool KateDocument::endEditing | ( | ) | [inline, virtual] |
| void KateDocument::exportAs | ( | const QString & | ) | [inline, slot] |
Definition at line 732 of file katedocument.h.
| QString KateDocument::fileType | ( | ) | const [inline] |
Definition at line 981 of file katedocument.h.
| bool KateDocument::findMatchingBracket | ( | KTextEditor::Range & | range, | |
| int | maxLines = -1 | |||
| ) |
Definition at line 3710 of file katedocument.cpp.
| KateCodeFoldingTree * KateDocument::foldingTree | ( | ) |
Definition at line 4075 of file katedocument.cpp.
| uint KateDocument::getRealLine | ( | unsigned int | virtualLine | ) |
Definition at line 4963 of file katedocument.cpp.
| uint KateDocument::getVirtualLine | ( | unsigned int | realLine | ) |
Definition at line 4968 of file katedocument.cpp.
| QString KateDocument::getWord | ( | const KTextEditor::Cursor & | cursor | ) |
Definition at line 3642 of file katedocument.cpp.
| bool KateDocument::handleMarkClick | ( | int | line | ) | [slot] |
Returns true if the click on the mark should not be further processed.
Definition at line 1895 of file katedocument.cpp.
Returns true if the context-menu event should not further be processed.
Definition at line 1907 of file katedocument.cpp.
| KateHighlighting * KateDocument::highlight | ( | ) | const |
Definition at line 4958 of file katedocument.cpp.
| QString KateDocument::highlightingMode | ( | ) | const [virtual] |
Return the name of the currently used mode.
- Returns:
- name of the used mode
Implements KTextEditor::Document.
Definition at line 1629 of file katedocument.cpp.
| QString KateDocument::highlightingModeAt | ( | const KTextEditor::Cursor & | position | ) | [virtual] |
| QStringList KateDocument::highlightingModes | ( | ) | const [virtual] |
Return a list of the names of all possible modes.
- Returns:
- list of mode names
Implements KTextEditor::Document.
Definition at line 1634 of file katedocument.cpp.
| QString KateDocument::highlightingModeSection | ( | int | index | ) | const [virtual] |
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.
- Parameters:
-
name the name of the highlight for which to find the section name.
Implements KTextEditor::Document.
Definition at line 1644 of file katedocument.cpp.
| KateEditHistory* KateDocument::history | ( | ) | const [inline] |
Definition at line 324 of file katedocument.h.
| void KateDocument::ignoreModifiedOnDiskOnce | ( | ) |
Definition at line 4953 of file katedocument.cpp.
| void KateDocument::indent | ( | KTextEditor::Range | range, | |
| int | change | |||
| ) |
Definition at line 2989 of file katedocument.cpp.
| void KateDocument::inputMethodEnd | ( | ) |
Definition at line 982 of file katedocument.cpp.
| void KateDocument::inputMethodStart | ( | ) |
Definition at line 977 of file katedocument.cpp.
| bool KateDocument::insertLines | ( | int | line, | |
| const QStringList & | s | |||
| ) | [virtual, slot] |
| bool KateDocument::insertTemplateTextImplementation | ( | const KTextEditor::Cursor & | c, | |
| const QString & | templateString, | |||
| const QMap< QString, QString > & | initialValues, | |||
| const QString & | scriptToken, | |||
| KateView * | view | |||
| ) | [virtual] |
Starts a KateTemplateHandler for the given template.
Multiple handlers may run at the same time, while only the last one created for this document will be active.
Definition at line 4742 of file katedocument.cpp.
| bool KateDocument::insertText | ( | const KTextEditor::Cursor & | position, | |
| const QStringList & | text, | |||
| bool | block = false | |||
| ) | [virtual, slot] |
| bool KateDocument::insertText | ( | const KTextEditor::Cursor & | position, | |
| const QString & | s, | |||
| bool | block = false | |||
| ) | [virtual, slot] |
| bool KateDocument::isEditRunning | ( | ) | const |
Definition at line 4989 of file katedocument.cpp.
| bool KateDocument::isModifiedOnDisc | ( | ) | [inline] |
- Returns:
- whether the document is modified on disk since last saved
Definition at line 871 of file katedocument.h.
| bool KateDocument::isOnTheFlySpellCheckingEnabled | ( | ) | const |
Definition at line 5283 of file katedocument.cpp.
| void KateDocument::joinLines | ( | uint | first, | |
| uint | last | |||
| ) |
| Kate::TextLine KateDocument::kateTextLine | ( | uint | i | ) |
Definition at line 4978 of file katedocument.cpp.
| int KateDocument::lastLine | ( | ) | const [inline] |
| qint64 KateDocument::lastSavedRevision | ( | ) | const [virtual] |
Last revision the buffer got successful saved.
- Returns:
- last revision buffer got saved, -1 if none
Implements KTextEditor::MovingInterface.
Definition at line 5016 of file katedocument.cpp.
| QString KateDocument::line | ( | int | line | ) | const [virtual] |
| QList< KTextEditor::HighlightInterface::AttributeBlock > KateDocument::lineAttributes | ( | const unsigned int | line | ) | [virtual] |
TODO: move attributes to document, they are not view-dependant
Implements KTextEditor::HighlightInterface.
Definition at line 5478 of file katedocument.cpp.
| void KateDocument::lineInfo | ( | KateLineInfo * | info, | |
| unsigned int | line | |||
| ) |
Definition at line 4070 of file katedocument.cpp.
| int KateDocument::lineLength | ( | int | line | ) | const [virtual] |
| int KateDocument::lines | ( | ) | const [virtual] |
| void KateDocument::lockRevision | ( | qint64 | revision | ) | [virtual] |
Lock a revision, this will keep it around until released again.
But all revisions will always be cleared on buffer clear() (and therefor load())
- Parameters:
-
revision revision to lock
Implements KTextEditor::MovingInterface.
Definition at line 5021 of file katedocument.cpp.
| void KateDocument::makeAttribs | ( | bool | needInvalidate = true |
) |
Definition at line 2582 of file katedocument.cpp.
| uint KateDocument::mark | ( | int | line | ) | [virtual] |
| void KateDocument::markChanged | ( | KTextEditor::Document * | , | |
| KTextEditor::Mark | , | |||
| KTextEditor::MarkInterface::MarkChangeAction | ||||
| ) | [virtual, signal] |
Implements KTextEditor::MarkInterface.
| void KateDocument::markClicked | ( | KTextEditor::Document * | document, | |
| KTextEditor::Mark | mark, | |||
| bool & | handled | |||
| ) | [signal] |
Reimplemented from KTextEditor::MarkInterface.
| QColor KateDocument::markColor | ( | MarkInterface::MarkTypes | type | ) | const [virtual] |
Definition at line 1954 of file katedocument.cpp.
| void KateDocument::markContextMenuRequested | ( | KTextEditor::Document * | document, | |
| KTextEditor::Mark | mark, | |||
| QPoint | pos, | |||
| bool & | handled | |||
| ) | [signal] |
Reimplemented from KTextEditor::MarkInterface.
| QString KateDocument::markDescription | ( | MarkInterface::MarkTypes | type | ) | const [virtual] |
Definition at line 1964 of file katedocument.cpp.
| QPixmap KateDocument::markPixmap | ( | MarkInterface::MarkTypes | type | ) | const [virtual] |
Definition at line 1948 of file katedocument.cpp.
| const QHash< int, KTextEditor::Mark * > & KateDocument::marks | ( | ) | [virtual] |
| void KateDocument::marksChanged | ( | KTextEditor::Document * | ) | [virtual, signal] |
Implements KTextEditor::MarkInterface.
| void KateDocument::markToolTipRequested | ( | KTextEditor::Document * | document, | |
| KTextEditor::Mark | mark, | |||
| QPoint | position, | |||
| bool & | handled | |||
| ) | [signal] |
Reimplemented from KTextEditor::MarkInterface.
| QString KateDocument::mimeType | ( | ) | [virtual] |
- Returns:
- the name of the mimetype for the document.
Implements KTextEditor::Document.
Definition at line 1994 of file katedocument.cpp.
| KMimeType::Ptr KateDocument::mimeTypeForContent | ( | ) |
- Returns:
- a pointer to the KMimeType for this document, found by analyzing the actual content.
Definition at line 2008 of file katedocument.cpp.
| QString KateDocument::mode | ( | ) | const [virtual] |
Return the name of the currently used mode.
- Returns:
- name of the used mode
Implements KTextEditor::Document.
Definition at line 1607 of file katedocument.cpp.
| QStringList KateDocument::modes | ( | ) | const [virtual] |
Return a list of the names of all possible modes.
- Returns:
- list of mode names
Implements KTextEditor::Document.
Definition at line 1612 of file katedocument.cpp.
| QString KateDocument::modeSection | ( | int | index | ) | const [virtual] |
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.
- Parameters:
-
name the name of the highlight for which to find the section name.
Implements KTextEditor::Document.
Definition at line 1649 of file katedocument.cpp.
| void KateDocument::modifiedOnDisk | ( | KTextEditor::Document * | doc, | |
| bool | isModified, | |||
| KTextEditor::ModificationInterface::ModifiedOnDiskReason | reason | |||
| ) | [virtual, signal] |
Indicate this file is modified on disk.
- Parameters:
-
doc the KTextEditor::Document object that represents the file on disk isModified indicates the file was modified rather than created or deleted reason the reason we are emitting the signal.
Implements KTextEditor::ModificationInterface.
| void KateDocument::newBracketMark | ( | const KTextEditor::Cursor & | start, | |
| KTextEditor::Range & | bm, | |||
| int | maxLines = -1 | |||
| ) |
Definition at line 3694 of file katedocument.cpp.
| void KateDocument::newLine | ( | KateView * | view | ) |
Definition at line 2743 of file katedocument.cpp.
| KTextEditor::MovingCursor * KateDocument::newMovingCursor | ( | const KTextEditor::Cursor & | position, | |
| KTextEditor::MovingCursor::InsertBehavior | insertBehavior = KTextEditor::MovingCursor::MoveOnInsert | |||
| ) | [virtual] |
Create a new moving cursor for this document.
- Parameters:
-
position position of the moving cursor to create insertBehavior insertion behavior
- Returns:
- new moving cursor for the document
Implements KTextEditor::MovingInterface.
Definition at line 5001 of file katedocument.cpp.
| KTextEditor::MovingRange * KateDocument::newMovingRange | ( | const KTextEditor::Range & | range, | |
| KTextEditor::MovingRange::InsertBehaviors | insertBehaviors = KTextEditor::MovingRange::DoNotExpand, |
|||
| KTextEditor::MovingRange::EmptyBehavior | emptyBehavior = KTextEditor::MovingRange::AllowEmpty | |||
| ) | [virtual] |
Create a new moving range for this document.
- Parameters:
-
range range of the moving range to create insertBehaviors insertion behaviors emptyBehavior behavior on becoming empty
- Returns:
- new moving range for the document
Definition at line 5006 of file katedocument.cpp.
| KTextEditor::SmartCursor * KateDocument::newSmartCursor | ( | const KTextEditor::Cursor & | position, | |
| KTextEditor::SmartCursor::InsertBehavior | insertBehavior = KTextEditor::SmartCursor::MoveOnInsert | |||
| ) | [virtual] |
| KTextEditor::SmartRange * KateDocument::newSmartRange | ( | KTextEditor::SmartCursor * | start, | |
| KTextEditor::SmartCursor * | end, | |||
| KTextEditor::SmartRange * | parent = 0L, |
|||
| KTextEditor::SmartRange::InsertBehaviors | insertBehavior = KTextEditor::SmartRange::DoNotExpand | |||
| ) | [virtual] |
Definition at line 4800 of file katedocument.cpp.
| KTextEditor::SmartRange * KateDocument::newSmartRange | ( | const KTextEditor::Range & | range, | |
| KTextEditor::SmartRange * | parent = 0L, |
|||
| KTextEditor::SmartRange::InsertBehaviors | insertBehavior = KTextEditor::SmartRange::DoNotExpand | |||
| ) | [virtual] |
Definition at line 4795 of file katedocument.cpp.
| int KateDocument::numVisLines | ( | ) | const |
Definition at line 867 of file katedocument.cpp.
| void KateDocument::onTheFlySpellCheckingEnabled | ( | bool | enable | ) | [slot] |
Definition at line 5263 of file katedocument.cpp.
| bool KateDocument::openFile | ( | ) | [virtual] |
open the file obtained by the kparts framework the framework abstracts the loading of remote files
- Returns:
- success
we are about to invalidate all cursors/ranges/.. => m_buffer->openFile will do so
Implements KParts::ReadOnlyPart.
Definition at line 2039 of file katedocument.cpp.
Definition at line 2643 of file katedocument.cpp.
| bool KateDocument::pageUpDownMovesCursor | ( | ) | const |
Definition at line 4059 of file katedocument.cpp.
| void KateDocument::paste | ( | KateView * | view, | |
| QClipboard::Mode | mode = QClipboard::Clipboard | |||
| ) |
Definition at line 2909 of file katedocument.cpp.
| Kate::TextLine KateDocument::plainKateTextLine | ( | uint | i | ) |
Definition at line 4984 of file katedocument.cpp.
| void KateDocument::popEditState | ( | ) |
Definition at line 968 of file katedocument.cpp.
| void KateDocument::preHighlightChanged | ( | uint | ) | [signal] |
| bool KateDocument::print | ( | ) | [slot] |
Definition at line 1987 of file katedocument.cpp.
| bool KateDocument::printDialog | ( | ) | [slot] |
Definition at line 1982 of file katedocument.cpp.
| void KateDocument::pushEditState | ( | ) |
Definition at line 963 of file katedocument.cpp.
| bool KateDocument::queryClose | ( | ) | [virtual] |
| void KateDocument::rangeEmpty | ( | KTextEditor::MovingRange * | movingRange | ) | [protected, virtual] |
Reimplemented from KTextEditor::MovingRangeFeedback.
Definition at line 5317 of file katedocument.cpp.
| void KateDocument::rangeInvalid | ( | KTextEditor::MovingRange * | movingRange | ) | [protected, virtual] |
Reimplemented from KTextEditor::MovingRangeFeedback.
Definition at line 5312 of file katedocument.cpp.
| KTextEditor::Range KateDocument::rangeOnLine | ( | KTextEditor::Range | range, | |
| int | line | |||
| ) | const |
Definition at line 350 of file katedocument.cpp.
| bool KateDocument::readOnly | ( | ) | const [inline] |
Definition at line 124 of file katedocument.h.
| void KateDocument::readParameterizedSessionConfig | ( | const KConfigGroup & | kconfig, | |
| unsigned long | configParameters | |||
| ) | [virtual] |
Implements KTextEditor::ParameterizedSessionConfigInterface.
Definition at line 1683 of file katedocument.cpp.
| void KateDocument::readSessionConfig | ( | const KConfigGroup & | kconfig | ) | [virtual] |
| void KateDocument::redo | ( | ) | [slot] |
Definition at line 1519 of file katedocument.cpp.
| uint KateDocument::redoCount | ( | ) | const |
Definition at line 1509 of file katedocument.cpp.
| void KateDocument::refreshOnTheFlyCheck | ( | const KTextEditor::Range & | range = KTextEditor::Range::invalid() |
) | [slot] |
Definition at line 5305 of file katedocument.cpp.
| void KateDocument::releaseRevision | ( | int | revision | ) | const [virtual] |
| void KateDocument::removeActionsFromDocument | ( | KTextEditor::SmartRange * | topRange | ) | [virtual, slot] |
| void KateDocument::removeActionsFromView | ( | KTextEditor::View * | view, | |
| KTextEditor::SmartRange * | topRange | |||
| ) | [virtual] |
| void KateDocument::removeHighlightFromDocument | ( | KTextEditor::SmartRange * | topRange | ) | [virtual, slot] |
| void KateDocument::removeHighlightFromView | ( | KTextEditor::View * | view, | |
| KTextEditor::SmartRange * | topRange | |||
| ) | [virtual] |
| bool KateDocument::removeLine | ( | int | line | ) | [virtual, slot] |
| void KateDocument::removeMark | ( | int | line, | |
| uint | markType | |||
| ) | [virtual, slot] |
| bool KateDocument::removeText | ( | const KTextEditor::Range & | range, | |
| bool | block = false | |||
| ) | [virtual, slot] |
| void KateDocument::removeView | ( | KTextEditor::View * | view | ) |
removes the view from the list of views.
The view is *not* deleted. That's your job. Or, easier, just delete the view in the first place. It will remove itself. TODO: this could be converted to a private slot connected to the view's destroyed() signal. It is not currently called anywhere except from the KateView destructor.
Definition at line 2624 of file katedocument.cpp.
| void KateDocument::repaintViews | ( | bool | paintOnlyDirty = true |
) |
Definition at line 3677 of file katedocument.cpp.
| void KateDocument::replaceCharactersByEncoding | ( | const KTextEditor::Range & | range | ) |
Definition at line 5433 of file katedocument.cpp.
| virtual bool KateDocument::replaceText | ( | const KTextEditor::Range & | r, | |
| const QStringList & | l, | |||
| bool | b | |||
| ) | [inline, virtual, slot] |
| bool KateDocument::replaceText | ( | const KTextEditor::Range & | range, | |
| const QString & | s, | |||
| bool | block = false | |||
| ) | [virtual, slot] |
| void KateDocument::requestMarkTooltip | ( | int | line, | |
| QPoint | position | |||
| ) | [slot] |
Definition at line 1886 of file katedocument.cpp.
| void KateDocument::respellCheckBlock | ( | KateDocument * | document, | |
| int | start, | |||
| int | end | |||
| ) | [signal] |
| void KateDocument::respellCheckBlock | ( | int | start, | |
| int | end | |||
| ) | [inline, slot] |
Definition at line 1157 of file katedocument.h.
| void KateDocument::revertToDefaultDictionary | ( | const KTextEditor::Range & | range | ) | [slot] |
Definition at line 5243 of file katedocument.cpp.
| qint64 KateDocument::revision | ( | ) | const [virtual] |
Current revision.
- Returns:
- current revision
Implements KTextEditor::MovingInterface.
Definition at line 5011 of file katedocument.cpp.
| bool KateDocument::save | ( | ) | [virtual, slot] |
| bool KateDocument::saveFile | ( | ) | [virtual] |
save the file obtained by the kparts framework the framework abstracts the uploading of remote files
- Returns:
- success
Implements KParts::ReadWritePart.
Definition at line 2180 of file katedocument.cpp.
| QVector< KTextEditor::Range > KateDocument::searchText | ( | const KTextEditor::Range & | range, | |
| const QString & | pattern, | |||
| const KTextEditor::Search::SearchOptions | options | |||
| ) | [virtual] |
Definition at line 1526 of file katedocument.cpp.
| void KateDocument::setActiveView | ( | KTextEditor::View * | view | ) |
Definition at line 2635 of file katedocument.cpp.
| void KateDocument::setAnnotationModel | ( | KTextEditor::AnnotationModel * | model | ) | [virtual] |
| void KateDocument::setDefaultDictionary | ( | const QString & | dict | ) | [slot] |
Definition at line 5248 of file katedocument.cpp.
| void KateDocument::setDictionary | ( | const QString & | dict, | |
| const KTextEditor::Range & | range | |||
| ) | [slot] |
Definition at line 5168 of file katedocument.cpp.
| void KateDocument::setDocName | ( | QString | docName | ) |
Definition at line 3784 of file katedocument.cpp.
| void KateDocument::setDontChangeHlOnSave | ( | ) |
allow to mark, that we changed hl on user wish and should not reset it atm used for the user visible menu to select highlightings
Definition at line 1666 of file katedocument.cpp.
| void KateDocument::setEditableMarks | ( | uint | markMask | ) | [virtual, slot] |
Set the current mode of the document by giving its name.
- Parameters:
-
name name of the mode to use for this document
- Returns:
- true on success, otherwise false
Implements KTextEditor::Document.
Definition at line 1623 of file katedocument.cpp.
| void KateDocument::setMark | ( | int | line, | |
| uint | markType | |||
| ) | [virtual, slot] |
| void KateDocument::setMarkDescription | ( | MarkInterface::MarkTypes | type, | |
| const QString & | description | |||
| ) | [virtual, slot] |
Definition at line 1943 of file katedocument.cpp.
| void KateDocument::setMarkPixmap | ( | MarkInterface::MarkTypes | type, | |
| const QPixmap & | pixmap | |||
| ) | [virtual, slot] |
Definition at line 1938 of file katedocument.cpp.
Set the current mode of the document by giving its name.
- Parameters:
-
name name of the mode to use for this document
- Returns:
- true on success, otherwise false
Implements KTextEditor::Document.
Definition at line 1601 of file katedocument.cpp.
| void KateDocument::setModified | ( | bool | m | ) | [virtual] |
| virtual void KateDocument::setModifiedOnDisk | ( | ModifiedOnDiskReason | reason | ) | [virtual] |
| void KateDocument::setModifiedOnDiskWarning | ( | bool | on | ) | [virtual] |
| void KateDocument::setPageUpDownMovesCursor | ( | bool | on | ) | [slot] |
Definition at line 4054 of file katedocument.cpp.
| void KateDocument::setReadWrite | ( | bool | rw = true |
) | [virtual] |
| bool KateDocument::setText | ( | const QStringList & | text | ) | [virtual, slot] |
| void KateDocument::setUndoMergeAllEdits | ( | bool | merge | ) |
Definition at line 4994 of file katedocument.cpp.
| void KateDocument::setWordWrap | ( | bool | on | ) | [slot] |
Definition at line 4034 of file katedocument.cpp.
| void KateDocument::setWordWrapAt | ( | uint | col | ) | [slot] |
Definition at line 4044 of file katedocument.cpp.
| bool KateDocument::simpleMode | ( | ) | [static] |
Definition at line 5043 of file katedocument.cpp.
| bool KateDocument::singleViewMode | ( | ) | const [inline] |
Definition at line 126 of file katedocument.h.
| void KateDocument::slotModifiedOnDisk | ( | KTextEditor::View * | v = 0 |
) | [virtual, slot] |
Ask the user what to do, if the file has been modified on disk.
Reimplemented from KTextEditor::Document.
Implements KTextEditor::ModificationInterface.
Definition at line 3825 of file katedocument.cpp.
Definition at line 4637 of file katedocument.cpp.
| KateSmartManager* KateDocument::smartManager | ( | ) | const [inline] |
Definition at line 568 of file katedocument.h.
| virtual bool KateDocument::startEditing | ( | ) | [inline, virtual] |
| KTextEditor::Search::SearchOptions KateDocument::supportedSearchOptions | ( | ) | const [virtual] |
| void KateDocument::tagLines | ( | KTextEditor::Cursor | start, | |
| KTextEditor::Cursor | end | |||
| ) | [slot] |
Definition at line 3664 of file katedocument.cpp.
| void KateDocument::tagLines | ( | int | start, | |
| int | end | |||
| ) | [slot] |
Definition at line 3658 of file katedocument.cpp.
| QString KateDocument::text | ( | ) | const [virtual] |
| QString KateDocument::text | ( | const KTextEditor::Range & | range, | |
| bool | blockwise = false | |||
| ) | const [virtual] |
| QStringList KateDocument::textLines | ( | const KTextEditor::Range & | range, | |
| bool | block = false | |||
| ) | const [virtual] |
| int KateDocument::totalCharacters | ( | ) | const [virtual] |
| uint KateDocument::toVirtualColumn | ( | const KTextEditor::Cursor & | cursor | ) |
Definition at line 2648 of file katedocument.cpp.
| void KateDocument::transform | ( | KateView * | view, | |
| const KTextEditor::Cursor & | c, | |||
| KateDocument::TextTransform | t | |||
| ) |
Handling uppercase, lowercase and capitalize for the view.
If there is a selection, that is transformed, otherwise for uppercase or lowercase the character right of the cursor is transformed, for capitalize the word under the cursor is transformed.
Definition at line 3496 of file katedocument.cpp.
| void KateDocument::transformCursor | ( | KTextEditor::Cursor & | cursor, | |
| KTextEditor::MovingCursor::InsertBehavior | insertBehavior, | |||
| qint64 | fromRevision, | |||
| qint64 | toRevision = -1 | |||
| ) | [virtual] |
Transform a cursor from one revision to an other.
- Parameters:
-
cursor cursor to transform insertBehavior behavior of this cursor on insert of text at it's position fromRevision from this revision we want to transform toRevision to this revision we want to transform, default of -1 is current revision
Implements KTextEditor::MovingInterface.
Definition at line 5031 of file katedocument.cpp.
| void KateDocument::transformRange | ( | KTextEditor::Range & | range, | |
| KTextEditor::MovingRange::InsertBehaviors | insertBehaviors, | |||
| KTextEditor::MovingRange::EmptyBehavior | emptyBehavior, | |||
| qint64 | fromRevision, | |||
| qint64 | toRevision = -1 | |||
| ) | [virtual] |
Transform a range from one revision to an other.
- Parameters:
-
range range to transform insertBehaviors behavior of this range on insert of text at it's position emptyBehavior behavior on becoming empty fromRevision from this revision we want to transform toRevision to this revision we want to transform, default of -1 is current revision
Implements KTextEditor::MovingInterface.
Definition at line 5036 of file katedocument.cpp.
| KTextEditor::Range KateDocument::translateFromRevision | ( | const KTextEditor::Range & | range, | |
| KTextEditor::SmartRange::InsertBehaviors | insertBehavior = KTextEditor::SmartRange::ExpandLeft | KTextEditor::SmartRange::ExpandRight | |||
| ) | const [virtual] |
| KTextEditor::Cursor KateDocument::translateFromRevision | ( | const KTextEditor::Cursor & | cursor, | |
| KTextEditor::SmartCursor::InsertBehavior | insertBehavior = KTextEditor::SmartCursor::StayOnInsert | |||
| ) | const [virtual] |
| void KateDocument::transpose | ( | const KTextEditor::Cursor & | cursor | ) |
Definition at line 2777 of file katedocument.cpp.
| void KateDocument::unbindSmartRange | ( | KTextEditor::SmartRange * | range | ) | [virtual] |
| void KateDocument::undo | ( | ) | [slot] |
Definition at line 1514 of file katedocument.cpp.
| void KateDocument::undoChanged | ( | ) | [signal] |
| uint KateDocument::undoCount | ( | ) | const |
Definition at line 1504 of file katedocument.cpp.
| void KateDocument::unlockRevision | ( | qint64 | revision | ) | [virtual] |
Release a revision.
- Parameters:
-
revision revision to release
Implements KTextEditor::MovingInterface.
Definition at line 5026 of file katedocument.cpp.
| void KateDocument::updateConfig | ( | ) |
Definition at line 4090 of file katedocument.cpp.
| void KateDocument::useRevision | ( | int | revision = -1 |
) | [virtual] |
| void KateDocument::variableChanged | ( | KTextEditor::Document * | , | |
| const QString & | , | |||
| const QString & | ||||
| ) | [virtual, signal] |
Implements KTextEditor::VariableInterface.
| const QList< KTextEditor::SmartRange * > KateDocument::viewActions | ( | KTextEditor::View * | view | ) | const [virtual] |
| const QList< KTextEditor::SmartRange * > KateDocument::viewHighlights | ( | KTextEditor::View * | view | ) | const [virtual] |
| const QList< KTextEditor::View * > & KateDocument::views | ( | ) | const [virtual] |
| uint KateDocument::visibleLines | ( | ) |
Definition at line 4973 of file katedocument.cpp.
| QWidget * KateDocument::widget | ( | ) | [virtual] |
- Returns:
- The widget defined by this part, set by setWidget().
Reimplemented from KParts::Part.
Definition at line 310 of file katedocument.cpp.
| bool KateDocument::wordWrap | ( | ) | const |
Definition at line 4039 of file katedocument.cpp.
| unsigned int KateDocument::wordWrapAt | ( | ) | const |
Definition at line 4049 of file katedocument.cpp.
| bool KateDocument::wrapText | ( | int | startLine, | |
| int | endLine | |||
| ) |
Remove a line.
- Parameters:
-
startLine line to begin wrapping endLine line to stop wrapping
- Returns:
- true on success
Definition at line 987 of file katedocument.cpp.
| void KateDocument::writeParameterizedSessionConfig | ( | KConfigGroup & | kconfig, | |
| unsigned long | configParameters | |||
| ) | [virtual] |
Implements KTextEditor::ParameterizedSessionConfigInterface.
Definition at line 1734 of file katedocument.cpp.
| void KateDocument::writeSessionConfig | ( | KConfigGroup & | kconfig | ) | [virtual] |
Member Data Documentation
QString KateDocument::m_defaultDictionary [protected] |
Definition at line 1185 of file katedocument.h.
QList<QPair<KTextEditor::MovingRange*, QString> > KateDocument::m_dictionaryRanges [protected] |
Definition at line 1186 of file katedocument.h.
KateEditHistory* const KateDocument::m_editHistory [protected] |
Definition at line 328 of file katedocument.h.
KateOnTheFlyChecker* KateDocument::m_onTheFlyChecker [protected] |
Definition at line 1184 of file katedocument.h.
KateUndoManager* const KateDocument::m_undoManager [protected] |
Definition at line 327 of file katedocument.h.
The documentation for this class was generated from the following files:
