• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • kdelibs
  • KDE Home
  • Contact Us
 

Kate

Public Slots | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Static Protected Attributes

KateOnTheFlyChecker Class Reference

#include <ontheflycheck.h>

Inheritance diagram for KateOnTheFlyChecker:
Inheritance graph
[legend]

List of all members.

Public Slots

void refreshSpellCheck (const KTextEditor::Range &range=KTextEditor::Range::invalid())
void textInserted (KTextEditor::Document *document, const KTextEditor::Range &range)
void textRemoved (KTextEditor::Document *document, const KTextEditor::Range &range)
void updateConfig ()
void updateInstalledMovingRanges (KateView *view)

Public Member Functions

 KateOnTheFlyChecker (KateDocument *document)
 ~KateOnTheFlyChecker ()
void clearMisspellingForWord (const QString &word)
QString dictionaryForMisspelledRange (const KTextEditor::Range &range) const
QPair< KTextEditor::Range,
QString > 
getMisspelledItem (const KTextEditor::Cursor &cursor) const

Static Public Member Functions

static int debugArea ()

Protected Slots

void addView (KTextEditor::Document *document, KTextEditor::View *view)
void clearModificationList ()
void handleInsertedText (const KTextEditor::Range &range)
void handleModifiedRanges ()
void handleRemovedText (const KTextEditor::Range &range)
void handleRespellCheckBlock (KateDocument *document, int start, int end)
void misspelling (const QString &word, int start)
void performSpellCheck ()
bool removeRangeFromModificationList (KTextEditor::MovingRange *range)
void removeView (KTextEditor::View *view)
void restartViewRefreshTimer (KateView *view)
void spellCheckDone ()
void viewDestroyed (QObject *obj)
void viewRefreshTimeout ()

Protected Member Functions

void addToSpellCheckQueue (const KTextEditor::Range &range, const QString &dictionary)
void addToSpellCheckQueue (KTextEditor::MovingRange *range, const QString &dictionary)
virtual void caretEnteredRange (KTextEditor::MovingRange *range, KTextEditor::View *view)
virtual void caretExitedRange (KTextEditor::MovingRange *range, KTextEditor::View *view)
void deleteMovingRange (KTextEditor::MovingRange *range)
void deleteMovingRangeQuickly (KTextEditor::MovingRange *range)
void deleteMovingRanges (const QList< KTextEditor::MovingRange * > &list)
KTextEditor::Range findWordBoundaries (const KTextEditor::Cursor &begin, const KTextEditor::Cursor &end)
void freeDocument ()
MovingRangeList installedMovingRanges (const KTextEditor::Range &range)
virtual void mouseEnteredRange (KTextEditor::MovingRange *range, KTextEditor::View *view)
virtual void mouseExitedRange (KTextEditor::MovingRange *range, KTextEditor::View *view)
void queueLineSpellCheck (KateDocument *document, int line)
void queueLineSpellCheck (const KTextEditor::Range &range, const QString &dictionary)
void queueSpellCheckVisibleRange (const KTextEditor::Range &range)
void queueSpellCheckVisibleRange (KateView *view, const KTextEditor::Range &range)
virtual void rangeEmpty (KTextEditor::MovingRange *range)
virtual void rangeInvalid (KTextEditor::MovingRange *range)
bool removeRangeFromCurrentSpellCheck (KTextEditor::MovingRange *range)
virtual void removeRangeFromEverything (KTextEditor::MovingRange *range)
bool removeRangeFromSpellCheckQueue (KTextEditor::MovingRange *range)
void stopCurrentSpellCheck ()

Protected Attributes

Sonnet::BackgroundChecker * m_backgroundChecker
KateDocument::OffsetList m_currentDecToEncOffsetList
SpellCheckItem m_currentlyCheckedItem
QMap< KTextEditor::View
*, KTextEditor::Range > 
m_displayRangeMap
KateDocument *const m_document
MisspelledList m_misspelledList
ModificationList m_modificationList
QPointer< KateView > m_refreshView
QList< SpellCheckItem > m_spellCheckQueue
Sonnet::Speller m_speller
QTimer * m_viewRefreshTimer

Static Protected Attributes

static const SpellCheckItem invalidSpellCheckQueueItem

Detailed Description

Definition at line 40 of file ontheflycheck.h.


Constructor & Destructor Documentation

KateOnTheFlyChecker::KateOnTheFlyChecker ( KateDocument *  document)

Definition at line 39 of file ontheflycheck.cpp.

KateOnTheFlyChecker::~KateOnTheFlyChecker ( )

Definition at line 72 of file ontheflycheck.cpp.


Member Function Documentation

void KateOnTheFlyChecker::addToSpellCheckQueue ( const KTextEditor::Range &  range,
const QString &  dictionary 
) [protected]

Definition at line 840 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::addToSpellCheckQueue ( KTextEditor::MovingRange *  range,
const QString &  dictionary 
) [protected]

Definition at line 845 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::addView ( KTextEditor::Document *  document,
KTextEditor::View *  view 
) [protected, slot]

Definition at line 696 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::caretEnteredRange ( KTextEditor::MovingRange *  range,
KTextEditor::View *  view 
) [protected, virtual]

It is not enough to use 'caret/Entered/ExitedRange' only as the cursor doesn't move when some text has been selected.

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 517 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::caretExitedRange ( KTextEditor::MovingRange *  range,
KTextEditor::View *  view 
) [protected, virtual]

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 523 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::clearMisspellingForWord ( const QString &  word)

Definition at line 105 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::clearModificationList ( ) [protected, slot]

Definition at line 929 of file ontheflycheck.cpp.

int KateOnTheFlyChecker::debugArea ( ) [static]

Definition at line 77 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::deleteMovingRange ( KTextEditor::MovingRange *  range) [protected]

Definition at line 529 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::deleteMovingRangeQuickly ( KTextEditor::MovingRange *  range) [protected]

Definition at line 887 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::deleteMovingRanges ( const QList< KTextEditor::MovingRange * > &  list) [protected]

Definition at line 541 of file ontheflycheck.cpp.

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

Definition at line 94 of file ontheflycheck.cpp.

KTextEditor::Range KateOnTheFlyChecker::findWordBoundaries ( const KTextEditor::Cursor &  begin,
const KTextEditor::Cursor &  end 
) [protected]

Definition at line 548 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::freeDocument ( ) [protected]

Definition at line 347 of file ontheflycheck.cpp.

QPair< KTextEditor::Range, QString > KateOnTheFlyChecker::getMisspelledItem ( const KTextEditor::Cursor &  cursor) const

Definition at line 83 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::handleInsertedText ( const KTextEditor::Range &  range) [protected, slot]

Definition at line 170 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::handleModifiedRanges ( ) [protected, slot]

Definition at line 896 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::handleRemovedText ( const KTextEditor::Range &  range) [protected, slot]

Definition at line 270 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::handleRespellCheckBlock ( KateDocument *  document,
int  start,
int  end 
) [protected, slot]

Definition at line 119 of file ontheflycheck.cpp.

QList< KTextEditor::MovingRange * > KateOnTheFlyChecker::installedMovingRanges ( const KTextEditor::Range &  range) [protected]

Definition at line 657 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::misspelling ( const QString &  word,
int  start 
) [protected, slot]

Definition at line 602 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::mouseEnteredRange ( KTextEditor::MovingRange *  range,
KTextEditor::View *  view 
) [protected, virtual]

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 501 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::mouseExitedRange ( KTextEditor::MovingRange *  range,
KTextEditor::View *  view 
) [protected, virtual]

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 507 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::performSpellCheck ( ) [protected, slot]

Definition at line 373 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::queueLineSpellCheck ( KateDocument *  document,
int  line 
) [protected]

Definition at line 805 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::queueLineSpellCheck ( const KTextEditor::Range &  range,
const QString &  dictionary 
) [protected]

'range' must be on a single line

Definition at line 827 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::queueSpellCheckVisibleRange ( const KTextEditor::Range &  range) [protected]

Definition at line 770 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::queueSpellCheckVisibleRange ( KateView *  view,
const KTextEditor::Range &  range 
) [protected]

Definition at line 778 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::rangeEmpty ( KTextEditor::MovingRange *  range) [protected, virtual]

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 489 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::rangeInvalid ( KTextEditor::MovingRange *  range) [protected, virtual]

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 495 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::refreshSpellCheck ( const KTextEditor::Range &  range = KTextEditor::Range::invalid()) [slot]

Definition at line 685 of file ontheflycheck.cpp.

bool KateOnTheFlyChecker::removeRangeFromCurrentSpellCheck ( KTextEditor::MovingRange *  range) [protected]

Definition at line 448 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::removeRangeFromEverything ( KTextEditor::MovingRange *  range) [protected, virtual]

Definition at line 423 of file ontheflycheck.cpp.

bool KateOnTheFlyChecker::removeRangeFromModificationList ( KTextEditor::MovingRange *  range) [protected, slot]

Definition at line 912 of file ontheflycheck.cpp.

bool KateOnTheFlyChecker::removeRangeFromSpellCheckQueue ( KTextEditor::MovingRange *  range) [protected]

Definition at line 467 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::removeView ( KTextEditor::View *  view) [protected, slot]

Definition at line 713 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::restartViewRefreshTimer ( KateView *  view) [protected, slot]

Definition at line 878 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::spellCheckDone ( ) [protected, slot]

Definition at line 642 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::stopCurrentSpellCheck ( ) [protected]

Definition at line 458 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::textInserted ( KTextEditor::Document *  document,
const KTextEditor::Range &  range 
) [slot]

Definition at line 137 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::textRemoved ( KTextEditor::Document *  document,
const KTextEditor::Range &  range 
) [slot]

Definition at line 232 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::updateConfig ( ) [slot]

Definition at line 672 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::updateInstalledMovingRanges ( KateView *  view) [slot]

Definition at line 719 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::viewDestroyed ( QObject *  obj) [protected, slot]

Definition at line 706 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::viewRefreshTimeout ( ) [protected, slot]

Definition at line 870 of file ontheflycheck.cpp.


Member Data Documentation

const KateOnTheFlyChecker::SpellCheckItem KateOnTheFlyChecker::invalidSpellCheckQueueItem [static, protected]
Initial value:
                           SpellCheckItem(NULL, "")

Definition at line 79 of file ontheflycheck.h.

Sonnet::BackgroundChecker* KateOnTheFlyChecker::m_backgroundChecker [protected]

Definition at line 77 of file ontheflycheck.h.

KateDocument::OffsetList KateOnTheFlyChecker::m_currentDecToEncOffsetList [protected]

Definition at line 82 of file ontheflycheck.h.

SpellCheckItem KateOnTheFlyChecker::m_currentlyCheckedItem [protected]

Definition at line 78 of file ontheflycheck.h.

QMap<KTextEditor::View*, KTextEditor::Range> KateOnTheFlyChecker::m_displayRangeMap [protected]

Definition at line 83 of file ontheflycheck.h.

KateDocument* const KateOnTheFlyChecker::m_document [protected]

Definition at line 74 of file ontheflycheck.h.

MisspelledList KateOnTheFlyChecker::m_misspelledList [protected]

Definition at line 80 of file ontheflycheck.h.

ModificationList KateOnTheFlyChecker::m_modificationList [protected]

Definition at line 81 of file ontheflycheck.h.

QPointer<KateView> KateOnTheFlyChecker::m_refreshView [protected]

Definition at line 101 of file ontheflycheck.h.

QList<SpellCheckItem> KateOnTheFlyChecker::m_spellCheckQueue [protected]

Definition at line 76 of file ontheflycheck.h.

Sonnet::Speller KateOnTheFlyChecker::m_speller [protected]

Definition at line 75 of file ontheflycheck.h.

QTimer* KateOnTheFlyChecker::m_viewRefreshTimer [protected]

Definition at line 100 of file ontheflycheck.h.


The documentation for this class was generated from the following files:
  • ontheflycheck.h
  • ontheflycheck.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
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.7.3
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