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

kdeui

KDictSpellingHighlighter Class Reference

Dictionary sensitive text highlighter. More...

#include <ksyntaxhighlighter.h>

Inheritance diagram for KDictSpellingHighlighter:

Inheritance graph
[legend]

List of all members.


Signals

void activeChanged (const QString &)
void newSuggestions (const QString &originalword, const QStringList &suggestions, unsigned int pos)

Public Member Functions

bool automatic () const
bool isActive () const
virtual bool isMisspelled (const QString &word)
 KDictSpellingHighlighter (QTextEdit *textEdit, bool spellCheckingActive=true, bool autoEnable=true, const QColor &spellColor=red, bool colorQuoting=false, const QColor &QuoteColor0=black, const QColor &QuoteColor1=QColor(0x00, 0x80, 0x00), const QColor &QuoteColor2=QColor(0x00, 0x70, 0x00), const QColor &QuoteColor3=QColor(0x00, 0x60, 0x00), KSpellConfig *spellConfig=0)
void restartBackgroundSpellCheck ()
void setActive (bool active)
void setAutomatic (bool automatic)
 ~KDictSpellingHighlighter ()

Static Public Member Functions

static void dictionaryChanged ()

Protected Slots

void slotAutoDetection ()
void slotCorrected (const QString &originalWord, const QString &, unsigned int)
void slotDictionaryChanged ()
void slotKSpellNotResponding ()
void slotLocalSpellConfigChanged ()
void slotMisspelling (const QString &originalWord, const QStringList &suggestions, unsigned int pos)
void slotRehighlight ()
void slotSpellReady (KSpell *spell)

Protected Member Functions

bool eventFilter (QObject *o, QEvent *e)
QString spellKey ()

Detailed Description

Dictionary sensitive text highlighter.

Definition at line 94 of file ksyntaxhighlighter.h.


Constructor & Destructor Documentation

KDictSpellingHighlighter::KDictSpellingHighlighter ( QTextEdit *  textEdit,
bool  spellCheckingActive = true,
bool  autoEnable = true,
const QColor &  spellColor = red,
bool  colorQuoting = false,
const QColor &  QuoteColor0 = black,
const QColor &  QuoteColor1 = QColor( 0x00, 0x80, 0x00 ),
const QColor &  QuoteColor2 = QColor( 0x00, 0x70, 0x00 ),
const QColor &  QuoteColor3 = QColor( 0x00, 0x60, 0x00 ),
KSpellConfig *  spellConfig = 0 
)

Definition at line 270 of file ksyntaxhighlighter.cpp.

KDictSpellingHighlighter::~KDictSpellingHighlighter (  ) 

Definition at line 326 of file ksyntaxhighlighter.cpp.


Member Function Documentation

void KDictSpellingHighlighter::activeChanged ( const QString &   )  [signal]

bool KDictSpellingHighlighter::automatic (  )  const

Returns the state of automatic (de)activation.

Returns:
true if automatic (de)activation is enabled
See also:
setAutomatic()

Definition at line 497 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::dictionaryChanged (  )  [static]

Definition at line 455 of file ksyntaxhighlighter.cpp.

bool KDictSpellingHighlighter::eventFilter ( QObject *  o,
QEvent *  e 
) [protected]

Reimplemented from QObject.

Definition at line 610 of file ksyntaxhighlighter.cpp.

bool KDictSpellingHighlighter::isActive (  )  const

Returns the state of spell checking.

Returns:
true if spell checking is active
See also:
setActive()

Definition at line 482 of file ksyntaxhighlighter.cpp.

bool KDictSpellingHighlighter::isMisspelled ( const QString &  word  )  [virtual]

Implements KSpellingHighlighter.

Definition at line 366 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::newSuggestions ( const QString &  originalword,
const QStringList &  suggestions,
unsigned int  pos 
) [signal]

void KDictSpellingHighlighter::restartBackgroundSpellCheck (  ) 

Definition at line 463 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::setActive ( bool  active  ) 

Enable/Disable spell checking.

If active is true then spell checking is enabled; otherwise it is disabled. Note that you have to disable automatic (de)activation with setAutomatic() before you change the state of spell checking if you want to persistently enable/disable spell checking.

Parameters:
active if true, then spell checking is enabled
See also:
isActive(), setAutomatic()

Definition at line 469 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::setAutomatic ( bool  automatic  ) 

En-/Disable automatic (de)activation in case of too many errors.

If automatic is true then spell checking will be deactivated if too many words were mispelled and spell checking will be activated again if the amount of mispelled words drop below a certain threshold.

Parameters:
automatic if true, then automatic (de)activation is enabled
See also:
automatic()

Definition at line 487 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::slotAutoDetection (  )  [protected, slot]

Definition at line 568 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::slotCorrected ( const QString &  originalWord,
const QString &  ,
unsigned  int 
) [protected, slot]

Definition at line 437 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::slotDictionaryChanged (  )  [protected, slot]

Definition at line 520 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::slotKSpellNotResponding (  )  [protected, slot]

Definition at line 595 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::slotLocalSpellConfigChanged (  )  [protected, slot]

Definition at line 532 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::slotMisspelling ( const QString &  originalWord,
const QStringList &  suggestions,
unsigned int  pos 
) [protected, slot]

Definition at line 422 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::slotRehighlight (  )  [protected, slot]

Definition at line 502 of file ksyntaxhighlighter.cpp.

void KDictSpellingHighlighter::slotSpellReady ( KSpell *  spell  )  [protected, slot]

Definition at line 335 of file ksyntaxhighlighter.cpp.

QString KDictSpellingHighlighter::spellKey (  )  [protected]

Definition at line 540 of file ksyntaxhighlighter.cpp.


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

kdeui

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

API Reference

Skip menu "API Reference"
  • dcop
  • DNSSD
  • interfaces
  • Kate
  • kconf_update
  • KDECore
  • KDED
  • kdefx
  • KDEsu
  • kdeui
  • KDocTools
  • KHTML
  • KImgIO
  • KInit
  • kio
  • kioslave
  • KJS
  • KNewStuff
  • KParts
  • KUtils
Generated for API Reference by doxygen 1.5.9
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