Sonnet::Filter Class Reference

#include <filter_p.h>

Public Member Functions
	Filter ()
virtual	~Filter ()
bool	atEnd () const
QString	buffer () const
virtual QString	context () const
virtual int	currentPosition () const
virtual Word	nextWord () const
virtual void	replace (const Word &w, const QString &newWord)
void	restart ()
void	setBuffer (const QString &buffer)
virtual void	setCurrentPosition (int)
void	setSettings (Settings *)
Settings *	settings () const
virtual Word	wordAtPosition (unsigned int pos) const

Static Public Member Functions
static Filter *	defaultFilter ()
static Word	end ()

Protected Member Functions
bool	ignore (const QString &word) const
bool	shouldBeSkipped (bool wordWasUppercase, bool wordWasRunTogether, const QString &foundWord) const
bool	trySkipLinks () const

Protected Attributes
QString	m_buffer
QTextBoundaryFinder	m_finder

Detailed Description

Filter is used to split text into words which will be spell checked.

Author

Zack Rusin zack@.nosp@m.kde..nosp@m.org

used to split text into words

Definition at line 65 of file filter_p.h.

Constructor & Destructor Documentation

Filter()

Sonnet::Filter::Filter

(

)

Definition at line 55 of file filter.cpp.

~Filter()

Sonnet::Filter::~Filter ( )

virtual

Definition at line 61 of file filter.cpp.

Member Function Documentation

atEnd()

bool Sonnet::Filter::atEnd

(

)

const

Definition at line 92 of file filter.cpp.

buffer()

QString Sonnet::Filter::buffer

(

)

const

Definition at line 87 of file filter.cpp.

context()

QString Sonnet::Filter::context ( ) const

virtual

Should return the sentence containing the current word.

Definition at line 226 of file filter.cpp.

currentPosition()

int Sonnet::Filter::currentPosition ( ) const

virtual

Definition at line 210 of file filter.cpp.

defaultFilter()

Filter * Sonnet::Filter::defaultFilter ( )

static

Definition at line 45 of file filter.cpp.

end()

Word Sonnet::Filter::end ( )

static

Definition at line 50 of file filter.cpp.

ignore()

bool Sonnet::Filter::ignore ( const QString & word ) const

protected

Definition at line 286 of file filter.cpp.

nextWord()

Word Sonnet::Filter::nextWord ( ) const

virtual

Definition at line 168 of file filter.cpp.

replace()

void Sonnet::Filter::replace ( const Word & w, const QString & newWord )

virtual

Definition at line 215 of file filter.cpp.

restart()

void Sonnet::Filter::restart

(

)

Definition at line 76 of file filter.cpp.

setBuffer()

void Sonnet::Filter::setBuffer

(

const QString &

buffer

)

Definition at line 81 of file filter.cpp.

setCurrentPosition()

void Sonnet::Filter::setCurrentPosition ( int i )

virtual

Definition at line 198 of file filter.cpp.

setSettings()

void Sonnet::Filter::setSettings

(

Settings *

conf

)

Sets the Settings object for this Filter.

Definition at line 66 of file filter.cpp.

settings()

Settings * Sonnet::Filter::settings

(

)

const

Returns currently used Settings object.

Definition at line 71 of file filter.cpp.

shouldBeSkipped()

bool Sonnet::Filter::shouldBeSkipped ( bool wordWasUppercase, bool wordWasRunTogether, const QString & foundWord ) const

protected

Definition at line 291 of file filter.cpp.

trySkipLinks()

bool Sonnet::Filter::trySkipLinks ( ) const

protected

Definition at line 253 of file filter.cpp.

wordAtPosition()

Word Sonnet::Filter::wordAtPosition ( unsigned int pos ) const

virtual

Definition at line 188 of file filter.cpp.

Member Data Documentation

m_buffer

QString Sonnet::Filter::m_buffer

protected

Definition at line 110 of file filter_p.h.

m_finder

QTextBoundaryFinder Sonnet::Filter::m_finder

mutableprotected

Definition at line 111 of file filter_p.h.

---

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

• filter_p.h
• filter.cpp