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
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Static Public Member Functions
static int	debugArea ()
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

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 (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 Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

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

Additional Inherited Members
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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

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

protected

Definition at line 837 of file ontheflycheck.cpp.

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

protectedslot

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

Definition at line 512 of file ontheflycheck.cpp.

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

protectedvirtual

Definition at line 518 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 921 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 524 of file ontheflycheck.cpp.

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

protected

Definition at line 879 of file ontheflycheck.cpp.

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

protected

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

void KateOnTheFlyChecker::freeDocument ( )

protected

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

void KateOnTheFlyChecker::handleModifiedRanges ( )

protectedslot

Definition at line 888 of file ontheflycheck.cpp.

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

protectedslot

Definition at line 268 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::handleRespellCheckBlock ( 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 652 of file ontheflycheck.cpp.

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

protectedslot

Definition at line 597 of file ontheflycheck.cpp.

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

protectedvirtual

Definition at line 496 of file ontheflycheck.cpp.

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

protectedvirtual

Definition at line 502 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::performSpellCheck ( )

protectedslot

Definition at line 371 of file ontheflycheck.cpp.

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

protected

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

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

protected

Definition at line 762 of file ontheflycheck.cpp.

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

protected

Definition at line 770 of file ontheflycheck.cpp.

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

protectedvirtual

Definition at line 484 of file ontheflycheck.cpp.

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

protectedvirtual

Definition at line 490 of file ontheflycheck.cpp.

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

slot

Definition at line 677 of file ontheflycheck.cpp.

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

protected

Definition at line 443 of file ontheflycheck.cpp.

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

protectedvirtual

Definition at line 418 of file ontheflycheck.cpp.

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

protectedslot

Definition at line 904 of file ontheflycheck.cpp.

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

protected

Definition at line 462 of file ontheflycheck.cpp.

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

protectedslot

Definition at line 705 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::restartViewRefreshTimer ( KateView *  view )

protectedslot

Definition at line 870 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::spellCheckDone ( )

protectedslot

Definition at line 637 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::stopCurrentSpellCheck ( )

protected

Definition at line 453 of file ontheflycheck.cpp.

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

slot

Definition at line 135 of file ontheflycheck.cpp.

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

slot

Definition at line 230 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::updateConfig ( )

slot

Definition at line 667 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::updateInstalledMovingRanges ( KateView *  view )

slot

Definition at line 711 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::viewDestroyed ( QObject *  obj )

protectedslot

Definition at line 698 of file ontheflycheck.cpp.

void KateOnTheFlyChecker::viewRefreshTimeout ( )

protectedslot

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