Hyphenator Class Reference

#include <hyphenator.h>

Inheritance diagram for Hyphenator:

Collaboration diagram for Hyphenator:

Public Slots
void	slotNewSettings (int Wordlen, bool Autom, bool ACheck, int Num)
	Writes actual hyphen configuration into doc object. More...
void	slotHyphenateWord (PageItem *it, const QString &text, int firstC)
	Make hyphenation when user edits text in text frame manually. If is everything set correctly and textframe selected language fits the dictionary language. At first removes any old hyphens then sets new one. More...
void	slotHyphenate (PageItem *it)
	Make hyphenation as described in. More...
void	slotDeHyphenate (PageItem *it)
	Removes hyphenation either for the whole text frame or the selected text if there is a selection. More...

Public Member Functions
	Hyphenator (QWidget *parent, ScribusDoc *dok)
	Constructor reads user configuration and sets hyphenator properties. More...
	~Hyphenator ()
	Safely cleans hyphen. More...

Public Attributes
int	MinWordLen
int	HyCount
QString	Language
bool	Automatic
bool	AutoCheck
QHash< QString, QString >	rememberedWords
QHash< QString, QString >	specialWords
QSet< QString >	ignoredWords

Detailed Description

This class is the core of the Scribus hyphenation system.

Constructor & Destructor Documentation

Hyphenator::Hyphenator	(	QWidget *	parent,
		ScribusDoc *	dok
	)

Constructor reads user configuration and sets hyphenator properties.

Date

Author

Franz Schmid

Parameters

parent	unused
dok	ScribusDoc reference. It's used for preferences accessing.

Hyphenator::~Hyphenator

(

)

Safely cleans hyphen.

Date

Author

Franz Schmid

Member Function Documentation

void Hyphenator::slotDeHyphenate ( PageItem *  it )

slot

Removes hyphenation either for the whole text frame or the selected text if there is a selection.

Date

Author

Franz Schmid

Parameters

it	references

See also

PageItem - text frame.

void Hyphenator::slotHyphenate ( PageItem *  it )

slot

Make hyphenation as described in.

See also

slotHyphenateWord for the whole text frame.

Date

Author

Franz Schmid

Parameters

it	references

See also

PageItem - text frame.

void Hyphenator::slotHyphenateWord ( PageItem *  it, const QString &  text, int  firstC  )

slot

Make hyphenation when user edits text in text frame manually. If is everything set correctly and textframe selected language fits the dictionary language. At first removes any old hyphens then sets new one.

Parameters

it	references

See also

PageItem - text frame.

Parameters

text	is a word to hyphenate.
firstC	is the first character of the word in it item.

void Hyphenator::slotNewSettings ( int  Wordlen, bool  Autom, bool  ACheck, int  Num  )

slot

Writes actual hyphen configuration into doc object.

Date

Author

Franz Schmid

Parameters

Wordlen	lenght of the word.
Autom	is automatic flag.
ACheck	AutoCheck flag.
Num	HyCount

Member Data Documentation

bool Hyphenator::AutoCheck

Flag - obsolete?

bool Hyphenator::Automatic

Flag - if user set auto hyphen processing.

int Hyphenator::HyCount

Maximum number of hyphenations allowed following each other

QString Hyphenator::Language

Language in use

int Hyphenator::MinWordLen

There are languages having rule not to hyphen word shorter than MinWordLen

---

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

• /Users/ale/src/Scribus/scribus/hyphenator.h
• /Users/ale/src/Scribus/scribus/hyphenator.cpp