KEduVocTranslation Class Reference

#include <keduvoctranslation.h>

Inheritance diagram for KEduVocTranslation:

Public Types
enum	Related { Synonym, Antonym, FalseFriend }

Public Member Functions
	KEduVocTranslation (KEduVocExpression *entry)
	KEduVocTranslation (KEduVocExpression *entry, const QString &translation)
	KEduVocTranslation (const KEduVocTranslation &other)
	~KEduVocTranslation ()
void	addAntonym (KEduVocTranslation *antonym)
void	addFalseFriend (KEduVocTranslation *falseFriend)
void	addSynonym (KEduVocTranslation *synonym)
QString	antonym () const
QList< KEduVocTranslation * >	antonyms () const
KEduVocText	article () const
QString	comment () const
KDE_DEPRECATED QString	comparative () const
KEduVocText	comparativeForm () const
KEduVocConjugation &	conjugation (const QString &tense)
KDE_DEPRECATED QMap< QString, KEduVocConjugation >	conjugations () const
QStringList	conjugationTenses () const
KEduVocDeclension *	declension ()
KEduVocExpression *	entry ()
QString	example () const
QList< KEduVocTranslation * >	falseFriends () const
void	fromKVTML2 (QDomElement &parent)
KUrl	imageUrl ()
QString	irregularPlural () const
KEduVocLeitnerBox *	leitnerBox () const
QStringList &	multipleChoice ()
KEduVocTranslation &	operator= (const KEduVocTranslation &translation)
bool	operator== (const KEduVocTranslation &translation) const
QString	paraphrase () const
QString	pronunciation () const
void	removeAntonym (KEduVocTranslation *antonym)
void	removeFalseFriend (KEduVocTranslation *falseFriend)
void	removeSynonym (KEduVocTranslation *synonym)
void	setAntonym (const QString &expression)
void	setArticle (const KEduVocText &article)
void	setComment (const QString &expr)
KDE_DEPRECATED void	setComparative (const QString &comparative)
void	setComparativeForm (const KEduVocText &comparative)
void	setConjugation (const QString &tense, const KEduVocConjugation &conjugation)
void	setConjugations (const QMap< QString, KEduVocConjugation > &conjugations)
void	setDeclension (KEduVocDeclension *declension)
void	setExample (const QString &expression)
void	setImageUrl (const KUrl &url)
void	setIrregularPlural (const QString &plural)
void	setLeitnerBox (KEduVocLeitnerBox *leitnerBox)
void	setParaphrase (const QString &expression)
void	setPronunciation (const QString &expression)
void	setSoundUrl (const KUrl &url)
KDE_DEPRECATED void	setSuperlative (const QString &superlative)
void	setSuperlativeForm (const KEduVocText &superlative)
void	setWordType (KEduVocWordType *wordType)
KUrl	soundUrl ()
KDE_DEPRECATED QString	superlative () const
KEduVocText	superlativeForm () const
QList< KEduVocTranslation * >	synonyms () const
void	toKVTML2 (QDomElement &parent)
KEduVocWordType *	wordType () const
Public Member Functions inherited from KEduVocText
	KEduVocText (const QString &text=QString())
	KEduVocText (const KEduVocText &other)
	~KEduVocText ()
count_t	badCount () const
void	decGrade ()
void	fromKVTML2 (QDomElement &parent)
grade_t	grade () const
void	incBadCount ()
void	incGrade ()
void	incPracticeCount ()
bool	isEmpty ()
KEduVocText &	operator= (const KEduVocText &other)
bool	operator== (const KEduVocText &other) const
count_t	practiceCount () const
QDateTime	practiceDate () const
void	resetGrades ()
void	setBadCount (count_t count)
void	setGrade (grade_t grade)
void	setPracticeCount (count_t count)
void	setPracticeDate (const QDateTime &date)
void	setText (const QString &expr)
QString	text () const
void	toKVTML2 (QDomElement &parent)

Detailed Description

Author

Frederik Gladhorn frede.nosp@m.rik..nosp@m.gladh.nosp@m.orn@.nosp@m.kdema.nosp@m.il.n.nosp@m.et

Definition at line 35 of file keduvoctranslation.h.

Member Enumeration Documentation

enum KEduVocTranslation::Related

Enumerator
Synonym
Antonym
FalseFriend

Definition at line 39 of file keduvoctranslation.h.

Constructor & Destructor Documentation

KEduVocTranslation::KEduVocTranslation

(

KEduVocExpression *

entry

)

Default constructor for an empty translation.

Definition at line 100 of file keduvoctranslation.cpp.

KEduVocTranslation::KEduVocTranslation	(	KEduVocExpression *	entry,
		const QString &	translation
	)

Constructor.

Parameters

translation

is used as translation

Definition at line 105 of file keduvoctranslation.cpp.

KEduVocTranslation::KEduVocTranslation

(

const KEduVocTranslation &

other

)

copy constructor for d-pointer safety

Definition at line 110 of file keduvoctranslation.cpp.

KEduVocTranslation::~KEduVocTranslation

(

)

Destructor.

Definition at line 138 of file keduvoctranslation.cpp.

Member Function Documentation

void KEduVocTranslation::addAntonym

(

KEduVocTranslation *

antonym

)

Add a antonym.

Parameters

antonym

Definition at line 245 of file keduvoctranslation.cpp.

void KEduVocTranslation::addFalseFriend

(

KEduVocTranslation *

falseFriend

)

Add a false friend.

Parameters

falseFriend

false friend of this index

Definition at line 214 of file keduvoctranslation.cpp.

void KEduVocTranslation::addSynonym

(

KEduVocTranslation *

synonym

)

Add a synonym.

Parameters

synonym

Definition at line 230 of file keduvoctranslation.cpp.

QString KEduVocTranslation::antonym

(

)

const

Returns antonym of this expression.

Returns

antonym or "" if no string available

QList< KEduVocTranslation * > KEduVocTranslation::antonyms

(

)

const

Returns antonyms of this expression.

Returns

antonyms

Definition at line 250 of file keduvoctranslation.cpp.

KEduVocText KEduVocTranslation::article

(

)

const

Definition at line 464 of file keduvoctranslation.cpp.

QString KEduVocTranslation::comment

(

)

const

Returns comments of this expression.

Returns

comment or "" if no comment available

Definition at line 202 of file keduvoctranslation.cpp.

QString KEduVocTranslation::comparative

(

)

const

Comparison forms of adjectives/adverbs.

Definition at line 396 of file keduvoctranslation.cpp.

KEduVocText KEduVocTranslation::comparativeForm

(

)

const

Definition at line 430 of file keduvoctranslation.cpp.

KEduVocConjugation & KEduVocTranslation::conjugation

(

const QString &

tense

)

Returns a conjugation if available.

Parameters

tense

tense of the requested conjugation

Returns

the conjugation

Definition at line 290 of file keduvoctranslation.cpp.

QMap< QString, KEduVocConjugation > KEduVocTranslation::conjugations

(

)

const

Bad, only compatibility.

Deprecated.

Returns

Definition at line 318 of file keduvoctranslation.cpp.

QStringList KEduVocTranslation::conjugationTenses

(

)

const

Definition at line 313 of file keduvoctranslation.cpp.

KEduVocDeclension * KEduVocTranslation::declension

(

)

Returns a pointer to the declension object of this translation.

Returns 0 if no declension object exists!

Returns

the declension

Definition at line 481 of file keduvoctranslation.cpp.

KEduVocExpression * KEduVocTranslation::entry

(

)

Definition at line 391 of file keduvoctranslation.cpp.

QString KEduVocTranslation::example

(

)

const

Returns example of this expression.

Returns

example or "" if no string available

Definition at line 266 of file keduvoctranslation.cpp.

QList< KEduVocTranslation * > KEduVocTranslation::falseFriends

(

)

const

Returns false friends of this expression.

Returns

list of false friends

Definition at line 224 of file keduvoctranslation.cpp.

void KEduVocTranslation::fromKVTML2

(

QDomElement &

parent

)

Todo:

synonyms, antonym

Todo:

false friends

Definition at line 528 of file keduvoctranslation.cpp.

KUrl KEduVocTranslation::imageUrl

(

)

Get the image url for this translation if it exists.

get the image url for this translation if it exists

Definition at line 342 of file keduvoctranslation.cpp.

QString KEduVocTranslation::irregularPlural

(

)

const

Gets an irregular plural form.

Returns

plural of the word

KEduVocLeitnerBox * KEduVocTranslation::leitnerBox

(

)

const

Returns the leitner box of this translation.

Returns

the box

Definition at line 375 of file keduvoctranslation.cpp.

QStringList & KEduVocTranslation::multipleChoice

(

)

Returns multiple choice if available.

Definition at line 296 of file keduvoctranslation.cpp.

KEduVocTranslation & KEduVocTranslation::operator=

(

const KEduVocTranslation &

translation

)

Equal operator to assing a translation to another one.

Parameters

translation

translation to be copied

Returns

reference to the new translation

Definition at line 175 of file keduvoctranslation.cpp.

bool KEduVocTranslation::operator==

(

const KEduVocTranslation &

translation

)

const

Compare two translations, including word type etc.

Parameters

translation

Returns

true if equal

Todo:

check and include declensions d->m_declension == translation.d->m_declension;

Definition at line 154 of file keduvoctranslation.cpp.

QString KEduVocTranslation::paraphrase

(

)

const

Returns paraphrase of this expression.

Returns

paraphrase or "" if no string available

Definition at line 278 of file keduvoctranslation.cpp.

QString KEduVocTranslation::pronunciation

(

)

const

Returns the pronunciation of this expression.

Returns

pronunciation or "" if none available

Definition at line 302 of file keduvoctranslation.cpp.

void KEduVocTranslation::removeAntonym

(

KEduVocTranslation *

antonym

)

Remove a antonym.

Parameters

antonym

Definition at line 255 of file keduvoctranslation.cpp.

void KEduVocTranslation::removeFalseFriend

(

KEduVocTranslation *

falseFriend

)

Remove a false friend.

Parameters

falseFriend

false friend of this index

Definition at line 219 of file keduvoctranslation.cpp.

void KEduVocTranslation::removeSynonym

(

KEduVocTranslation *

synonym

)

Remove a synonym.

Parameters

synonym

Definition at line 235 of file keduvoctranslation.cpp.

void KEduVocTranslation::setAntonym

(

const QString &

expression

)

Sets antonym this expression.

Parameters

expression

antonym of this index

void KEduVocTranslation::setArticle

(

const KEduVocText &

article

)

Definition at line 473 of file keduvoctranslation.cpp.

void KEduVocTranslation::setComment

(

const QString &

expr

)

Sets comment of this expression.

Parameters

expr	comment of this index

Definition at line 208 of file keduvoctranslation.cpp.

void KEduVocTranslation::setComparative

(

const QString &

comparative

)

Definition at line 404 of file keduvoctranslation.cpp.

void KEduVocTranslation::setComparativeForm

(

const KEduVocText &

comparative

)

Definition at line 439 of file keduvoctranslation.cpp.

void KEduVocTranslation::setConjugation	(	const QString &	tense,
		const KEduVocConjugation &	conjugation
	)

adds conjugations or replaces them, if they exist.

Parameters

conjugation

conjugation

Definition at line 284 of file keduvoctranslation.cpp.

void KEduVocTranslation::setConjugations

(

const QMap< QString, KEduVocConjugation > &

conjugations

)

Bad, only used for tense entry page, will be deleted later.

Deprecated.

Parameters

conjugation

Definition at line 323 of file keduvoctranslation.cpp.

void KEduVocTranslation::setDeclension

(

KEduVocDeclension *

declension

)

Set a new declension for a translation.

Parameters

declension

Definition at line 486 of file keduvoctranslation.cpp.

void KEduVocTranslation::setExample

(

const QString &

expression

)

Sets example this expression.

Parameters

expression

example of this index

Definition at line 260 of file keduvoctranslation.cpp.

void KEduVocTranslation::setImageUrl

(

const KUrl &

url

)

Set the image url for this translation.

set the image url for this translation

Parameters

url	url of the image

Definition at line 350 of file keduvoctranslation.cpp.

void KEduVocTranslation::setIrregularPlural

(

const QString &

plural

)

Sets an irregular plural form.

Parameters

plural

plural of the word

void KEduVocTranslation::setLeitnerBox

(

KEduVocLeitnerBox *

leitnerBox

)

Sets the leitner box of this translation.

Parameters

leitnerBox

the box

Definition at line 380 of file keduvoctranslation.cpp.

void KEduVocTranslation::setParaphrase

(

const QString &

expression

)

Sets paraphrase of this expression.

Parameters

expression

paraphrase of this index

Definition at line 272 of file keduvoctranslation.cpp.

void KEduVocTranslation::setPronunciation

(

const QString &

expression

)

Sets the pronunciation of this expression.

Parameters

expression

pronunciation of this index

Definition at line 308 of file keduvoctranslation.cpp.

void KEduVocTranslation::setSoundUrl

(

const KUrl &

url

)

Set the sound url for this translation.

set the sound url for this translation

Parameters

url	url of the sound file

Definition at line 336 of file keduvoctranslation.cpp.

void KEduVocTranslation::setSuperlative

(

const QString &

superlative

)

Definition at line 421 of file keduvoctranslation.cpp.

void KEduVocTranslation::setSuperlativeForm

(

const KEduVocText &

superlative

)

Definition at line 456 of file keduvoctranslation.cpp.

void KEduVocTranslation::setWordType

(

KEduVocWordType *

wordType

)

Sets the word type of this expression.

Parameters

type	type of this expression ("" = none)

Definition at line 364 of file keduvoctranslation.cpp.

KUrl KEduVocTranslation::soundUrl

(

)

Sets multiple choice.

get the sound url for this translation if it exists

Parameters

mc	multiple choice blockGet the sound url for this translation if it exists

Definition at line 329 of file keduvoctranslation.cpp.

QString KEduVocTranslation::superlative

(

)

const

Definition at line 413 of file keduvoctranslation.cpp.

KEduVocText KEduVocTranslation::superlativeForm

(

)

const

Definition at line 447 of file keduvoctranslation.cpp.

QList< KEduVocTranslation * > KEduVocTranslation::synonyms

(

)

const

Returns synonyms of this expression.

Returns

synonyms

Definition at line 240 of file keduvoctranslation.cpp.

void KEduVocTranslation::toKVTML2

(

QDomElement &

parent

)

Todo:

synonyms, antonyms

Todo:

false friends

Definition at line 493 of file keduvoctranslation.cpp.

KEduVocWordType * KEduVocTranslation::wordType

(

)

const

Returns the word type of this expression, you will get a 0 pointer if wordtype is not set for the translation.

Returns

type or "" if no type available

Definition at line 355 of file keduvoctranslation.cpp.

---

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

• keduvoctranslation.h
• keduvoctranslation.cpp