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

KDECore

  • Sonnet
  • BackgroundChecker
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
Sonnet::BackgroundChecker Class Reference

#include <backgroundchecker.h>

Inheritance diagram for Sonnet::BackgroundChecker:
Inheritance graph
[legend]

Public Slots

void changeLanguage (const QString &lang)
 
virtual void continueChecking ()
 
void replace (int start, const QString &oldText, const QString &newText)
 
virtual void start ()
 
virtual void stop ()
 

Signals

void done ()
 
void misspelling (const QString &word, int start)
 

Public Member Functions

 BackgroundChecker (QObject *parent=0)
 
 BackgroundChecker (const Speller &speller, QObject *parent=0)
 
 ~BackgroundChecker ()
 
bool addWordToPersonal (const QString &word)
 
bool checkWord (const QString &word)
 
QString currentContext () const
 
void restore (KConfig *config)
 
void setSpeller (const Speller &speller)
 
void setText (const QString &text)
 
Speller speller () const
 
QStringList suggest (const QString &word) const
 
QString text () const
 

Protected Slots

void slotEngineDone ()
 

Protected Member Functions

virtual QString fetchMoreText ()
 
virtual void finishedCurrentFeed ()
 

Detailed Description

BackgroundChecker is used to perform spell checking without blocking the application.

You can use it as is by calling the checkText function or subclass it and reimplement getMoreText function.

The misspelling signal is emitted whenever a misspelled word is found. The background checker stops right before emitting the signal. So the parent has to call continueChecking function to resume the checking.

done signal is emitted when whole text is spell checked.

Author
Zack Rusin zack@.nosp@m.kde..nosp@m.org class used for spell checking in the background

Definition at line 54 of file backgroundchecker.h.

Constructor & Destructor Documentation

BackgroundChecker::BackgroundChecker ( QObject *  parent = 0)
explicit

Definition at line 40 of file backgroundchecker.cpp.

BackgroundChecker::BackgroundChecker ( const Speller &  speller,
QObject *  parent = 0 
)
explicit

Definition at line 51 of file backgroundchecker.cpp.

BackgroundChecker::~BackgroundChecker ( )

Definition at line 63 of file backgroundchecker.cpp.

Member Function Documentation

bool BackgroundChecker::addWordToPersonal ( const QString &  word)

Definition at line 120 of file backgroundchecker.cpp.

void BackgroundChecker::changeLanguage ( const QString &  lang)
slot

Definition at line 130 of file backgroundchecker.cpp.

bool BackgroundChecker::checkWord ( const QString &  word)

Definition at line 115 of file backgroundchecker.cpp.

void BackgroundChecker::continueChecking ( )
virtualslot

After emitting misspelling signal the background checker stops.

The catcher is responsible for calling continueChecking function to resume checking.

Definition at line 135 of file backgroundchecker.cpp.

QString BackgroundChecker::currentContext ( ) const

Definition at line 159 of file backgroundchecker.cpp.

void Sonnet::BackgroundChecker::done ( )
signal

Emitted after the whole text has been spell checked.

QString BackgroundChecker::fetchMoreText ( )
protectedvirtual

This function is called to get the text to spell check.

It will be called continuesly until it returns QString() in which case the done() signal is emitted. Note: the start parameter in mispelling() is not a combined position but a position in the last string returned by fetchMoreText. You need to store the state in the derivatives.

Definition at line 96 of file backgroundchecker.cpp.

void BackgroundChecker::finishedCurrentFeed ( )
protectedvirtual

This function will be called whenever the background checker will be finished text which it got from fetchMoreText.

Definition at line 101 of file backgroundchecker.cpp.

void Sonnet::BackgroundChecker::misspelling ( const QString &  word,
int  start 
)
signal

Emitted whenever a misspelled word is found.

void Sonnet::BackgroundChecker::replace ( int  start,
const QString &  oldText,
const QString &  newText 
)
slot

Definition at line 164 of file backgroundchecker.cpp.

void BackgroundChecker::restore ( KConfig *  config)

Definition at line 68 of file backgroundchecker.cpp.

void BackgroundChecker::setSpeller ( const Speller &  speller)

Definition at line 105 of file backgroundchecker.cpp.

void BackgroundChecker::setText ( const QString &  text)

This method is used to spell check static text.

It automatically invokes start().

Use fetchMoreText() with start() to spell check a stream.

Definition at line 75 of file backgroundchecker.cpp.

void BackgroundChecker::slotEngineDone ( )
protectedslot

Definition at line 140 of file backgroundchecker.cpp.

Speller BackgroundChecker::speller ( ) const

Definition at line 110 of file backgroundchecker.cpp.

void BackgroundChecker::start ( )
virtualslot

Definition at line 82 of file backgroundchecker.cpp.

void BackgroundChecker::stop ( )
virtualslot

Definition at line 91 of file backgroundchecker.cpp.

QStringList BackgroundChecker::suggest ( const QString &  word) const

Definition at line 125 of file backgroundchecker.cpp.

QString BackgroundChecker::text ( ) const

Definition at line 153 of file backgroundchecker.cpp.


The documentation for this class was generated from the following files:
  • backgroundchecker.h
  • backgroundchecker.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:47:12 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

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

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Nepomuk-Core
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal