KateOnTheFlyChecker Class Reference

#include <ontheflycheck.h>

Inheritance diagram for KateOnTheFlyChecker:

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 40 of file ontheflycheck.cpp.

KateOnTheFlyChecker::~KateOnTheFlyChecker

(

)

Definition at line 73 of file ontheflycheck.cpp.

Member Function Documentation

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

protected

Definition at line 835 of file ontheflycheck.cpp.

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

protected

Definition at line 840 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::addView ( KTextEditor::Document *  document, KTextEditor::View *  view  )

protectedslot

Definition at line 691 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::caretEnteredRange ( KTextEditor::MovingRange *  range, KTextEditor::View *  view  )

protectedvirtual

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 515 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::caretExitedRange ( KTextEditor::MovingRange *  range, KTextEditor::View *  view  )

protectedvirtual

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 521 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::clearMisspellingForWord

(

const QString &

word

)

Definition at line 106 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::clearModificationList ( )

protectedslot

Definition at line 924 of file ontheflycheck.cpp.

int KateOnTheFlyChecker::debugArea ( )

static

Definition at line 78 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::deleteMovingRange ( KTextEditor::MovingRange *  range )

protected

Definition at line 527 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::deleteMovingRangeQuickly ( KTextEditor::MovingRange *  range )

protected

Definition at line 882 of file ontheflycheck.cpp.

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

protected

Definition at line 539 of file ontheflycheck.cpp.

QString KateOnTheFlyChecker::dictionaryForMisspelledRange

(

const KTextEditor::Range &

range

)

const

Definition at line 95 of file ontheflycheck.cpp.

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

protected

Definition at line 546 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::freeDocument ( )

protected

Definition at line 348 of file ontheflycheck.cpp.

QPair< KTextEditor::Range, QString > KateOnTheFlyChecker::getMisspelledItem

(

const KTextEditor::Cursor &

cursor

)

const

Definition at line 84 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::handleInsertedText ( const KTextEditor::Range &  range )

protectedslot

Definition at line 171 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::handleModifiedRanges ( )

protectedslot

Definition at line 891 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::handleRemovedText ( const KTextEditor::Range &  range )

protectedslot

Definition at line 271 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::handleRespellCheckBlock ( KateDocument *  document, int  start, int  end  )

protectedslot

Definition at line 120 of file ontheflycheck.cpp.

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

protected

Definition at line 655 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::misspelling ( const QString &  word, int  start  )

protectedslot

Definition at line 600 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::mouseEnteredRange ( KTextEditor::MovingRange *  range, KTextEditor::View *  view  )

protectedvirtual

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 499 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::mouseExitedRange ( KTextEditor::MovingRange *  range, KTextEditor::View *  view  )

protectedvirtual

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 505 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::performSpellCheck ( )

protectedslot

Definition at line 374 of file ontheflycheck.cpp.

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

protected

Definition at line 800 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 822 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::queueSpellCheckVisibleRange ( const KTextEditor::Range &  range )

protected

Definition at line 765 of file ontheflycheck.cpp.

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

protected

Definition at line 773 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::rangeEmpty ( KTextEditor::MovingRange *  range )

protectedvirtual

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 487 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::rangeInvalid ( KTextEditor::MovingRange *  range )

protectedvirtual

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 493 of file ontheflycheck.cpp.

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

slot

Definition at line 680 of file ontheflycheck.cpp.

bool KateOnTheFlyChecker::removeRangeFromCurrentSpellCheck ( KTextEditor::MovingRange *  range )

protected

Definition at line 446 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::removeRangeFromEverything ( KTextEditor::MovingRange *  range )

protectedvirtual

Definition at line 421 of file ontheflycheck.cpp.

bool KateOnTheFlyChecker::removeRangeFromModificationList ( KTextEditor::MovingRange *  range )

protectedslot

Definition at line 907 of file ontheflycheck.cpp.

bool KateOnTheFlyChecker::removeRangeFromSpellCheckQueue ( KTextEditor::MovingRange *  range )

protected

Definition at line 465 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::removeView ( KTextEditor::View *  view )

protectedslot

Definition at line 708 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::restartViewRefreshTimer ( KateView *  view )

protectedslot

Definition at line 873 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::spellCheckDone ( )

protectedslot

Definition at line 640 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::stopCurrentSpellCheck ( )

protected

Definition at line 456 of file ontheflycheck.cpp.

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

slot

Definition at line 138 of file ontheflycheck.cpp.

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

slot

Definition at line 233 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::updateConfig ( )

slot

Definition at line 670 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::updateInstalledMovingRanges ( KateView *  view )

slot

Definition at line 714 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::viewDestroyed ( QObject *  obj )

protectedslot

Definition at line 701 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::viewRefreshTimeout ( )

protectedslot

Definition at line 865 of file ontheflycheck.cpp.

Member Data Documentation

const KateOnTheFlyChecker::SpellCheckItem KateOnTheFlyChecker::invalidSpellCheckQueueItem

staticprotected

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