Sonnet::Filter Class Reference

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

#include <filter_p.h>

List of all members.

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@kde.org> used to split text into words

Definition at line 65 of file filter_p.h.

---

Constructor & Destructor Documentation

Sonnet::Filter::Filter

(

)

Definition at line 55 of file filter.cpp.

Sonnet::Filter::~Filter

(

)

[virtual]

Definition at line 61 of file filter.cpp.

---

Member Function Documentation

bool Sonnet::Filter::atEnd

(

)

const

Definition at line 92 of file filter.cpp.

QString Sonnet::Filter::buffer

(

)

const

Definition at line 87 of file filter.cpp.

QString Sonnet::Filter::context

(

)

const [virtual]

Should return the sentence containing the current word.

Definition at line 226 of file filter.cpp.

int Sonnet::Filter::currentPosition

(

)

const [virtual]

Definition at line 210 of file filter.cpp.

Filter * Sonnet::Filter::defaultFilter

(

)

[static]

Definition at line 45 of file filter.cpp.

Word Sonnet::Filter::end

(

)

[static]

Definition at line 50 of file filter.cpp.

bool Sonnet::Filter::ignore

(

const QString &

word

)

const [protected]

Definition at line 286 of file filter.cpp.

Word Sonnet::Filter::nextWord

(

)

const [virtual]

Definition at line 168 of file filter.cpp.

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

Definition at line 215 of file filter.cpp.

void Sonnet::Filter::restart

(

)

Definition at line 76 of file filter.cpp.

void Sonnet::Filter::setBuffer

(

const QString &

buffer

)

Definition at line 81 of file filter.cpp.

void Sonnet::Filter::setCurrentPosition

(

int

i

)

[virtual]

Definition at line 198 of file filter.cpp.

void Sonnet::Filter::setSettings

(

Settings *

conf

)

Sets the Settings object for this Filter.

Definition at line 66 of file filter.cpp.

Settings * Sonnet::Filter::settings

(

)

const

Returns currently used Settings object.

Definition at line 71 of file filter.cpp.

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

Definition at line 291 of file filter.cpp.

bool Sonnet::Filter::trySkipLinks

(

)

const [protected]

Definition at line 253 of file filter.cpp.

Word Sonnet::Filter::wordAtPosition

(

unsigned int

pos

)

const [virtual]

Definition at line 188 of file filter.cpp.

---

Member Data Documentation

QString Sonnet::Filter::m_buffer [protected]

Definition at line 110 of file filter_p.h.

QTextBoundaryFinder Sonnet::Filter::m_finder [mutable, protected]

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