• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdeedu
  • Sitemap
  • Contact Us
 

libkdeedu/keduvocdocument

KEduVocTranslation Class Reference

#include <keduvoctranslation.h>

Inheritance diagram for KEduVocTranslation:

Inheritance graph
[legend]

List of all members.

Detailed Description

Author:
Frederik Gladhorn <frederik.gladhorn@kdemail.net>

Definition at line 36 of file keduvoctranslation.h.


Public Types

enum  Related { Synonym, Antonym, FalseFriend }

Public Member Functions

void addAntonym (KEduVocTranslation *antonym)
void addFalseFriend (KEduVocTranslation *falseFriend)
void addSynonym (KEduVocTranslation *synonym)
QString antonym () const
QList< KEduVocTranslation * > antonyms () const
QString comment () const
QString comparative () const
KEduVocConjugation & conjugation (const QString &tense)
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
 KEduVocTranslation (const KEduVocTranslation &other)
 KEduVocTranslation (KEduVocExpression *entry, const QString &translation)
 KEduVocTranslation (KEduVocExpression *entry)
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 setComment (const QString &expr)
void setComparative (const QString &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)
void setSuperlative (const QString &superlative)
void setWordType (KEduVocWordType *wordType)
KUrl soundUrl ()
QString superlative () const
QList< KEduVocTranslation * > synonyms () const
void toKVTML2 (QDomElement &parent)
KEduVocWordType * wordType () const
 ~KEduVocTranslation ()

Member Enumeration Documentation

enum KEduVocTranslation::Related

Enumerator:
Synonym 
Antonym 
FalseFriend 

Definition at line 40 of file keduvoctranslation.h.

Constructor & Destructor Documentation

KEduVocTranslation::KEduVocTranslation ( KEduVocExpression *  entry  ) 

Default constructor for an empty translation.

Definition at line 94 of file keduvoctranslation.cpp.

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

Constructor.

Parameters:
translation is used as translation

Definition at line 102 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 141 of file keduvoctranslation.cpp.

Member Function Documentation

void KEduVocTranslation::addAntonym ( KEduVocTranslation *  antonym  ) 

add a antonym

Parameters:
antonym 

Definition at line 250 of file keduvoctranslation.cpp.

void KEduVocTranslation::addFalseFriend ( KEduVocTranslation *  falseFriend  ) 

add a false friend

Parameters:
falseFriend false friend of this index

Definition at line 219 of file keduvoctranslation.cpp.

void KEduVocTranslation::addSynonym ( KEduVocTranslation *  synonym  ) 

add a synonym

Parameters:
synonym 

Definition at line 235 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 255 of file keduvoctranslation.cpp.

QString KEduVocTranslation::comment (  )  const

returns comments of this expression

Returns:
comment or "" if no comment available

Definition at line 207 of file keduvoctranslation.cpp.

QString KEduVocTranslation::comparative (  )  const

Comparison forms of adjectives/adverbs.

Definition at line 400 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 295 of file keduvoctranslation.cpp.

QMap< QString, KEduVocConjugation > KEduVocTranslation::conjugations (  )  const

Bad, only compatibility.

Deprecated.

Returns:

Definition at line 323 of file keduvoctranslation.cpp.

QStringList KEduVocTranslation::conjugationTenses (  )  const

Definition at line 318 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 420 of file keduvoctranslation.cpp.

KEduVocExpression * KEduVocTranslation::entry (  ) 

Definition at line 395 of file keduvoctranslation.cpp.

QString KEduVocTranslation::example (  )  const

returns example of this expression

Returns:
example or "" if no string available

Definition at line 271 of file keduvoctranslation.cpp.

QList< KEduVocTranslation * > KEduVocTranslation::falseFriends (  )  const

returns false friends of this expression

Returns:
list of false friends

Definition at line 229 of file keduvoctranslation.cpp.

void KEduVocTranslation::fromKVTML2 ( QDomElement &  parent  ) 

Todo:
synonyms, antonym

false friends

Reimplemented from KEduVocText.

Definition at line 465 of file keduvoctranslation.cpp.

KUrl KEduVocTranslation::imageUrl (  ) 

get the image url for this translation if it exists

Definition at line 347 of file keduvoctranslation.cpp.

QString KEduVocTranslation::irregularPlural (  )  const

Get a 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 379 of file keduvoctranslation.cpp.

QStringList & KEduVocTranslation::multipleChoice (  ) 

returns multiple choice if available

Definition at line 301 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 178 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 157 of file keduvoctranslation.cpp.

QString KEduVocTranslation::paraphrase (  )  const

returns paraphrase of this expression

Returns:
paraphrase or "" if no string available

Definition at line 283 of file keduvoctranslation.cpp.

QString KEduVocTranslation::pronunciation (  )  const

returns the pronunciation of this expression

Returns:
pronunciation or "" if none available

Definition at line 307 of file keduvoctranslation.cpp.

void KEduVocTranslation::removeAntonym ( KEduVocTranslation *  antonym  ) 

remove a antonym

Parameters:
antonym 

Definition at line 260 of file keduvoctranslation.cpp.

void KEduVocTranslation::removeFalseFriend ( KEduVocTranslation *  falseFriend  ) 

remove a false friend

Parameters:
falseFriend false friend of this index

Definition at line 224 of file keduvoctranslation.cpp.

void KEduVocTranslation::removeSynonym ( KEduVocTranslation *  synonym  ) 

remove a synonym

Parameters:
synonym 

Definition at line 240 of file keduvoctranslation.cpp.

void KEduVocTranslation::setAntonym ( const QString &  expression  ) 

sets antonym this expression

Parameters:
expression antonym of this index

void KEduVocTranslation::setComment ( const QString &  expr  ) 

sets comment of this expression

Parameters:
expr comment of this index

Definition at line 213 of file keduvoctranslation.cpp.

void KEduVocTranslation::setComparative ( const QString &  comparative  ) 

Definition at line 405 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 289 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 328 of file keduvoctranslation.cpp.

void KEduVocTranslation::setDeclension ( KEduVocDeclension *  declension  ) 

Set a new declension for a translation.

Parameters:
declension 

Definition at line 425 of file keduvoctranslation.cpp.

void KEduVocTranslation::setExample ( const QString &  expression  ) 

sets example this expression

Parameters:
expression example of this index

Definition at line 265 of file keduvoctranslation.cpp.

void KEduVocTranslation::setImageUrl ( const KUrl &  url  ) 

set the image url for this translation

Parameters:
url url of the image

Definition at line 355 of file keduvoctranslation.cpp.

void KEduVocTranslation::setIrregularPlural ( const QString &  plural  ) 

Set a 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 384 of file keduvoctranslation.cpp.

void KEduVocTranslation::setParaphrase ( const QString &  expression  ) 

sets paraphrase of this expression

Parameters:
expression paraphrase of this index

Definition at line 277 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 313 of file keduvoctranslation.cpp.

void KEduVocTranslation::setSoundUrl ( const KUrl &  url  ) 

set the sound url for this translation

Parameters:
url url of the sound file

Definition at line 341 of file keduvoctranslation.cpp.

void KEduVocTranslation::setSuperlative ( const QString &  superlative  ) 

Definition at line 415 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 368 of file keduvoctranslation.cpp.

KUrl KEduVocTranslation::soundUrl (  ) 

sets multiple choice

get the sound url for this translation if it exists

Parameters:
mc multiple choice block get the sound url for this translation if it exists

Definition at line 334 of file keduvoctranslation.cpp.

QString KEduVocTranslation::superlative (  )  const

Definition at line 410 of file keduvoctranslation.cpp.

QList< KEduVocTranslation * > KEduVocTranslation::synonyms (  )  const

returns synonyms of this expression

Returns:
synonyms

Definition at line 245 of file keduvoctranslation.cpp.

void KEduVocTranslation::toKVTML2 ( QDomElement &  parent  ) 

Todo:
synonyms, antonyms

false friends

Reimplemented from KEduVocText.

Definition at line 432 of file keduvoctranslation.cpp.

KEduVocWordType * KEduVocTranslation::wordType (  )  const

returns the word type of this expression

Returns:
type or "" if no type available

Definition at line 360 of file keduvoctranslation.cpp.

The documentation for this class was generated from the following files:
  • keduvoctranslation.h
  • keduvoctranslation.cpp

libkdeedu/keduvocdocument

Skip menu "libkdeedu/keduvocdocument"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdeedu

Skip menu "kdeedu"
  • kalzium
  • kanagram
  • kig
  •   lib
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  •   docs
  •   src
  • parley
  •   stepcore
Generated for kdeedu by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal