• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

Kate

KateDocument Class Reference

#include <katedocument.h>

Inheritance diagram for KateDocument:

Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 93 of file katedocument.h.


Public Types

enum  TextTransform { Uppercase, Lowercase, Capitalize }

Public Slots

void addMark (int line, uint markType)
virtual bool clear ()
void clearMark (int line)
void clearMarks ()
void clearRedo ()
void clearUndo ()
bool documentReload ()
bool documentSave ()
bool documentSaveAs ()
void exportAs (const QString &)
virtual bool insertLine (int line, const QString &s)
virtual bool insertLines (int line, const QStringList &s)
virtual bool insertText (const KTextEditor::Cursor &position, const QStringList &text, bool block=false)
virtual bool insertText (const KTextEditor::Cursor &position, const QString &s, bool block=false)
bool print ()
bool printDialog ()
void redo ()
virtual void removeActionsFromDocument (KTextEditor::SmartRange *topRange)
virtual void removeHighlightFromDocument (KTextEditor::SmartRange *topRange)
bool removeLine (int line)
void removeMark (int line, uint markType)
bool removeText (const KTextEditor::Range &range, bool block=false)
bool replaceText (const KTextEditor::Range &r, const QStringList &l, bool b)
bool replaceText (const KTextEditor::Range &range, const QString &s, bool block=false)
QVector< KTextEditor::Range > searchText (const KTextEditor::Range &range, const QString &pattern, const KTextEditor::Search::SearchOptions options)
void setEditableMarks (uint markMask)
void setMark (int line, uint markType)
void setMarkDescription (MarkInterface::MarkTypes, const QString &)
void setMarkPixmap (MarkInterface::MarkTypes, const QPixmap &)
void setPageUpDownMovesCursor (bool on)
virtual bool setText (const QStringList &text)
virtual bool setText (const QString &)
void setWordWrap (bool on)
void setWordWrapAt (uint col)
void slotModifiedOnDisk (KTextEditor::View *v=0)
void slotQueryClose_save (bool *handled, bool *abortClosing)
KTextEditor::Search::SearchOptions supportedSearchOptions () const
void tagLines (KTextEditor::Cursor start, KTextEditor::Cursor end)
void tagLines (int start, int end)
void undo ()

Signals

void aboutToRemoveText (const KTextEditor::Range &)
void activeViewSelectionChanged (KTextEditor::View *view)
void annotationModelChanged (KTextEditor::AnnotationModel *, KTextEditor::AnnotationModel *)
void charactersSemiInteractivelyInserted (const KTextEditor::Cursor &position, const QString &text)
void codeFoldingUpdated ()
void dynamicHighlightAdded (KateSmartRange *range)
void dynamicHighlightRemoved (KateSmartRange *range)
void editLineUnWrapped (int line, int col)
void editLineWrapped (int line, int col, int len)
void highlightingModeChanged (KTextEditor::Document *document)
void markChanged (KTextEditor::Document *, KTextEditor::Mark, KTextEditor::MarkInterface::MarkChangeAction)
void marksChanged (KTextEditor::Document *)
void modeChanged (KTextEditor::Document *document)
void modifiedOnDisk (KTextEditor::Document *doc, bool isModified, KTextEditor::ModificationInterface::ModifiedOnDiskReason reason)
void preHighlightChanged (uint)
void textRemoved ()
void undoChanged ()
void variableChanged (KTextEditor::Document *, const QString &, const QString &)

Public Member Functions

KateView * activeKateView () const
virtual KTextEditor::View * activeView () const
virtual void addActionsToDocument (KTextEditor::SmartRange *topRange)
virtual void addActionsToView (KTextEditor::View *view, KTextEditor::SmartRange *topRange)
virtual void addHighlightToDocument (KTextEditor::SmartRange *topRange, bool supportDynamic)
virtual void addHighlightToView (KTextEditor::View *view, KTextEditor::SmartRange *topRange, bool supportDynamic)
void addView (KTextEditor::View *)
void align (KateView *view, uint line)
virtual
KTextEditor::AnnotationModel * 
annotationModel () const
void backspace (KateView *view, const KTextEditor::Cursor &)
KateBrowserExtension * browserExtension ()
bool browserView () const
void bufferHlChanged ()
virtual QChar character (const KTextEditor::Cursor &position) const
virtual void clearDocumentActions ()
virtual void clearDocumentHighlights ()
virtual void clearSmartInterface ()
virtual void clearViewActions (KTextEditor::View *view)
virtual void clearViewHighlights (KTextEditor::View *view)
bool closeUrl ()
void comment (KateView *view, uint line, uint column, int change)
KateDocumentConfig * config () const
KateDocumentConfig * config ()
KTextEditor::View * createView (QWidget *parent)
virtual int currentRevision () const
void del (KateView *view, const KTextEditor::Cursor &)
virtual void deleteCursors ()
virtual void deleteRanges ()
virtual const QList
< KTextEditor::SmartRange * > 
documentActions () const
virtual KTextEditor::Cursor documentEnd () const
virtual const QList
< KTextEditor::SmartRange * > 
documentHighlights () const
const QString & documentName () const
uint editableMarks () const
void editBegin (Kate::EditSource editSource=Kate::NoEditSource)
void editEnd ()
bool editInsertLine (int line, const QString &s, Kate::EditSource editSource=Kate::NoEditSource)
bool editInsertText (int line, int col, const QString &s, Kate::EditSource editSource=Kate::NoEditSource)
bool editMarkLineAutoWrapped (int line, bool autowrapped)
KTextEditor::Editor * editor ()
bool editRemoveLine (int line, Kate::EditSource editSource=Kate::NoEditSource)
bool editRemoveText (int line, int col, int len, Kate::EditSource editSource=Kate::NoEditSource)
void editStart (bool withUndo=true, Kate::EditSource editSource=Kate::NoEditSource)
bool editUnWrapLine (int line, bool removeLine=true, int length=0)
bool editWrapLine (int line, int col, bool newLine=true, bool *newLineAdded=0)
const QString & encoding () const
bool endEditing ()
QString fileType () const
bool findMatchingBracket (KTextEditor::Range &range, int maxLines=-1)
KateCodeFoldingTree * foldingTree ()
uint getRealLine (unsigned int virtualLine)
uint getVirtualLine (unsigned int realLine)
QString getWord (const KTextEditor::Cursor &cursor)
KateHighlighting * highlight () const
virtual QString highlightingMode () const
virtual QStringList highlightingModes () const
virtual QString highlightingModeSection (int index) const
class KateEditHistory * history () const
void ignoreModifiedOnDiskOnce ()
void indent (KateView *view, uint line, int change)
bool insertTemplateTextImplementation (const KTextEditor::Cursor &c, const QString &templateString, const QMap< QString, QString > &initialValues, QWidget *)
bool invokeTabInterceptor (int key)
bool isEditRunning () const
bool isModifiedOnDisc ()
bool isWithUndo () const
void joinLines (uint first, uint last)
 KateDocument (bool bSingleViewMode=false, bool bBrowserView=false, bool bReadOnly=false, QWidget *parentWidget=0, QObject *=0)
KateTextLine::Ptr kateTextLine (uint i)
int lastLine () const
virtual QString line (int line) const
void lineInfo (KateLineInfo *info, unsigned int line)
int lineLength (int line) const
int lines () const
void makeAttribs (bool needInvalidate=true)
uint mark (int line)
QColor markColor (MarkInterface::MarkTypes) const
QString markDescription (MarkInterface::MarkTypes) const
QPixmap markPixmap (MarkInterface::MarkTypes) const
const QHash< int,
KTextEditor::Mark * > & 
marks ()
QString mimeType ()
KMimeType::Ptr mimeTypeForContent ()
virtual QString mode () const
virtual QStringList modes () const
virtual QString modeSection (int index) const
void newBracketMark (const KTextEditor::Cursor &start, KTextEditor::Range &bm, int maxLines=-1)
void newLine (KateView *view)
virtual KTextEditor::SmartCursor * newSmartCursor (const KTextEditor::Cursor &position, KTextEditor::SmartCursor::InsertBehavior insertBehavior=KTextEditor::SmartCursor::MoveOnInsert)
virtual KTextEditor::SmartRange * newSmartRange (KTextEditor::SmartCursor *start, KTextEditor::SmartCursor *end, KTextEditor::SmartRange *parent=0L, KTextEditor::SmartRange::InsertBehaviors insertBehavior=KTextEditor::SmartRange::DoNotExpand)
virtual KTextEditor::SmartRange * newSmartRange (const KTextEditor::Range &range, KTextEditor::SmartRange *parent=0L, KTextEditor::SmartRange::InsertBehaviors insertBehavior=KTextEditor::SmartRange::DoNotExpand)
int numVisLines () const
bool openFile ()
bool ownedView (KateView *)
bool pageUpDownMovesCursor () const
void paste (KateView *view, QClipboard::Mode=QClipboard::Clipboard)
KateTextLine::Ptr plainKateTextLine (uint i)
void popEditState ()
void pushEditState ()
virtual bool queryClose ()
bool readOnly () const
void readSessionConfig (const KConfigGroup &)
uint redoCount () const
virtual void releaseRevision (int revision) const
virtual void removeActionsFromView (KTextEditor::View *view, KTextEditor::SmartRange *topRange)
virtual void removeHighlightFromView (KTextEditor::View *view, KTextEditor::SmartRange *topRange)
bool removeTabInterceptor (KateKeyInterceptorFunctor *interceptor)
void removeView (KTextEditor::View *)
void repaintViews (bool paintOnlyDirty=true)
bool saveFile ()
KEncodingDetector::AutoDetectScript scriptForEncodingAutoDetection () const
void setActiveView (KTextEditor::View *)
virtual void setAnnotationModel (KTextEditor::AnnotationModel *model)
void setDocName (QString docName)
bool setEncoding (const QString &e)
virtual bool setHighlightingMode (const QString &name)
virtual bool setMode (const QString &name)
void setModified (bool m)
void setModifiedOnDisk (ModifiedOnDiskReason reason)
void setModifiedOnDiskWarning (bool on)
void setReadWrite (bool rw=true)
void setScriptForEncodingAutoDetection (KEncodingDetector::AutoDetectScript)
bool setTabInterceptor (KateKeyInterceptorFunctor *interceptor)
void setUndoDontMerge (bool dontMerge)
void setUndoDontMergeComplex (bool dontMerge)
bool singleViewMode () const
KateSmartManager * smartManager () const
bool startEditing ()
void tagAll ()
virtual QString text () const
virtual QString text (const KTextEditor::Range &range, bool blockwise=false) const
virtual QStringList textLines (const KTextEditor::Range &range, bool block=false) const
int totalCharacters () const
uint toVirtualColumn (const KTextEditor::Cursor &)
void transform (KateView *view, const KTextEditor::Cursor &, TextTransform)
virtual KTextEditor::Range translateFromRevision (const KTextEditor::Range &range, KTextEditor::SmartRange::InsertBehaviors insertBehavior=KTextEditor::SmartRange::ExpandLeft|KTextEditor::SmartRange::ExpandRight) const
virtual KTextEditor::Cursor translateFromRevision (const KTextEditor::Cursor &cursor, KTextEditor::SmartCursor::InsertBehavior insertBehavior=KTextEditor::SmartCursor::StayOnInsert) const
void transpose (const KTextEditor::Cursor &)
bool typeChars (KateView *type, const QString &chars)
virtual void unbindSmartRange (KTextEditor::SmartRange *range)
uint undoCount () const
bool undoDontMerge () const
bool undoDontMergeComplex () const
void undoSafePoint ()
void updateConfig ()
void updateFileType (const QString &newType, bool user=false)
virtual void useRevision (int revision=-1)
QString variable (const QString &name) const
virtual const QList
< KTextEditor::SmartRange * > 
viewActions (KTextEditor::View *view) const
virtual const QList
< KTextEditor::SmartRange * > 
viewHighlights (KTextEditor::View *view) const
const QList< KTextEditor::View * > & views () const
uint visibleLines ()
virtual QWidget * widget ()
bool wordWrap () const
uint wordWrapAt () const
bool wrapText (int startLine, int endLine)
void writeSessionConfig (KConfigGroup &)
 ~KateDocument ()

Static Public Member Functions

static bool checkOverwrite (KUrl u, QWidget *parent)
static void escapePlaintext (QString &text, QList< ReplacementPart > *parts=NULL, bool replacementGoodies=false)
static int repairPattern (QString &pattern, bool &stillMultiLine)
static bool simpleMode ()

Protected Slots

void dumpRegionTree ()
void testTemplateCode ()

Protected Member Functions

virtual void attributeDynamic (KTextEditor::Attribute::Ptr a)
virtual void attributeNotDynamic (KTextEditor::Attribute::Ptr a)

Protected Attributes

KateKeyInterceptorFunctor * m_tabInterceptor

Member Enumeration Documentation

enum KateDocument::TextTransform

Enumerator:
Uppercase 
Lowercase 
Capitalize 

Definition at line 812 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 218 of file katedocument.cpp.

KateDocument::~KateDocument (  ) 

Definition at line 340 of file katedocument.cpp.


Member Function Documentation

void KateDocument::aboutToRemoveText ( const KTextEditor::Range &   )  [signal]

KateView * KateDocument::activeKateView (  )  const

Definition at line 5994 of file katedocument.cpp.

virtual KTextEditor::View* KateDocument::activeView (  )  const [inline, virtual]

Implements KTextEditor::Document.

Definition at line 152 of file katedocument.h.

void KateDocument::activeViewSelectionChanged ( KTextEditor::View *  view  )  [signal]

void KateDocument::addActionsToDocument ( KTextEditor::SmartRange *  topRange  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6123 of file katedocument.cpp.

void KateDocument::addActionsToView ( KTextEditor::View *  view,
KTextEditor::SmartRange *  topRange 
) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6148 of file katedocument.cpp.

void KateDocument::addHighlightToDocument ( KTextEditor::SmartRange *  topRange,
bool  supportDynamic 
) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6067 of file katedocument.cpp.

void KateDocument::addHighlightToView ( KTextEditor::View *  view,
KTextEditor::SmartRange *  topRange,
bool  supportDynamic 
) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6108 of file katedocument.cpp.

void KateDocument::addMark ( int  line,
uint  markType 
) [virtual, slot]

Implements KTextEditor::MarkInterface.

Definition at line 3176 of file katedocument.cpp.

void KateDocument::addView ( KTextEditor::View *  view  ) 

Definition at line 3923 of file katedocument.cpp.

void KateDocument::align ( KateView *  view,
uint  line 
)

Definition at line 4317 of file katedocument.cpp.

KTextEditor::AnnotationModel * KateDocument::annotationModel (  )  const [virtual]

Implements KTextEditor::AnnotationInterface.

Definition at line 6303 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 6163 of file katedocument.cpp.

void KateDocument::attributeNotDynamic ( KTextEditor::Attribute::Ptr  a  )  [protected, virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6168 of file katedocument.cpp.

void KateDocument::backspace ( KateView *  view,
const KTextEditor::Cursor &  c 
)

Definition at line 4137 of file katedocument.cpp.

KateBrowserExtension* KateDocument::browserExtension (  )  [inline]

Definition at line 135 of file katedocument.h.

bool KateDocument::browserView (  )  const [inline]

Definition at line 133 of file katedocument.h.

void KateDocument::bufferHlChanged (  ) 

Definition at line 3066 of file katedocument.cpp.

QChar KateDocument::character ( const KTextEditor::Cursor &  position  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 495 of file katedocument.cpp.

void KateDocument::charactersSemiInteractivelyInserted ( const KTextEditor::Cursor &  position,
const QString &  text 
) [signal]

bool KateDocument::checkOverwrite ( KUrl  u,
QWidget *  parent 
) [static]

Definition at line 5949 of file katedocument.cpp.

bool KateDocument::clear (  )  [virtual, slot]

Implements KTextEditor::Document.

Definition at line 618 of file katedocument.cpp.

void KateDocument::clearDocumentActions (  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6204 of file katedocument.cpp.

void KateDocument::clearDocumentHighlights (  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6194 of file katedocument.cpp.

void KateDocument::clearMark ( int  line  )  [virtual, slot]

Implements KTextEditor::MarkInterface.

Definition at line 3160 of file katedocument.cpp.

void KateDocument::clearMarks (  )  [virtual, slot]

Implements KTextEditor::MarkInterface.

Definition at line 3251 of file katedocument.cpp.

void KateDocument::clearRedo (  )  [slot]

Definition at line 1750 of file katedocument.cpp.

void KateDocument::clearSmartInterface (  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6173 of file katedocument.cpp.

void KateDocument::clearUndo (  )  [slot]

Definition at line 1739 of file katedocument.cpp.

void KateDocument::clearViewActions ( KTextEditor::View *  view  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6209 of file katedocument.cpp.

void KateDocument::clearViewHighlights ( KTextEditor::View *  view  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6199 of file katedocument.cpp.

bool KateDocument::closeUrl (  )  [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 3777 of file katedocument.cpp.

void KateDocument::codeFoldingUpdated (  )  [signal]

void KateDocument::comment ( KateView *  view,
uint  line,
uint  column,
int  change 
)

Definition at line 4683 of file katedocument.cpp.

KateDocumentConfig* KateDocument::config (  )  const [inline]

Definition at line 1075 of file katedocument.h.

KateDocumentConfig* KateDocument::config (  )  [inline]

Configuration.

Definition at line 1074 of file katedocument.h.

KTextEditor::View * KateDocument::createView ( QWidget *  parent  )  [virtual]

Implements KTextEditor::Document.

Definition at line 398 of file katedocument.cpp.

int KateDocument::currentRevision (  )  const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6006 of file katedocument.cpp.

void KateDocument::del ( KateView *  view,
const KTextEditor::Cursor &  c 
)

Definition at line 4221 of file katedocument.cpp.

void KateDocument::deleteCursors (  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6184 of file katedocument.cpp.

void KateDocument::deleteRanges (  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6189 of file katedocument.cpp.

const QList< KTextEditor::SmartRange * > KateDocument::documentActions (  )  const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6143 of file katedocument.cpp.

KTextEditor::Cursor KateDocument::documentEnd (  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 5999 of file katedocument.cpp.

const QList< KTextEditor::SmartRange * > KateDocument::documentHighlights (  )  const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6103 of file katedocument.cpp.

const QString& KateDocument::documentName (  )  const [inline, virtual]

Implements KTextEditor::Document.

Definition at line 910 of file katedocument.h.

bool KateDocument::documentReload (  )  [virtual, slot]

Reloads the current document from disc if possible.

Implements KTextEditor::Document.

Definition at line 5249 of file katedocument.cpp.

bool KateDocument::documentSave (  )  [virtual, slot]

Implements KTextEditor::Document.

Definition at line 5329 of file katedocument.cpp.

bool KateDocument::documentSaveAs (  )  [virtual, slot]

Implements KTextEditor::Document.

Definition at line 5337 of file katedocument.cpp.

void KateDocument::dumpRegionTree (  )  [protected, slot]

Definition at line 5382 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 3307 of file katedocument.cpp.

void KateDocument::editBegin ( Kate::EditSource  editSource = Kate::NoEditSource  )  [inline]

Same as editStart() with undo.

Definition at line 211 of file katedocument.h.

void KateDocument::editEnd (  ) 

End a editor operation.

See also:
editStart()

Definition at line 1073 of file katedocument.cpp.

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 1505 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 1267 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.

bool KateDocument::editMarkLineAutoWrapped ( int  line,
bool  autowrapped 
)

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 1326 of file katedocument.cpp.

KTextEditor::Editor * KateDocument::editor (  )  [virtual]

Implements KTextEditor::Document.

Definition at line 415 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 1563 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 1296 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 972 of file katedocument.cpp.

bool KateDocument::editUnWrapLine ( int  line,
bool  removeLine = true,
int  length = 0 
)

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 1434 of file katedocument.cpp.

bool KateDocument::editWrapLine ( int  line,
int  col,
bool  newLine = true,
bool *  newLineAdded = 0 
)

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 1352 of file katedocument.cpp.

const QString & KateDocument::encoding (  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 5403 of file katedocument.cpp.

bool KateDocument::endEditing (  )  [inline, virtual]

Implements KTextEditor::Document.

Definition at line 222 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 2398 of file katedocument.cpp.

void KateDocument::exportAs ( const QString &   )  [inline, slot]

Definition at line 778 of file katedocument.h.

QString KateDocument::fileType (  )  const [inline]

Definition at line 1030 of file katedocument.h.

bool KateDocument::findMatchingBracket ( KTextEditor::Range &  range,
int  maxLines = -1 
)

Definition at line 5022 of file katedocument.cpp.

KateCodeFoldingTree * KateDocument::foldingTree (  ) 

Definition at line 5393 of file katedocument.cpp.

uint KateDocument::getRealLine ( unsigned int  virtualLine  ) 

Definition at line 6224 of file katedocument.cpp.

uint KateDocument::getVirtualLine ( unsigned int  realLine  ) 

Definition at line 6229 of file katedocument.cpp.

QString KateDocument::getWord ( const KTextEditor::Cursor &  cursor  ) 

Definition at line 4943 of file katedocument.cpp.

KateHighlighting * KateDocument::highlight (  )  const

Definition at line 6219 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 3041 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

Reimplemented from KTextEditor::Document.

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 3046 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 3056 of file katedocument.cpp.

class KateEditHistory* KateDocument::history (  )  const [inline]

Definition at line 349 of file katedocument.h.

void KateDocument::ignoreModifiedOnDiskOnce (  ) 

Definition at line 6214 of file katedocument.cpp.

void KateDocument::indent ( KateView *  view,
uint  line,
int  change 
)

Definition at line 4295 of file katedocument.cpp.

bool KateDocument::insertLine ( int  line,
const QString &  s 
) [virtual, slot]

Implements KTextEditor::Document.

Definition at line 891 of file katedocument.cpp.

bool KateDocument::insertLines ( int  line,
const QStringList &  s 
) [virtual, slot]

Implements KTextEditor::Document.

Definition at line 902 of file katedocument.cpp.

bool KateDocument::insertTemplateTextImplementation ( const KTextEditor::Cursor &  c,
const QString &  templateString,
const QMap< QString, QString > &  initialValues,
QWidget *   
)

Definition at line 5967 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 724 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 634 of file katedocument.cpp.

bool KateDocument::invokeTabInterceptor ( int  key  ) 

Definition at line 5977 of file katedocument.cpp.

bool KateDocument::isEditRunning (  )  const

Definition at line 6269 of file katedocument.cpp.

bool KateDocument::isModifiedOnDisc (  )  [inline]

Returns:
wheather the document is modified on disc since last saved.

Definition at line 922 of file katedocument.h.

bool KateDocument::isWithUndo (  )  const [inline]

Definition at line 322 of file katedocument.h.

void KateDocument::joinLines ( uint  first,
uint  last 
)

Unwrap a range of lines.

Definition at line 4902 of file katedocument.cpp.

KateTextLine::Ptr KateDocument::kateTextLine ( uint  i  ) 

Definition at line 6239 of file katedocument.cpp.

int KateDocument::lastLine (  )  const [inline]

gets the last line number (lines() - 1)

Definition at line 765 of file katedocument.h.

QString KateDocument::line ( int  line  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 556 of file katedocument.cpp.

void KateDocument::lineInfo ( KateLineInfo *  info,
unsigned int  line 
)

Definition at line 5388 of file katedocument.cpp.

int KateDocument::lineLength ( int  line  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 954 of file katedocument.cpp.

int KateDocument::lines (  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 944 of file katedocument.cpp.

void KateDocument::makeAttribs ( bool  needInvalidate = true  ) 

Definition at line 3906 of file katedocument.cpp.

uint KateDocument::mark ( int  line  )  [virtual]

Implements KTextEditor::MarkInterface.

Definition at line 3146 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 3286 of file katedocument.cpp.

QString KateDocument::markDescription ( MarkInterface::MarkTypes  type  )  const

Definition at line 3296 of file katedocument.cpp.

QPixmap KateDocument::markPixmap ( MarkInterface::MarkTypes  type  )  const

Definition at line 3280 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 3246 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 3326 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 3340 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 3012 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

Reimplemented from KTextEditor::Document.

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 3017 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 3061 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 5007 of file katedocument.cpp.

void KateDocument::newLine ( KateView *  view  ) 

Definition at line 4072 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 6031 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 6041 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 6036 of file katedocument.cpp.

int KateDocument::numVisLines (  )  const

Definition at line 949 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 3371 of file katedocument.cpp.

bool KateDocument::ownedView ( KateView *  view  ) 

Definition at line 3966 of file katedocument.cpp.

bool KateDocument::pageUpDownMovesCursor (  )  const

Definition at line 5377 of file katedocument.cpp.

void KateDocument::paste ( KateView *  view,
QClipboard::Mode  mode = QClipboard::Clipboard 
)

Definition at line 4238 of file katedocument.cpp.

KateTextLine::Ptr KateDocument::plainKateTextLine ( uint  i  ) 

Definition at line 6244 of file katedocument.cpp.

void KateDocument::popEditState (  ) 

Definition at line 1118 of file katedocument.cpp.

void KateDocument::preHighlightChanged ( uint   )  [signal]

bool KateDocument::print (  )  [slot]

Definition at line 3319 of file katedocument.cpp.

bool KateDocument::printDialog (  )  [slot]

Definition at line 3314 of file katedocument.cpp.

void KateDocument::pushEditState (  ) 

Definition at line 1113 of file katedocument.cpp.

bool KateDocument::queryClose (  )  [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 6310 of file katedocument.cpp.

bool KateDocument::readOnly (  )  const [inline]

Definition at line 132 of file katedocument.h.

void KateDocument::readSessionConfig ( const KConfigGroup &  kconfig  )  [virtual]

Implements KTextEditor::SessionConfigInterface.

Definition at line 3084 of file katedocument.cpp.

void KateDocument::redo (  )  [slot]

Definition at line 1653 of file katedocument.cpp.

uint KateDocument::redoCount (  )  const

Definition at line 1633 of file katedocument.cpp.

void KateDocument::releaseRevision ( int  revision  )  const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6011 of file katedocument.cpp.

void KateDocument::removeActionsFromDocument ( KTextEditor::SmartRange *  topRange  )  [virtual, slot]

Implements KTextEditor::SmartInterface.

Definition at line 6134 of file katedocument.cpp.

void KateDocument::removeActionsFromView ( KTextEditor::View *  view,
KTextEditor::SmartRange *  topRange 
) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6153 of file katedocument.cpp.

void KateDocument::removeHighlightFromDocument ( KTextEditor::SmartRange *  topRange  )  [virtual, slot]

Implements KTextEditor::SmartInterface.

Definition at line 6086 of file katedocument.cpp.

void KateDocument::removeHighlightFromView ( KTextEditor::View *  view,
KTextEditor::SmartRange *  topRange 
) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6113 of file katedocument.cpp.

bool KateDocument::removeLine ( int  line  )  [virtual, slot]

Implements KTextEditor::Document.

Definition at line 918 of file katedocument.cpp.

void KateDocument::removeMark ( int  line,
uint  markType 
) [virtual, slot]

Implements KTextEditor::MarkInterface.

Definition at line 3213 of file katedocument.cpp.

bool KateDocument::removeTabInterceptor ( KateKeyInterceptorFunctor *  interceptor  ) 

Definition at line 5988 of file katedocument.cpp.

bool KateDocument::removeText ( const KTextEditor::Range &  range,
bool  block = false 
) [virtual, slot]

Implements KTextEditor::Document.

Definition at line 814 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 3940 of file katedocument.cpp.

void KateDocument::repaintViews ( bool  paintOnlyDirty = true  ) 

Definition at line 4978 of file katedocument.cpp.

int KateDocument::repairPattern ( QString &  pattern,
bool &  stillMultiLine 
) [static]

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 2782 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 184 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 6057 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 3514 of file katedocument.cpp.

KEncodingDetector::AutoDetectScript KateDocument::scriptForEncodingAutoDetection (  )  const

Definition at line 5413 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 2306 of file katedocument.cpp.

void KateDocument::setActiveView ( KTextEditor::View *  view  ) 

Definition at line 3951 of file katedocument.cpp.

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

Implements KTextEditor::AnnotationInterface.

Definition at line 6296 of file katedocument.cpp.

void KateDocument::setDocName ( QString  docName  ) 

Definition at line 5116 of file katedocument.cpp.

void KateDocument::setEditableMarks ( uint  markMask  )  [virtual, slot]

Implements KTextEditor::MarkInterface.

Definition at line 3302 of file katedocument.cpp.

bool KateDocument::setEncoding ( const QString &  e  )  [virtual]

Implements KTextEditor::Document.

Definition at line 5398 of file katedocument.cpp.

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

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 3028 of file katedocument.cpp.

void KateDocument::setMark ( int  line,
uint  markType 
) [virtual, slot]

Implements KTextEditor::MarkInterface.

Definition at line 3154 of file katedocument.cpp.

void KateDocument::setMarkDescription ( MarkInterface::MarkTypes  type,
const QString &  description 
) [slot]

Definition at line 3275 of file katedocument.cpp.

void KateDocument::setMarkPixmap ( MarkInterface::MarkTypes  type,
const QPixmap &  pixmap 
) [slot]

Definition at line 3270 of file katedocument.cpp.

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

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 3006 of file katedocument.cpp.

void KateDocument::setModified ( bool  m  )  [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 3874 of file katedocument.cpp.

void KateDocument::setModifiedOnDisk ( ModifiedOnDiskReason  reason  )  [virtual]

Implements KTextEditor::ModificationInterface.

Definition at line 5230 of file katedocument.cpp.

void KateDocument::setModifiedOnDiskWarning ( bool  on  )  [virtual]

Implements KTextEditor::ModificationInterface.

Definition at line 5244 of file katedocument.cpp.

void KateDocument::setPageUpDownMovesCursor ( bool  on  )  [slot]

Definition at line 5372 of file katedocument.cpp.

void KateDocument::setReadWrite ( bool  rw = true  )  [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 3860 of file katedocument.cpp.

void KateDocument::setScriptForEncodingAutoDetection ( KEncodingDetector::AutoDetectScript  script  ) 

Definition at line 5408 of file katedocument.cpp.

bool KateDocument::setTabInterceptor ( KateKeyInterceptorFunctor *  interceptor  ) 

Definition at line 5982 of file katedocument.cpp.

bool KateDocument::setText ( const QStringList &  text  )  [virtual, slot]

Implements KTextEditor::Document.

Definition at line 592 of file katedocument.cpp.

bool KateDocument::setText ( const QString &  s  )  [virtual, slot]

Implements KTextEditor::Document.

Definition at line 566 of file katedocument.cpp.

void KateDocument::setUndoDontMerge ( bool  dontMerge  ) 

Definition at line 6264 of file katedocument.cpp.

void KateDocument::setUndoDontMergeComplex ( bool  dontMerge  ) 

Definition at line 6254 of file katedocument.cpp.

void KateDocument::setWordWrap ( bool  on  )  [slot]

Definition at line 5352 of file katedocument.cpp.

void KateDocument::setWordWrapAt ( uint  col  )  [slot]

Definition at line 5362 of file katedocument.cpp.

bool KateDocument::simpleMode (  )  [static]

Definition at line 6284 of file katedocument.cpp.

bool KateDocument::singleViewMode (  )  const [inline]

Definition at line 134 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 disc.

Reimplemented from KTextEditor::Document.

Implements KTextEditor::ModificationInterface.

Definition at line 5156 of file katedocument.cpp.

void KateDocument::slotQueryClose_save ( bool *  handled,
bool *  abortClosing 
) [slot]

Definition at line 5923 of file katedocument.cpp.

KateSmartManager* KateDocument::smartManager (  )  const [inline]

Definition at line 691 of file katedocument.h.

bool KateDocument::startEditing (  )  [inline, virtual]

Implements KTextEditor::Document.

Definition at line 221 of file katedocument.h.

KTextEditor::Search::SearchOptions KateDocument::supportedSearchOptions (  )  const [virtual, slot]

Implements KTextEditor::SearchInterface.

Definition at line 2383 of file katedocument.cpp.

void KateDocument::tagAll (  ) 

Definition at line 4984 of file katedocument.cpp.

void KateDocument::tagLines ( KTextEditor::Cursor  start,
KTextEditor::Cursor  end 
) [slot]

Definition at line 4965 of file katedocument.cpp.

void KateDocument::tagLines ( int  start,
int  end 
) [slot]

Definition at line 4959 of file katedocument.cpp.

void KateDocument::testTemplateCode (  )  [protected, slot]

Definition at line 5971 of file katedocument.cpp.

QString KateDocument::text (  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 422 of file katedocument.cpp.

QString KateDocument::text ( const KTextEditor::Range &  range,
bool  blockwise = false 
) const [virtual]

Implements KTextEditor::Document.

Definition at line 442 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 508 of file katedocument.cpp.

void KateDocument::textRemoved (  )  [signal]

int KateDocument::totalCharacters (  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 929 of file katedocument.cpp.

uint KateDocument::toVirtualColumn ( const KTextEditor::Cursor &  cursor  ) 

Definition at line 3971 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 4797 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 6026 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 6021 of file katedocument.cpp.

void KateDocument::transpose ( const KTextEditor::Cursor &  cursor  ) 

Definition at line 4106 of file katedocument.cpp.

bool KateDocument::typeChars ( KateView *  type,
const QString &  chars 
)

Type chars in a view.

Definition at line 3981 of file katedocument.cpp.

void KateDocument::unbindSmartRange ( KTextEditor::SmartRange *  range  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6052 of file katedocument.cpp.

void KateDocument::undo (  )  [slot]

Definition at line 1638 of file katedocument.cpp.

void KateDocument::undoChanged (  )  [signal]

uint KateDocument::undoCount (  )  const

Definition at line 1628 of file katedocument.cpp.

bool KateDocument::undoDontMerge (  )  const

Definition at line 6249 of file katedocument.cpp.

bool KateDocument::undoDontMergeComplex (  )  const

Definition at line 6259 of file katedocument.cpp.

void KateDocument::undoSafePoint (  ) 

Definition at line 1064 of file katedocument.cpp.

void KateDocument::updateConfig (  ) 

Definition at line 5418 of file katedocument.cpp.

void KateDocument::updateFileType ( const QString &  newType,
bool  user = false 
)

Definition at line 5881 of file katedocument.cpp.

void KateDocument::useRevision ( int  revision = -1  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6016 of file katedocument.cpp.

QString KateDocument::variable ( const QString &  name  )  const [virtual]

Implements KTextEditor::VariableInterface.

Definition at line 5756 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 6158 of file katedocument.cpp.

const QList< KTextEditor::SmartRange * > KateDocument::viewHighlights ( KTextEditor::View *  view  )  const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 6118 of file katedocument.cpp.

const QList< KTextEditor::View * > & KateDocument::views (  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 410 of file katedocument.cpp.

uint KateDocument::visibleLines (  ) 

Definition at line 6234 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 379 of file katedocument.cpp.

bool KateDocument::wordWrap (  )  const

Definition at line 5357 of file katedocument.cpp.

unsigned int KateDocument::wordWrapAt (  )  const

Definition at line 5367 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 1127 of file katedocument.cpp.

void KateDocument::writeSessionConfig ( KConfigGroup &  kconfig  )  [virtual]

Implements KTextEditor::SessionConfigInterface.

Definition at line 3114 of file katedocument.cpp.


Member Data Documentation

KateKeyInterceptorFunctor* KateDocument::m_tabInterceptor [protected]

Definition at line 1143 of file katedocument.h.


The documentation for this class was generated from the following files:
  • katedocument.h
  • katedocument.cpp

Kate

Skip menu "Kate"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal