Kate
KateDocument Class Reference
#include <katedocument.h>

Detailed Description
Definition at line 91 of file katedocument.h.
Member Enumeration Documentation
Definition at line 795 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 174 of file katedocument.cpp.
KateDocument::~KateDocument | ( | ) |
Definition at line 285 of file katedocument.cpp.
Member Function Documentation
void KateDocument::aboutToRemoveText | ( | const KTextEditor::Range & | ) | [signal] |
KateView * KateDocument::activeKateView | ( | ) | const |
Definition at line 5777 of file katedocument.cpp.
virtual KTextEditor::View* KateDocument::activeView | ( | ) | const [inline, virtual] |
Implements KTextEditor::Document.
Definition at line 150 of file katedocument.h.
void KateDocument::activeViewSelectionChanged | ( | KTextEditor::View * | view | ) | [signal] |
void KateDocument::addActionsToDocument | ( | KTextEditor::SmartRange * | topRange | ) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5906 of file katedocument.cpp.
void KateDocument::addActionsToView | ( | KTextEditor::View * | view, | |
KTextEditor::SmartRange * | topRange | |||
) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5931 of file katedocument.cpp.
void KateDocument::addHighlightToDocument | ( | KTextEditor::SmartRange * | topRange, | |
bool | supportDynamic | |||
) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5850 of file katedocument.cpp.
void KateDocument::addHighlightToView | ( | KTextEditor::View * | view, | |
KTextEditor::SmartRange * | topRange, | |||
bool | supportDynamic | |||
) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5891 of file katedocument.cpp.
void KateDocument::addMark | ( | int | line, | |
uint | markType | |||
) | [virtual, slot] |
Implements KTextEditor::MarkInterface.
Definition at line 2948 of file katedocument.cpp.
void KateDocument::addView | ( | KTextEditor::View * | view | ) |
Definition at line 3704 of file katedocument.cpp.
void KateDocument::align | ( | KateView * | view, | |
const KTextEditor::Range & | range | |||
) |
Definition at line 4104 of file katedocument.cpp.
KTextEditor::AnnotationModel * KateDocument::annotationModel | ( | ) | const [virtual] |
Implements KTextEditor::AnnotationInterface.
Definition at line 6100 of file katedocument.cpp.
void KateDocument::annotationModelChanged | ( | KTextEditor::AnnotationModel * | , | |
KTextEditor::AnnotationModel * | ||||
) | [signal] |
void KateDocument::attributeDynamic | ( | KTextEditor::Attribute::Ptr | a | ) | [protected, virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5946 of file katedocument.cpp.
void KateDocument::attributeNotDynamic | ( | KTextEditor::Attribute::Ptr | a | ) | [protected, virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5951 of file katedocument.cpp.
void KateDocument::backspace | ( | KateView * | view, | |
const KTextEditor::Cursor & | c | |||
) |
Definition at line 3923 of file katedocument.cpp.
KateBrowserExtension* KateDocument::browserExtension | ( | ) | [inline] |
Definition at line 133 of file katedocument.h.
bool KateDocument::browserView | ( | ) | const [inline] |
Definition at line 131 of file katedocument.h.
void KateDocument::bufferHlChanged | ( | ) |
Definition at line 2831 of file katedocument.cpp.
QChar KateDocument::character | ( | const KTextEditor::Cursor & | position | ) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 433 of file katedocument.cpp.
void KateDocument::charactersSemiInteractivelyInserted | ( | const KTextEditor::Cursor & | position, | |
const QString & | text | |||
) | [signal] |
Definition at line 5733 of file katedocument.cpp.
bool KateDocument::clear | ( | ) | [virtual, slot] |
Implements KTextEditor::Document.
Definition at line 556 of file katedocument.cpp.
void KateDocument::clearDocumentActions | ( | ) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5987 of file katedocument.cpp.
void KateDocument::clearDocumentHighlights | ( | ) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5977 of file katedocument.cpp.
void KateDocument::clearMark | ( | int | line | ) | [virtual, slot] |
Implements KTextEditor::MarkInterface.
Definition at line 2932 of file katedocument.cpp.
void KateDocument::clearMarks | ( | ) | [virtual, slot] |
Implements KTextEditor::MarkInterface.
Definition at line 3023 of file katedocument.cpp.
void KateDocument::clearSmartInterface | ( | ) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5956 of file katedocument.cpp.
void KateDocument::clearViewActions | ( | KTextEditor::View * | view | ) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5992 of file katedocument.cpp.
void KateDocument::clearViewHighlights | ( | KTextEditor::View * | view | ) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5982 of file katedocument.cpp.
bool KateDocument::closeUrl | ( | ) | [virtual] |
Reimplemented from KParts::ReadWritePart.
Definition at line 3560 of file katedocument.cpp.
void KateDocument::codeFoldingUpdated | ( | ) | [signal] |
void KateDocument::comment | ( | KateView * | view, | |
uint | line, | |||
uint | column, | |||
int | change | |||
) |
Definition at line 4467 of file katedocument.cpp.
KateDocumentConfig* KateDocument::config | ( | ) | const [inline] |
Definition at line 1061 of file katedocument.h.
KateDocumentConfig* KateDocument::config | ( | ) | [inline] |
Configuration.
Definition at line 1060 of file katedocument.h.
KTextEditor::View * KateDocument::createView | ( | QWidget * | parent | ) | [virtual] |
Implements KTextEditor::Document.
Definition at line 337 of file katedocument.cpp.
int KateDocument::currentRevision | ( | ) | const [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5789 of file katedocument.cpp.
void KateDocument::del | ( | KateView * | view, | |
const KTextEditor::Cursor & | c | |||
) |
Definition at line 4007 of file katedocument.cpp.
void KateDocument::deleteCursors | ( | ) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5967 of file katedocument.cpp.
void KateDocument::deleteRanges | ( | ) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5972 of file katedocument.cpp.
const QList< KTextEditor::SmartRange * > KateDocument::documentActions | ( | ) | const [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5926 of file katedocument.cpp.
KTextEditor::Cursor KateDocument::documentEnd | ( | ) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 5782 of file katedocument.cpp.
const QList< KTextEditor::SmartRange * > KateDocument::documentHighlights | ( | ) | const [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5886 of file katedocument.cpp.
const QString& KateDocument::documentName | ( | ) | const [inline, virtual] |
Implements KTextEditor::Document.
Definition at line 891 of file katedocument.h.
bool KateDocument::documentReload | ( | ) | [virtual, slot] |
Reloads the current document from disk if possible.
Implements KTextEditor::Document.
Definition at line 5017 of file katedocument.cpp.
bool KateDocument::documentSave | ( | ) | [virtual, slot] |
Implements KTextEditor::Document.
Definition at line 5102 of file katedocument.cpp.
bool KateDocument::documentSaveAs | ( | ) | [virtual, slot] |
Implements KTextEditor::Document.
Definition at line 5110 of file katedocument.cpp.
void KateDocument::dumpRegionTree | ( | ) | [protected, slot] |
Definition at line 5155 of file katedocument.cpp.
void KateDocument::dynamicHighlightAdded | ( | KateSmartRange * | range | ) | [signal] |
void KateDocument::dynamicHighlightRemoved | ( | KateSmartRange * | range | ) | [signal] |
uint KateDocument::editableMarks | ( | ) | const [virtual] |
Implements KTextEditor::MarkInterface.
Definition at line 3079 of file katedocument.cpp.
void KateDocument::editBegin | ( | Kate::EditSource | editSource = Kate::NoEditSource |
) | [inline] |
Same as editStart() with undo.
Definition at line 209 of file katedocument.h.
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 1378 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 1136 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 1195 of file katedocument.cpp.
KTextEditor::Editor * KateDocument::editor | ( | ) | [virtual] |
Implements KTextEditor::Document.
Definition at line 353 of file katedocument.cpp.
bool KateDocument::editRemoveLine | ( | int | line, | |
Kate::EditSource | editSource = Kate::NoEditSource | |||
) |
Remove a line.
- Parameters:
-
line line number
- Returns:
- true on success
Definition at line 1438 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 1165 of file katedocument.cpp.
void KateDocument::editStart | ( | bool | withUndo = true , |
|
Kate::EditSource | editSource = Kate::NoEditSource | |||
) |
Enclose editor actions with editStart()
and editEnd()
to group them.
- Parameters:
-
withUndo if true, add undo history
Definition at line 910 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 1305 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 1221 of file katedocument.cpp.
const QString & KateDocument::encoding | ( | ) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 5177 of file katedocument.cpp.
bool KateDocument::endEditing | ( | ) | [inline, virtual] |
Implements KTextEditor::Document.
Definition at line 220 of file katedocument.h.
void KateDocument::escapePlaintext | ( | QString & | text, | |
QList< ReplacementPart > * | parts = NULL , |
|||
bool | replacementGoodies = false | |||
) | [static] |
Resolves escape sequences (e.g.
"\\n" to "\n") in text
if parts
is NULL. Otherwise it leaves code>text unmodified and creates a list of text and capture references out of it. These two modes are fused into one function to avoid code duplication.
- Parameters:
-
text Text to process parts List of text and references replacementGoodies Enable , , and #
Definition at line 2170 of file katedocument.cpp.
void KateDocument::exportAs | ( | const QString & | ) | [inline, slot] |
Definition at line 761 of file katedocument.h.
QString KateDocument::fileType | ( | ) | const [inline] |
Definition at line 1016 of file katedocument.h.
bool KateDocument::findMatchingBracket | ( | KTextEditor::Range & | range, | |
int | maxLines = -1 | |||
) |
Definition at line 4794 of file katedocument.cpp.
KateCodeFoldingTree * KateDocument::foldingTree | ( | ) |
Definition at line 5166 of file katedocument.cpp.
uint KateDocument::getRealLine | ( | unsigned int | virtualLine | ) |
Definition at line 6007 of file katedocument.cpp.
uint KateDocument::getVirtualLine | ( | unsigned int | realLine | ) |
Definition at line 6012 of file katedocument.cpp.
QString KateDocument::getWord | ( | const KTextEditor::Cursor & | cursor | ) |
Definition at line 4727 of file katedocument.cpp.
KateHighlighting * KateDocument::highlight | ( | ) | const |
Definition at line 6002 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 2806 of file katedocument.cpp.
void KateDocument::highlightingModeChanged | ( | KTextEditor::Document * | document | ) | [signal] |
Warn anyone listening that the current document's highlighting mode has changed.
- Parameters:
-
document the document which's mode has changed
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 2811 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 2821 of file katedocument.cpp.
class KateEditHistory* KateDocument::history | ( | ) | const [inline] |
Definition at line 346 of file katedocument.h.
void KateDocument::ignoreModifiedOnDiskOnce | ( | ) |
Definition at line 5997 of file katedocument.cpp.
void KateDocument::indent | ( | KateView * | view, | |
uint | line, | |||
int | change | |||
) |
Definition at line 4082 of file katedocument.cpp.
void KateDocument::inputMethodEnd | ( | ) |
Definition at line 1009 of file katedocument.cpp.
void KateDocument::inputMethodStart | ( | ) |
Definition at line 1004 of file katedocument.cpp.
Implements KTextEditor::Document.
Definition at line 829 of file katedocument.cpp.
bool KateDocument::insertLines | ( | int | line, | |
const QStringList & | s | |||
) | [virtual, slot] |
Implements KTextEditor::Document.
Definition at line 840 of file katedocument.cpp.
bool KateDocument::insertTemplateTextImplementation | ( | const KTextEditor::Cursor & | c, | |
const QString & | templateString, | |||
const QMap< QString, QString > & | initialValues, | |||
QWidget * | ||||
) | [virtual] |
Definition at line 5751 of file katedocument.cpp.
bool KateDocument::insertText | ( | const KTextEditor::Cursor & | position, | |
const QStringList & | text, | |||
bool | block = false | |||
) | [virtual, slot] |
Implements KTextEditor::Document.
Definition at line 662 of file katedocument.cpp.
bool KateDocument::insertText | ( | const KTextEditor::Cursor & | position, | |
const QString & | s, | |||
bool | block = false | |||
) | [virtual, slot] |
Implements KTextEditor::Document.
Definition at line 572 of file katedocument.cpp.
bool KateDocument::invokeTemplateHandler | ( | int | key | ) |
Definition at line 5768 of file katedocument.cpp.
bool KateDocument::isEditRunning | ( | ) | const |
Definition at line 6053 of file katedocument.cpp.
bool KateDocument::isModifiedOnDisc | ( | ) | [inline] |
- Returns:
- wheather the document is modified on disk since last saved.
Definition at line 903 of file katedocument.h.
bool KateDocument::isWithUndo | ( | ) | const |
States whether the edit currently in progress has undo enabled.
The method may only be called when an edit is actually in progress, i.e. isEditRunning() is true.
Definition at line 6058 of file katedocument.cpp.
void KateDocument::joinLines | ( | uint | first, | |
uint | last | |||
) |
Unwrap a range of lines.
Definition at line 4686 of file katedocument.cpp.
KateTextLine::Ptr KateDocument::kateTextLine | ( | uint | i | ) |
Definition at line 6022 of file katedocument.cpp.
int KateDocument::lastLine | ( | ) | const [inline] |
gets the last line number (lines() - 1)
Definition at line 748 of file katedocument.h.
QString KateDocument::line | ( | int | line | ) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 494 of file katedocument.cpp.
void KateDocument::lineInfo | ( | KateLineInfo * | info, | |
unsigned int | line | |||
) |
Definition at line 5161 of file katedocument.cpp.
int KateDocument::lineLength | ( | int | line | ) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 892 of file katedocument.cpp.
int KateDocument::lines | ( | ) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 882 of file katedocument.cpp.
void KateDocument::makeAttribs | ( | bool | needInvalidate = true |
) |
Definition at line 3683 of file katedocument.cpp.
uint KateDocument::mark | ( | int | line | ) | [virtual] |
Implements KTextEditor::MarkInterface.
Definition at line 2918 of file katedocument.cpp.
void KateDocument::markChanged | ( | KTextEditor::Document * | , | |
KTextEditor::Mark | , | |||
KTextEditor::MarkInterface::MarkChangeAction | ||||
) | [virtual, signal] |
Implements KTextEditor::MarkInterface.
QColor KateDocument::markColor | ( | MarkInterface::MarkTypes | type | ) | const |
Definition at line 3058 of file katedocument.cpp.
QString KateDocument::markDescription | ( | MarkInterface::MarkTypes | type | ) | const |
Definition at line 3068 of file katedocument.cpp.
QPixmap KateDocument::markPixmap | ( | MarkInterface::MarkTypes | type | ) | const |
Definition at line 3052 of file katedocument.cpp.
const QHash< int, KTextEditor::Mark * > & KateDocument::marks | ( | ) | [virtual] |
Implements KTextEditor::MarkInterface.
Definition at line 3018 of file katedocument.cpp.
void KateDocument::marksChanged | ( | KTextEditor::Document * | ) | [virtual, signal] |
Implements KTextEditor::MarkInterface.
QString KateDocument::mimeType | ( | ) | [virtual] |
- Returns:
- the name of the mimetype for the document.
This method is using KMimeType::findByUrl, and if the pointer is then still the default MimeType for a nonlocal or unsaved file, uses mimeTypeForContent().
Implements KTextEditor::Document.
Definition at line 3098 of file katedocument.cpp.
KMimeType::Ptr KateDocument::mimeTypeForContent | ( | ) |
- Returns:
- a pointer to the KMimeType for this document, found by analyzing the actual content.
Note that this method is *not* part of the DocumentInfoInterface.
Definition at line 3112 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 2784 of file katedocument.cpp.
void KateDocument::modeChanged | ( | KTextEditor::Document * | document | ) | [signal] |
Warn anyone listening that the current document's mode has changed.
- Parameters:
-
document the document which's mode has changed
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 2789 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 2826 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 4779 of file katedocument.cpp.
void KateDocument::newLine | ( | KateView * | view | ) |
Definition at line 3858 of file katedocument.cpp.
KTextEditor::SmartCursor * KateDocument::newSmartCursor | ( | const KTextEditor::Cursor & | position, | |
KTextEditor::SmartCursor::InsertBehavior | insertBehavior = KTextEditor::SmartCursor::MoveOnInsert | |||
) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5814 of file katedocument.cpp.
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 5824 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 5819 of file katedocument.cpp.
int KateDocument::numVisLines | ( | ) | const |
Definition at line 887 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
Implements KParts::ReadOnlyPart.
Definition at line 3143 of file katedocument.cpp.
Definition at line 3752 of file katedocument.cpp.
bool KateDocument::pageUpDownMovesCursor | ( | ) | const |
Definition at line 5150 of file katedocument.cpp.
void KateDocument::paste | ( | KateView * | view, | |
QClipboard::Mode | mode = QClipboard::Clipboard | |||
) |
Definition at line 4024 of file katedocument.cpp.
KateTextLine::Ptr KateDocument::plainKateTextLine | ( | uint | i | ) |
Definition at line 6028 of file katedocument.cpp.
void KateDocument::popEditState | ( | ) |
Definition at line 995 of file katedocument.cpp.
void KateDocument::preHighlightChanged | ( | uint | ) | [signal] |
bool KateDocument::print | ( | ) | [slot] |
Definition at line 3091 of file katedocument.cpp.
bool KateDocument::printDialog | ( | ) | [slot] |
Definition at line 3086 of file katedocument.cpp.
KEncodingProber::ProberType KateDocument::proberTypeForEncodingAutoDetection | ( | ) | const |
Definition at line 5187 of file katedocument.cpp.
void KateDocument::pushEditState | ( | ) |
Definition at line 990 of file katedocument.cpp.
bool KateDocument::queryClose | ( | ) | [virtual] |
Reimplemented from KParts::ReadWritePart.
Definition at line 6107 of file katedocument.cpp.
bool KateDocument::readOnly | ( | ) | const [inline] |
Definition at line 130 of file katedocument.h.
void KateDocument::readSessionConfig | ( | const KConfigGroup & | kconfig | ) | [virtual] |
Implements KTextEditor::SessionConfigInterface.
Definition at line 2849 of file katedocument.cpp.
void KateDocument::redo | ( | ) | [slot] |
Definition at line 1523 of file katedocument.cpp.
uint KateDocument::redoCount | ( | ) | const |
Definition at line 1513 of file katedocument.cpp.
void KateDocument::releaseRevision | ( | int | revision | ) | const [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5794 of file katedocument.cpp.
void KateDocument::removeActionsFromDocument | ( | KTextEditor::SmartRange * | topRange | ) | [virtual, slot] |
Implements KTextEditor::SmartInterface.
Definition at line 5917 of file katedocument.cpp.
void KateDocument::removeActionsFromView | ( | KTextEditor::View * | view, | |
KTextEditor::SmartRange * | topRange | |||
) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5936 of file katedocument.cpp.
void KateDocument::removeHighlightFromDocument | ( | KTextEditor::SmartRange * | topRange | ) | [virtual, slot] |
Implements KTextEditor::SmartInterface.
Definition at line 5869 of file katedocument.cpp.
void KateDocument::removeHighlightFromView | ( | KTextEditor::View * | view, | |
KTextEditor::SmartRange * | topRange | |||
) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5896 of file katedocument.cpp.
bool KateDocument::removeLine | ( | int | line | ) | [virtual, slot] |
Implements KTextEditor::Document.
Definition at line 856 of file katedocument.cpp.
void KateDocument::removeMark | ( | int | line, | |
uint | markType | |||
) | [virtual, slot] |
Implements KTextEditor::MarkInterface.
Definition at line 2985 of file katedocument.cpp.
bool KateDocument::removeText | ( | const KTextEditor::Range & | range, | |
bool | block = false | |||
) | [virtual, slot] |
Implements KTextEditor::Document.
Definition at line 752 of file katedocument.cpp.
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 3726 of file katedocument.cpp.
void KateDocument::repaintViews | ( | bool | paintOnlyDirty = true |
) |
Definition at line 4762 of file katedocument.cpp.
Repairs a regular Expression pattern.
This is a workaround to make "." and "\s" not match newlines, which currently is the unconfigurable default in QRegExp.
- Parameters:
-
pattern Regular expression stillMultiLine Multi-line after reparation flag
- Returns:
- Number of replacements done
Definition at line 2554 of file katedocument.cpp.
bool KateDocument::replaceText | ( | const KTextEditor::Range & | r, | |
const QStringList & | l, | |||
bool | b | |||
) | [inline, virtual, slot] |
Reimplemented from KTextEditor::Document.
Definition at line 182 of file katedocument.h.
bool KateDocument::replaceText | ( | const KTextEditor::Range & | range, | |
const QString & | s, | |||
bool | block = false | |||
) | [virtual, slot] |
Reimplemented from KTextEditor::Document.
Definition at line 5840 of file katedocument.cpp.
bool KateDocument::save | ( | ) | [virtual, slot] |
Reimplemented from KParts::ReadWritePart.
Definition at line 6174 of file katedocument.cpp.
Reimplemented from KParts::ReadWritePart.
Definition at line 6179 of file katedocument.cpp.
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 3288 of file katedocument.cpp.
QVector< KTextEditor::Range > KateDocument::searchText | ( | const KTextEditor::Range & | range, | |
const QString & | pattern, | |||
const KTextEditor::Search::SearchOptions | options | |||
) | [slot] |
Definition at line 2078 of file katedocument.cpp.
void KateDocument::setActiveView | ( | KTextEditor::View * | view | ) |
Definition at line 3737 of file katedocument.cpp.
void KateDocument::setAnnotationModel | ( | KTextEditor::AnnotationModel * | model | ) | [virtual] |
Implements KTextEditor::AnnotationInterface.
Definition at line 6093 of file katedocument.cpp.
void KateDocument::setDocName | ( | QString | docName | ) |
Definition at line 4883 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 2842 of file katedocument.cpp.
void KateDocument::setEditableMarks | ( | uint | markMask | ) | [virtual, slot] |
Implements KTextEditor::MarkInterface.
Definition at line 3074 of file katedocument.cpp.
Implements KTextEditor::Document.
Definition at line 5171 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 2800 of file katedocument.cpp.
void KateDocument::setMark | ( | int | line, | |
uint | markType | |||
) | [virtual, slot] |
Implements KTextEditor::MarkInterface.
Definition at line 2926 of file katedocument.cpp.
void KateDocument::setMarkDescription | ( | MarkInterface::MarkTypes | type, | |
const QString & | description | |||
) | [slot] |
Definition at line 3047 of file katedocument.cpp.
void KateDocument::setMarkPixmap | ( | MarkInterface::MarkTypes | type, | |
const QPixmap & | pixmap | |||
) | [slot] |
Definition at line 3042 of file katedocument.cpp.
void KateDocument::setMergeAllEdits | ( | bool | merge | ) |
Definition at line 6065 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 2778 of file katedocument.cpp.
void KateDocument::setModified | ( | bool | m | ) | [virtual] |
Reimplemented from KParts::ReadWritePart.
Definition at line 3664 of file katedocument.cpp.
void KateDocument::setModifiedOnDisk | ( | ModifiedOnDiskReason | reason | ) | [virtual] |
Implements KTextEditor::ModificationInterface.
Definition at line 4998 of file katedocument.cpp.
void KateDocument::setModifiedOnDiskWarning | ( | bool | on | ) | [virtual] |
Implements KTextEditor::ModificationInterface.
Definition at line 5012 of file katedocument.cpp.
void KateDocument::setPageUpDownMovesCursor | ( | bool | on | ) | [slot] |
Definition at line 5145 of file katedocument.cpp.
void KateDocument::setProberTypeForEncodingAutoDetection | ( | KEncodingProber::ProberType | proberType | ) |
Definition at line 5182 of file katedocument.cpp.
void KateDocument::setReadWrite | ( | bool | rw = true |
) | [virtual] |
Reimplemented from KParts::ReadWritePart.
Definition at line 3650 of file katedocument.cpp.
bool KateDocument::setText | ( | const QStringList & | text | ) | [virtual, slot] |
Implements KTextEditor::Document.
Definition at line 530 of file katedocument.cpp.
Implements KTextEditor::Document.
Definition at line 504 of file katedocument.cpp.
void KateDocument::setUndoAllowComplexMerge | ( | bool | allow | ) |
Definition at line 6038 of file katedocument.cpp.
void KateDocument::setUndoDontMerge | ( | bool | dontMerge | ) |
Definition at line 6048 of file katedocument.cpp.
void KateDocument::setWordWrap | ( | bool | on | ) | [slot] |
Definition at line 5125 of file katedocument.cpp.
void KateDocument::setWordWrapAt | ( | uint | col | ) | [slot] |
Definition at line 5135 of file katedocument.cpp.
bool KateDocument::simpleMode | ( | ) | [static] |
Definition at line 6081 of file katedocument.cpp.
bool KateDocument::singleViewMode | ( | ) | const [inline] |
Definition at line 132 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 4924 of file katedocument.cpp.
Definition at line 5707 of file katedocument.cpp.
KateSmartManager* KateDocument::smartManager | ( | ) | const [inline] |
Definition at line 674 of file katedocument.h.
bool KateDocument::startEditing | ( | ) | [inline, virtual] |
Implements KTextEditor::Document.
Definition at line 219 of file katedocument.h.
KTextEditor::Search::SearchOptions KateDocument::supportedSearchOptions | ( | ) | const [virtual, slot] |
Implements KTextEditor::SearchInterface.
Definition at line 2155 of file katedocument.cpp.
void KateDocument::tagLines | ( | KTextEditor::Cursor | start, | |
KTextEditor::Cursor | end | |||
) | [slot] |
Definition at line 4749 of file katedocument.cpp.
void KateDocument::tagLines | ( | int | start, | |
int | end | |||
) | [slot] |
Definition at line 4743 of file katedocument.cpp.
void KateDocument::testTemplateCode | ( | ) | [protected, slot] |
Definition at line 5762 of file katedocument.cpp.
QString KateDocument::text | ( | ) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 360 of file katedocument.cpp.
QString KateDocument::text | ( | const KTextEditor::Range & | range, | |
bool | blockwise = false | |||
) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 380 of file katedocument.cpp.
QStringList KateDocument::textLines | ( | const KTextEditor::Range & | range, | |
bool | block = false | |||
) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 446 of file katedocument.cpp.
void KateDocument::textRemoved | ( | ) | [signal] |
int KateDocument::totalCharacters | ( | ) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 867 of file katedocument.cpp.
uint KateDocument::toVirtualColumn | ( | const KTextEditor::Cursor & | cursor | ) |
Definition at line 3757 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 4581 of file katedocument.cpp.
KTextEditor::Range KateDocument::translateFromRevision | ( | const KTextEditor::Range & | range, | |
KTextEditor::SmartRange::InsertBehaviors | insertBehavior = KTextEditor::SmartRange::ExpandLeft | KTextEditor::SmartRange::ExpandRight | |||
) | const [virtual] |
Reimplemented from KTextEditor::SmartInterface.
Definition at line 5809 of file katedocument.cpp.
KTextEditor::Cursor KateDocument::translateFromRevision | ( | const KTextEditor::Cursor & | cursor, | |
KTextEditor::SmartCursor::InsertBehavior | insertBehavior = KTextEditor::SmartCursor::StayOnInsert | |||
) | const [virtual] |
Reimplemented from KTextEditor::SmartInterface.
Definition at line 5804 of file katedocument.cpp.
void KateDocument::transpose | ( | const KTextEditor::Cursor & | cursor | ) |
Definition at line 3892 of file katedocument.cpp.
Type chars in a view.
Definition at line 3767 of file katedocument.cpp.
void KateDocument::unbindSmartRange | ( | KTextEditor::SmartRange * | range | ) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5835 of file katedocument.cpp.
void KateDocument::undo | ( | ) | [slot] |
Definition at line 1518 of file katedocument.cpp.
bool KateDocument::undoAllowComplexMerge | ( | ) | const |
Definition at line 6043 of file katedocument.cpp.
void KateDocument::undoChanged | ( | ) | [signal] |
uint KateDocument::undoCount | ( | ) | const |
Definition at line 1508 of file katedocument.cpp.
bool KateDocument::undoDontMerge | ( | ) | const |
Definition at line 6033 of file katedocument.cpp.
void KateDocument::undoSafePoint | ( | ) |
Definition at line 939 of file katedocument.cpp.
void KateDocument::updateConfig | ( | ) |
Definition at line 5192 of file katedocument.cpp.
set the indentation mode, if any in the mode...
Definition at line 5660 of file katedocument.cpp.
void KateDocument::useRevision | ( | int | revision = -1 |
) | [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5799 of file katedocument.cpp.
Implements KTextEditor::VariableInterface.
Definition at line 5531 of file katedocument.cpp.
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] |
Implements KTextEditor::SmartInterface.
Definition at line 5941 of file katedocument.cpp.
const QList< KTextEditor::SmartRange * > KateDocument::viewHighlights | ( | KTextEditor::View * | view | ) | const [virtual] |
Implements KTextEditor::SmartInterface.
Definition at line 5901 of file katedocument.cpp.
const QList< KTextEditor::View * > & KateDocument::views | ( | ) | const [virtual] |
Implements KTextEditor::Document.
Definition at line 348 of file katedocument.cpp.
uint KateDocument::visibleLines | ( | ) |
Definition at line 6017 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 318 of file katedocument.cpp.
bool KateDocument::wordWrap | ( | ) | const |
Definition at line 5130 of file katedocument.cpp.
unsigned int KateDocument::wordWrapAt | ( | ) | const |
Definition at line 5140 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 1014 of file katedocument.cpp.
void KateDocument::writeSessionConfig | ( | KConfigGroup & | kconfig | ) | [virtual] |
Implements KTextEditor::SessionConfigInterface.
Definition at line 2883 of file katedocument.cpp.
Member Data Documentation
KateTemplateHandler* KateDocument::m_templateHandler [protected] |
Definition at line 1130 of file katedocument.h.
The documentation for this class was generated from the following files: