• Skip to content
  • Skip to link menu
KDE 4.4 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.

Public Types

enum  EncodedCharaterInsertionPolicy { EncodeAlways, EncodeWhenPresent, EncodeNever }
typedef QList< QPair< int, int > > OffsetList
enum  TextTransform { Uppercase, Lowercase, Capitalize }

Public Slots

void addMark (int line, uint markType)
virtual bool clear ()
void clearDictionaryRanges ()
void clearMark (int line)
void clearMarks ()
bool documentReload ()
bool documentSave ()
bool documentSaveAs ()
void exportAs (const QString &)
bool handleMarkClick (int line)
bool handleMarkContextMenu (int line, QPoint position)
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)
void onTheFlySpellCheckingEnabled (bool enable)
bool print ()
bool printDialog ()
void redo ()
void refreshOnTheFlyCheck (const KTextEditor::Range &range=KTextEditor::Range::invalid())
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)
void requestMarkTooltip (int line, QPoint position)
void respellCheckBlock (int start, int end)
void revertToDefaultDictionary (const KTextEditor::Range &range)
virtual bool save ()
void setDefaultDictionary (const QString &dict)
void setDictionary (const QString &dict, const KTextEditor::Range &range)
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)
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 configChanged ()
void defaultDictionaryChanged (KateDocument *document)
void dictionaryRangesPresent (bool yesNo)
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 markClicked (KTextEditor::Document *document, KTextEditor::Mark mark, bool &handled)
void markContextMenuRequested (KTextEditor::Document *document, KTextEditor::Mark mark, QPoint pos, bool &handled)
void marksChanged (KTextEditor::Document *)
void markToolTipRequested (KTextEditor::Document *document, KTextEditor::Mark mark, QPoint position, bool &handled)
void modeChanged (KTextEditor::Document *document)
void modifiedOnDisk (KTextEditor::Document *doc, bool isModified, KTextEditor::ModificationInterface::ModifiedOnDiskReason reason)
void preHighlightChanged (uint)
void respellCheckBlock (KateDocument *document, int start, int end)
void textRemoved ()
void undoChanged ()
void variableChanged (KTextEditor::Document *, const QString &, const QString &)

Public Member Functions

 KateDocument (bool bSingleViewMode=false, bool bBrowserView=false, bool bReadOnly=false, QWidget *parentWidget=0, QObject *=0)
 ~KateDocument ()
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, const KTextEditor::Range &range)
virtual
KTextEditor::AnnotationModel * 
annotationModel () const
void backspace (KateView *view, const KTextEditor::Cursor &)
void bomSetByUser ()
KateBrowserExtension * browserExtension ()
bool browserView () const
void bufferHlChanged ()
virtual QChar character (const KTextEditor::Cursor &position) const
virtual void clearDocumentActions ()
virtual void clearDocumentHighlights ()
void clearMisspellingForWord (const QString &word)
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)
int computePositionWrtOffsets (const OffsetList &offsetList, int pos)
KateDocumentConfig * config () const
KateDocumentConfig * config ()
QStringList configKeys () const
QVariant configValue (const QString &key)
bool containsCharacterEncoding (const KTextEditor::Range &range)
KTextEditor::View * createView (QWidget *parent)
virtual int currentRevision () const
QString decodeCharacters (const KTextEditor::Range &range, KateDocument::OffsetList &decToEncOffsetList, KateDocument::OffsetList &encToDecOffsetList)
QString defaultDictionary () const
virtual KTextEditor::Attribute::Ptr defaultStyle (const KTextEditor::HighlightInterface::DefaultStyle ds) const
void del (KateView *view, const KTextEditor::Cursor &)
virtual void deleteCursors ()
virtual void deleteRanges ()
QString dictionaryForMisspelledRange (const KTextEditor::Range &range) const
QList< QPair
< KTextEditor::SmartRange
*, QString > > 
dictionaryRanges () const
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 editRemoveLines (int from, int to, Kate::EditSource editSource=Kate::NoEditSource)
bool editRemoveText (int line, int col, int len, Kate::EditSource editSource=Kate::NoEditSource)
void editStart (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)
virtual QStringList embeddedModes () const
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
KateEditHistory * history () const
void ignoreModifiedOnDiskOnce ()
void indent (KateView *view, uint line, int change)
void inputMethodEnd ()
void inputMethodStart ()
virtual bool insertTemplateTextImplementation (const KTextEditor::Cursor &c, const QString &templateString, const QMap< QString, QString > &initialValues, QWidget *)
bool isEditRunning () const
bool isModifiedOnDisc ()
bool isOnTheFlySpellCheckingEnabled () const
void joinLines (uint first, uint last)
KateTextLine::Ptr kateTextLine (uint i)
int lastLine () const
virtual QString line (int line) const
virtual QList
< KTextEditor::HighlightInterface::AttributeBlock > 
lineAttributes (const unsigned int line)
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 QString modeAt (const KTextEditor::Cursor &position)
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
QPair< KTextEditor::Range,
QString > 
onTheFlyMisspelledItem (const KTextEditor::Cursor &cursor) const
bool openFile ()
bool ownedView (KateView *)
bool pageUpDownMovesCursor () const
void paste (KateView *view, QClipboard::Mode=QClipboard::Clipboard)
KateTextLine::Ptr plainKateTextLine (uint i)
void popEditState ()
KEncodingProber::ProberType proberTypeForEncodingAutoDetection () const
void pushEditState ()
virtual bool queryClose ()
bool readOnly () const
void readParameterizedSessionConfig (const KConfigGroup &, unsigned long configParameters)
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)
void removeView (KTextEditor::View *)
void repaintViews (bool paintOnlyDirty=true)
void replaceCharactersByEncoding (const KTextEditor::Range &range)
virtual bool saveAs (const KUrl &url)
bool saveFile ()
QVector< KTextEditor::Range > searchText (const KTextEditor::Range &range, const QString &pattern, const KTextEditor::Search::SearchOptions options)
void setActiveView (KTextEditor::View *)
virtual void setAnnotationModel (KTextEditor::AnnotationModel *model)
void setConfigValue (const QString &key, const QVariant &value)
void setDocName (QString docName)
void setDontChangeHlOnSave ()
bool setEncoding (const QString &e)
virtual bool setHighlightingMode (const QString &name)
void setMergeAllEdits (bool merge)
virtual bool setMode (const QString &name)
void setModified (bool m)
void setModifiedOnDisk (ModifiedOnDiskReason reason)
void setModifiedOnDiskWarning (bool on)
void setProberTypeForEncodingAutoDetection (KEncodingProber::ProberType)
void setReadWrite (bool rw=true)
void setUndoAllowComplexMerge (bool allow)
void setUndoDontMerge (bool dontMerge)
bool singleViewMode () const
KateSmartManager * smartManager () const
bool startEditing ()
KTextEditor::Search::SearchOptions supportedSearchOptions () const
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)
bool undoAllowComplexMerge () const
uint undoCount () const
bool undoDontMerge () 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 writeParameterizedSessionConfig (KConfigGroup &, unsigned long configParameters)
void writeSessionConfig (KConfigGroup &)

Static Public Member Functions

static bool checkOverwrite (KUrl u, QWidget *parent)
static bool simpleMode ()

Protected Slots

void deleteDiscardedSmartRanges ()
void dictionaryRangeEliminated (KTextEditor::SmartRange *smartRange)
void dumpRegionTree ()

Protected Member Functions

virtual void attributeDynamic (KTextEditor::Attribute::Ptr a)
virtual void attributeNotDynamic (KTextEditor::Attribute::Ptr a)
KTextEditor::SmartRangeNotifier * dictionaryRangeNotifier ()

Protected Attributes

QString m_defaultDictionary
KTextEditor::SmartRangeNotifier * m_dictionaryRangeNotifier
QList< QPair
< KTextEditor::SmartRange
*, QString > > 
m_dictionaryRanges
QList< KTextEditor::SmartRange * > m_discardedSmartRanges
KateOnTheFlyChecker * m_onTheFlyChecker

Detailed Description

Definition at line 72 of file katedocument.h.


Member Typedef Documentation

typedef QList<QPair<int, int> > KateDocument::OffsetList

Definition at line 1119 of file katedocument.h.


Member Enumeration Documentation

enum KateDocument::EncodedCharaterInsertionPolicy
Enumerator:
EncodeAlways 
EncodeWhenPresent 
EncodeNever 

Definition at line 1132 of file katedocument.h.

enum KateDocument::TextTransform
Enumerator:
Uppercase 
Lowercase 
Capitalize 

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

KateDocument::~KateDocument (  ) 

Definition at line 279 of file katedocument.cpp.


Member Function Documentation

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

Definition at line 4773 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 137 of file katedocument.h.

void KateDocument::activeViewSelectionChanged ( KTextEditor::View *  view  )  [signal]
void KateDocument::addActionsToDocument ( KTextEditor::SmartRange *  topRange  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4902 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4927 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4846 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4887 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1805 of file katedocument.cpp.

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

Definition at line 2594 of file katedocument.cpp.

void KateDocument::align ( KateView *  view,
const KTextEditor::Range &  range 
)

Definition at line 3026 of file katedocument.cpp.

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

Implements KTextEditor::AnnotationInterface.

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

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

Implements KTextEditor::SmartInterface.

Definition at line 4947 of file katedocument.cpp.

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

Definition at line 2825 of file katedocument.cpp.

void KateDocument::bomSetByUser (  ) 

Set that the BOM marker is forced via the tool menu.

Definition at line 1665 of file katedocument.cpp.

KateBrowserExtension* KateDocument::browserExtension (  )  [inline]

Definition at line 120 of file katedocument.h.

bool KateDocument::browserView (  )  const [inline]

Definition at line 118 of file katedocument.h.

void KateDocument::bufferHlChanged (  ) 

Definition at line 1648 of file katedocument.cpp.

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

Implements KTextEditor::Document.

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

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

Implements KTextEditor::Document.

Definition at line 557 of file katedocument.cpp.

void KateDocument::clearDictionaryRanges (  )  [slot]

Definition at line 5183 of file katedocument.cpp.

void KateDocument::clearDocumentActions (  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4983 of file katedocument.cpp.

void KateDocument::clearDocumentHighlights (  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4973 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1789 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1913 of file katedocument.cpp.

void KateDocument::clearMisspellingForWord ( const QString &  word  ) 

Definition at line 5340 of file katedocument.cpp.

void KateDocument::clearSmartInterface (  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4952 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4988 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4978 of file katedocument.cpp.

bool KateDocument::closeUrl (  )  [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 2450 of file katedocument.cpp.

void KateDocument::codeFoldingUpdated (  )  [signal]
void KateDocument::comment ( KateView *  view,
uint  line,
uint  column,
int  change 
)

Definition at line 3389 of file katedocument.cpp.

int KateDocument::computePositionWrtOffsets ( const OffsetList &  offsetList,
int  pos 
)

Definition at line 5427 of file katedocument.cpp.

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

Definition at line 980 of file katedocument.h.

KateDocumentConfig* KateDocument::config (  )  [inline]

Configuration.

Definition at line 979 of file katedocument.h.

void KateDocument::configChanged (  )  [signal]
QStringList KateDocument::configKeys (  )  const [virtual]

Implements KTextEditor::ConfigInterface.

Definition at line 4704 of file katedocument.cpp.

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

Implements KTextEditor::ConfigInterface.

Definition at line 4709 of file katedocument.cpp.

bool KateDocument::containsCharacterEncoding ( const KTextEditor::Range &  range  ) 

Definition at line 5401 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 338 of file katedocument.cpp.

int KateDocument::currentRevision (  )  const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4785 of file katedocument.cpp.

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

QString KateDocument::defaultDictionary (  )  const

Definition at line 5173 of file katedocument.cpp.

void KateDocument::defaultDictionaryChanged ( KateDocument *  document  )  [signal]
KTextEditor::Attribute::Ptr KateDocument::defaultStyle ( const KTextEditor::HighlightInterface::DefaultStyle  ds  )  const [virtual]

Implements KTextEditor::HighlightInterface.

Definition at line 5527 of file katedocument.cpp.

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

Definition at line 2909 of file katedocument.cpp.

void KateDocument::deleteCursors (  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4963 of file katedocument.cpp.

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

Definition at line 5378 of file katedocument.cpp.

void KateDocument::deleteRanges (  )  [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4968 of file katedocument.cpp.

QString KateDocument::dictionaryForMisspelledRange ( const KTextEditor::Range &  range  )  const

Definition at line 5330 of file katedocument.cpp.

void KateDocument::dictionaryRangeEliminated ( KTextEditor::SmartRange *  smartRange  )  [protected, slot]

Definition at line 5354 of file katedocument.cpp.

KTextEditor::SmartRangeNotifier * KateDocument::dictionaryRangeNotifier (  )  [protected]

Definition at line 5388 of file katedocument.cpp.

QList< QPair< KTextEditor::SmartRange *, QString > > KateDocument::dictionaryRanges (  )  const

Definition at line 5178 of file katedocument.cpp.

void KateDocument::dictionaryRangesPresent ( bool  yesNo  )  [signal]
const QList< KTextEditor::SmartRange * > KateDocument::documentActions (  )  const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4922 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 4778 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4882 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 809 of file katedocument.h.

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

Reloads the current document from disk if possible.

Implements KTextEditor::Document.

Definition at line 3939 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 4029 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 4037 of file katedocument.cpp.

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

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

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

Same as editStart() with undo.

Definition at line 196 of file katedocument.h.

void KateDocument::editEnd (  ) 

End a editor operation.

See also:
editStart()

Definition at line 931 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 1370 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 1120 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 1187 of file katedocument.cpp.

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

Implements KTextEditor::Document.

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

bool KateDocument::editRemoveLines ( int  from,
int  to,
Kate::EditSource  editSource = Kate::NoEditSource 
)

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

void KateDocument::editStart ( 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 897 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 1297 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 1213 of file katedocument.cpp.

QStringList KateDocument::embeddedModes (  )  const [virtual]

Implements KTextEditor::HighlightInterface.

Definition at line 5562 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 4104 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 207 of file katedocument.h.

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

Definition at line 679 of file katedocument.h.

QString KateDocument::fileType (  )  const [inline]

Definition at line 934 of file katedocument.h.

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

Definition at line 3716 of file katedocument.cpp.

KateCodeFoldingTree * KateDocument::foldingTree (  ) 

Definition at line 4093 of file katedocument.cpp.

uint KateDocument::getRealLine ( unsigned int  virtualLine  ) 

Definition at line 5003 of file katedocument.cpp.

uint KateDocument::getVirtualLine ( unsigned int  realLine  ) 

Definition at line 5008 of file katedocument.cpp.

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

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

bool KateDocument::handleMarkContextMenu ( int  line,
QPoint  position 
) [slot]

Returns true if the context-menu event should not further be processed.

Definition at line 1901 of file katedocument.cpp.

KateHighlighting * KateDocument::highlight (  )  const

Definition at line 4998 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 1623 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 1628 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 1638 of file katedocument.cpp.

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

Definition at line 327 of file katedocument.h.

void KateDocument::ignoreModifiedOnDiskOnce (  ) 

Definition at line 4993 of file katedocument.cpp.

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

Definition at line 3004 of file katedocument.cpp.

void KateDocument::inputMethodEnd (  ) 

Definition at line 993 of file katedocument.cpp.

void KateDocument::inputMethodStart (  ) 

Definition at line 988 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 816 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 827 of file katedocument.cpp.

bool KateDocument::insertTemplateTextImplementation ( const KTextEditor::Cursor &  c,
const QString &  templateString,
const QMap< QString, QString > &  initialValues,
QWidget *   
) [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.

See also:
KTextEditor::TemplateInterface::insertTemplateTextImplementation(), KateTemplateHandler

Definition at line 4764 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 663 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 573 of file katedocument.cpp.

bool KateDocument::isEditRunning (  )  const

Definition at line 5049 of file katedocument.cpp.

bool KateDocument::isModifiedOnDisc (  )  [inline]
Returns:
wheather the document is modified on disk since last saved.

Definition at line 821 of file katedocument.h.

bool KateDocument::isOnTheFlySpellCheckingEnabled (  )  const

Definition at line 5315 of file katedocument.cpp.

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

Unwrap a range of lines.

Definition at line 3608 of file katedocument.cpp.

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

Definition at line 5018 of file katedocument.cpp.

int KateDocument::lastLine (  )  const [inline]

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

Definition at line 666 of file katedocument.h.

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

Implements KTextEditor::Document.

Definition at line 495 of file katedocument.cpp.

QList< KTextEditor::HighlightInterface::AttributeBlock > KateDocument::lineAttributes ( const unsigned int  line  )  [virtual]

TODO: should this maybe be put into the View until the glory day the renderer does not require a View?

Implements KTextEditor::HighlightInterface.

Definition at line 5532 of file katedocument.cpp.

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

Definition at line 4088 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 879 of file katedocument.cpp.

int KateDocument::lines (  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 869 of file katedocument.cpp.

void KateDocument::makeAttribs ( bool  needInvalidate = true  ) 

Definition at line 2573 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1775 of file katedocument.cpp.

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

Definition at line 1948 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

Definition at line 1958 of file katedocument.cpp.

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

Definition at line 1942 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1875 of file katedocument.cpp.

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.

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 1988 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 2002 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 1601 of file katedocument.cpp.

QString KateDocument::modeAt ( const KTextEditor::Cursor &  position  )  [virtual]

Implements KTextEditor::HighlightInterface.

Definition at line 5567 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 1606 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 1643 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 3701 of file katedocument.cpp.

void KateDocument::newLine ( KateView *  view  ) 

Definition at line 2760 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 4810 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 4820 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 4815 of file katedocument.cpp.

int KateDocument::numVisLines (  )  const

Definition at line 874 of file katedocument.cpp.

QPair< KTextEditor::Range, QString > KateDocument::onTheFlyMisspelledItem ( const KTextEditor::Cursor &  cursor  )  const

Definition at line 5320 of file katedocument.cpp.

void KateDocument::onTheFlySpellCheckingEnabled ( bool  enable  )  [slot]

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

bool KateDocument::ownedView ( KateView *  view  ) 

Definition at line 2642 of file katedocument.cpp.

bool KateDocument::pageUpDownMovesCursor (  )  const

Definition at line 4077 of file katedocument.cpp.

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

Definition at line 2926 of file katedocument.cpp.

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

Definition at line 5024 of file katedocument.cpp.

void KateDocument::popEditState (  ) 

Definition at line 979 of file katedocument.cpp.

void KateDocument::preHighlightChanged ( uint   )  [signal]
bool KateDocument::print (  )  [slot]

Definition at line 1981 of file katedocument.cpp.

bool KateDocument::printDialog (  )  [slot]

Definition at line 1976 of file katedocument.cpp.

KEncodingProber::ProberType KateDocument::proberTypeForEncodingAutoDetection (  )  const

Definition at line 4114 of file katedocument.cpp.

void KateDocument::pushEditState (  ) 

Definition at line 974 of file katedocument.cpp.

bool KateDocument::queryClose (  )  [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 5096 of file katedocument.cpp.

bool KateDocument::readOnly (  )  const [inline]

Definition at line 117 of file katedocument.h.

void KateDocument::readParameterizedSessionConfig ( const KConfigGroup &  kconfig,
unsigned long  configParameters 
) [virtual]

Implements KTextEditor::ParameterizedSessionConfigInterface.

Definition at line 1677 of file katedocument.cpp.

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

Implements KTextEditor::SessionConfigInterface.

Definition at line 1672 of file katedocument.cpp.

void KateDocument::redo (  )  [slot]

Definition at line 1521 of file katedocument.cpp.

uint KateDocument::redoCount (  )  const

Definition at line 1511 of file katedocument.cpp.

void KateDocument::refreshOnTheFlyCheck ( const KTextEditor::Range &  range = KTextEditor::Range::invalid()  )  [slot]

Definition at line 5347 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4790 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4913 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4932 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4865 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4892 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 843 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1842 of file katedocument.cpp.

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

Implements KTextEditor::Document.

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

void KateDocument::repaintViews ( bool  paintOnlyDirty = true  ) 

Definition at line 3684 of file katedocument.cpp.

void KateDocument::replaceCharactersByEncoding ( const KTextEditor::Range &  range  ) 

Definition at line 5495 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 169 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 4836 of file katedocument.cpp.

void KateDocument::requestMarkTooltip ( int  line,
QPoint  position 
) [slot]

Definition at line 1880 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 1104 of file katedocument.h.

void KateDocument::revertToDefaultDictionary ( const KTextEditor::Range &  range  )  [slot]

Definition at line 5275 of file katedocument.cpp.

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

Reimplemented from KParts::ReadWritePart.

Definition at line 5163 of file katedocument.cpp.

bool KateDocument::saveAs ( const KUrl &  url  )  [virtual]

Reimplemented from KParts::ReadWritePart.

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

QVector< KTextEditor::Range > KateDocument::searchText ( const KTextEditor::Range &  range,
const QString &  pattern,
const KTextEditor::Search::SearchOptions  options 
)

Definition at line 1528 of file katedocument.cpp.

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

Definition at line 2627 of file katedocument.cpp.

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

Implements KTextEditor::AnnotationInterface.

Definition at line 5082 of file katedocument.cpp.

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

Implements KTextEditor::ConfigInterface.

Definition at line 4727 of file katedocument.cpp.

void KateDocument::setDefaultDictionary ( const QString &  dict  )  [slot]

Definition at line 5280 of file katedocument.cpp.

void KateDocument::setDictionary ( const QString &  dict,
const KTextEditor::Range &  range 
) [slot]

Definition at line 5199 of file katedocument.cpp.

void KateDocument::setDocName ( QString  docName  ) 

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

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

Implements KTextEditor::MarkInterface.

Definition at line 1964 of file katedocument.cpp.

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

Implements KTextEditor::Document.

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

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

Implements KTextEditor::MarkInterface.

Definition at line 1783 of file katedocument.cpp.

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

Definition at line 1937 of file katedocument.cpp.

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

Definition at line 1932 of file katedocument.cpp.

void KateDocument::setMergeAllEdits ( bool  merge  ) 

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

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

Reimplemented from KParts::ReadWritePart.

Definition at line 2554 of file katedocument.cpp.

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

Implements KTextEditor::ModificationInterface.

Definition at line 3920 of file katedocument.cpp.

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

Implements KTextEditor::ModificationInterface.

Definition at line 3934 of file katedocument.cpp.

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

Definition at line 4072 of file katedocument.cpp.

void KateDocument::setProberTypeForEncodingAutoDetection ( KEncodingProber::ProberType  proberType  ) 

Definition at line 4109 of file katedocument.cpp.

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

Reimplemented from KParts::ReadWritePart.

Definition at line 2540 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 531 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 505 of file katedocument.cpp.

void KateDocument::setUndoAllowComplexMerge ( bool  allow  ) 

Definition at line 5034 of file katedocument.cpp.

void KateDocument::setUndoDontMerge ( bool  dontMerge  ) 

Definition at line 5044 of file katedocument.cpp.

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

Definition at line 4052 of file katedocument.cpp.

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

Definition at line 4062 of file katedocument.cpp.

bool KateDocument::simpleMode (  )  [static]

Definition at line 5070 of file katedocument.cpp.

bool KateDocument::singleViewMode (  )  const [inline]

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

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

Definition at line 4659 of file katedocument.cpp.

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

Definition at line 593 of file katedocument.h.

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

Implements KTextEditor::Document.

Definition at line 206 of file katedocument.h.

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

Implements KTextEditor::SearchInterface.

Definition at line 1565 of file katedocument.cpp.

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

Definition at line 3671 of file katedocument.cpp.

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

Definition at line 3665 of file katedocument.cpp.

QString KateDocument::text (  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 361 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 381 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 447 of file katedocument.cpp.

void KateDocument::textRemoved (  )  [signal]
int KateDocument::totalCharacters (  )  const [virtual]

Implements KTextEditor::Document.

Definition at line 854 of file katedocument.cpp.

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

Definition at line 2647 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 3503 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 4805 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 4800 of file katedocument.cpp.

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

Definition at line 2794 of file katedocument.cpp.

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

Type chars in a view.

Definition at line 2657 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4831 of file katedocument.cpp.

void KateDocument::undo (  )  [slot]

Definition at line 1516 of file katedocument.cpp.

bool KateDocument::undoAllowComplexMerge (  )  const

Definition at line 5039 of file katedocument.cpp.

void KateDocument::undoChanged (  )  [signal]
uint KateDocument::undoCount (  )  const

Definition at line 1506 of file katedocument.cpp.

bool KateDocument::undoDontMerge (  )  const

Definition at line 5029 of file katedocument.cpp.

void KateDocument::undoSafePoint (  ) 

Definition at line 924 of file katedocument.cpp.

void KateDocument::updateConfig (  ) 

Definition at line 4119 of file katedocument.cpp.

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

set the indentation mode, if any in the mode...

Definition at line 4608 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4795 of file katedocument.cpp.

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

Implements KTextEditor::VariableInterface.

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

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

Implements KTextEditor::SmartInterface.

Definition at line 4897 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 349 of file katedocument.cpp.

uint KateDocument::visibleLines (  ) 

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

bool KateDocument::wordWrap (  )  const

Definition at line 4057 of file katedocument.cpp.

unsigned int KateDocument::wordWrapAt (  )  const

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

void KateDocument::writeParameterizedSessionConfig ( KConfigGroup &  kconfig,
unsigned long  configParameters 
) [virtual]

Implements KTextEditor::ParameterizedSessionConfigInterface.

Definition at line 1728 of file katedocument.cpp.

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

Implements KTextEditor::SessionConfigInterface.

Definition at line 1723 of file katedocument.cpp.


Member Data Documentation

QString KateDocument::m_defaultDictionary [protected]

Definition at line 1136 of file katedocument.h.

KTextEditor::SmartRangeNotifier* KateDocument::m_dictionaryRangeNotifier [protected]

Definition at line 1139 of file katedocument.h.

QList<QPair<KTextEditor::SmartRange*, QString> > KateDocument::m_dictionaryRanges [protected]

Definition at line 1137 of file katedocument.h.

QList<KTextEditor::SmartRange*> KateDocument::m_discardedSmartRanges [protected]

Definition at line 1138 of file katedocument.h.

KateOnTheFlyChecker* KateDocument::m_onTheFlyChecker [protected]

Definition at line 1135 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
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  •     Sodep
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.9-20090814
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