lib

Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
KoSpell Class Reference

#include <KoSpell.h>

Inherits KSpell2::BackgroundChecker.

Public Slots

void slotCurrentParagraphDeleted ()
 

Signals

void paragraphChecked (KoTextParag *)
 
void aboutToFeedText ()
 

Public Member Functions

 KoSpell (const KSpell2::Broker::Ptr &broker, TQObject *parent=0, const char *name=0)
 
virtual ~KoSpell ()
 
bool checking () const
 
virtual bool check (KoTextIterator *itr, bool dialog=false)
 
virtual bool check (KoTextParag *parag)
 
virtual bool checkWordInParagraph (KoTextParag *parag, int pos, TQString &word, int &start)
 
KoTextParag * currentParag () const
 
KoTextObject * currentTextObject () const
 
int currentStartIndex () const
 
KoTextDocument * textDocument () const
 
KSpell2::Settings * settings () const
 

Protected Member Functions

virtual TQString getMoreText ()
 
virtual void finishedCurrentFeed ()
 

Detailed Description

KOffice spell checking object Used for both spell-checking-with-a-dialog (directly) and background spell-checking (via KoBgSpellCheck).

Author
Zack Rusin zack@.nosp@m.kde..nosp@m.org, David Sweet dswee.nosp@m.t@kd.nosp@m.e.org
See also
KSpell2::Broker

Definition at line 45 of file KoSpell.h.

Constructor & Destructor Documentation

◆ KoSpell()

KoSpell::KoSpell ( const KSpell2::Broker::Ptr &  broker,
TQObject *  parent = 0,
const char *  name = 0 
)

Definition at line 52 of file KoSpell.cpp.

◆ ~KoSpell()

KoSpell::~KoSpell ( )
virtual

The destructor instructs ISpell/ASpell to write out the personal dictionary and then terminates ISpell/ASpell.

Definition at line 64 of file KoSpell.cpp.

Member Function Documentation

◆ check() [1/2]

bool KoSpell::check ( KoTextIterator *  itr,
bool  dialog = false 
)
virtual

Spellchecks a buffer of many words in plain text format.

The buffer is not modified. The signal done() will be sent when check() is finished.

Definition at line 69 of file KoSpell.cpp.

◆ check() [2/2]

bool KoSpell::check ( KoTextParag *  parag)
virtual

Definition at line 86 of file KoSpell.cpp.

◆ checking()

bool KoSpell::checking ( ) const

Returns whether the speller is already checking something.

Definition at line 218 of file KoSpell.cpp.

◆ checkWordInParagraph()

bool KoSpell::checkWordInParagraph ( KoTextParag *  parag,
int  pos,
TQString &  word,
int &  start 
)
virtual

do we really need to create a Filter every time?

Definition at line 99 of file KoSpell.cpp.

◆ currentParag()

KoTextParag * KoSpell::currentParag ( ) const

Definition at line 181 of file KoSpell.cpp.

◆ currentStartIndex()

int KoSpell::currentStartIndex ( ) const

Definition at line 193 of file KoSpell.cpp.

◆ currentTextObject()

KoTextObject * KoSpell::currentTextObject ( ) const

Definition at line 186 of file KoSpell.cpp.

◆ finishedCurrentFeed()

void KoSpell::finishedCurrentFeed ( )
protectedvirtual

Definition at line 176 of file KoSpell.cpp.

◆ getMoreText()

TQString KoSpell::getMoreText ( )
protectedvirtual

Definition at line 124 of file KoSpell.cpp.

◆ paragraphChecked

void KoSpell::paragraphChecked ( KoTextParag *  )
signal

Emitted after a paragraph has been checked.

◆ settings()

KSpell2::Settings * KoSpell::settings ( ) const

Returns the Settings object used by the broker.

Definition at line 241 of file KoSpell.cpp.

◆ slotCurrentParagraphDeleted

void KoSpell::slotCurrentParagraphDeleted ( )
slot

Definition at line 200 of file KoSpell.cpp.

◆ textDocument()

KoTextDocument * KoSpell::textDocument ( ) const

Definition at line 236 of file KoSpell.cpp.

The documentation for this class was generated from the following files: