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

libkdeedu/keduvocdocument

KEduVocWordType Class Reference

#include <keduvocwordtype.h>

List of all members.

Detailed Description

Word type handling including subtypes (noun - male/female) etc.

Special types: To let KVocTrain decide which word type is a verb for example the special tag is used.

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

Definition at line 38 of file keduvocwordtype.h.


Public Member Functions

 KEduVocWordType ()
 KEduVocWordType (const KEduVocWordType &other)
 ~KEduVocWordType ()
KEduVocWordType & operator= (const KEduVocWordType &other)
bool operator== (const KEduVocWordType &other)
void createDefaultWordTypes ()
void addType (const QString &typeName, const QString &specialType=QString())
void addSubType (const QString &mainType, const QString &typeName, const QString &specialType=QString())
QStringList typeNameList () const
QStringList subTypeNameList (const QString &mainType) const
void renameType (const QString &oldTypeName, const QString &newTypeName)
void renameSubType (const QString &mainTypeName, const QString &oldTypeName, const QString &newTypeName)
bool removeType (const QString &typeName)
bool removeSubType (const QString &mainTypeName, const QString &typeName)
QString specialType (const QString &typeName)
void setSpecialType (const QString &typeName, const QString &newSpecialType)
QString specialSubType (const QString &mainTypeName, const QString &subTypeName)
void setSpecialSubType (const QString &mainTypeName, const QString &subTypeName, const QString &newSpecialType)
QString specialTypeNoun () const
QString specialTypeNounMale () const
QString specialTypeNounFemale () const
QString specialTypeNounNeutral () const
QString specialTypeVerb () const
QString specialTypeAdjective () const
QString specialTypeAdverb () const
void clear ()

Constructor & Destructor Documentation

KEduVocWordType::KEduVocWordType (  )  [explicit]

default constructor

Definition at line 96 of file keduvocwordtype.cpp.

KEduVocWordType::KEduVocWordType ( const KEduVocWordType &  other  ) 

copy constructor for d-pointer safe copying

Definition at line 111 of file keduvocwordtype.cpp.

KEduVocWordType::~KEduVocWordType (  ) 

destructor

Definition at line 100 of file keduvocwordtype.cpp.

Member Function Documentation

KEduVocWordType & KEduVocWordType::operator= ( const KEduVocWordType &  other  ) 

assignment operator

Definition at line 105 of file keduvocwordtype.cpp.

bool KEduVocWordType::operator== ( const KEduVocWordType &  other  ) 

Definition at line 91 of file keduvocwordtype.cpp.

void KEduVocWordType::createDefaultWordTypes (  ) 

Definition at line 118 of file keduvocwordtype.cpp.

void KEduVocWordType::addType ( const QString &  typeName,
const QString &  specialType = QString() 
)

Create a new word type in the list of known types.

Parameters:
typeName Name of the word type
specialType Name of the special type - this is used internally to identify which types are use for special queries - verb query needs special == "verb" for example.

Definition at line 208 of file keduvocwordtype.cpp.

void KEduVocWordType::addSubType ( const QString &  mainType,
const QString &  typeName,
const QString &  specialType = QString() 
)

Same as addType but for a sub word type (male/female/nutral for noun for example).

Parameters:
mainType The word type to which the subtype belongs.
typeName Sub type name
specialType See above

Definition at line 223 of file keduvocwordtype.cpp.

QStringList KEduVocWordType::typeNameList (  )  const

Get a list of all known main word types.

This can be for example: noun, verb, adjective...

Returns:
List of type names

Definition at line 187 of file keduvocwordtype.cpp.

QStringList KEduVocWordType::subTypeNameList ( const QString &  mainType  )  const

Same as typeNameList for subtypes.

Could be male, female, nutral for nouns.

Parameters:
mainType The type whos subtypes are requested.
Returns:
The subtypes.

Definition at line 196 of file keduvocwordtype.cpp.

void KEduVocWordType::renameType ( const QString &  oldTypeName,
const QString &  newTypeName 
)

Rename a type.

Parameters:
oldTypeName Old name
newTypeName New name

Definition at line 236 of file keduvocwordtype.cpp.

void KEduVocWordType::renameSubType ( const QString &  mainTypeName,
const QString &  oldTypeName,
const QString &  newTypeName 
)

Rename a subtype.

Parameters:
mainTypeName Main type
oldTypeName Old name
newTypeName New name

Definition at line 242 of file keduvocwordtype.cpp.

bool KEduVocWordType::removeType ( const QString &  typeName  ) 

Delete a type.

Special types cannot be deleted.

Parameters:
typeName name
Returns:
true if it was possible to delete the type

Definition at line 259 of file keduvocwordtype.cpp.

bool KEduVocWordType::removeSubType ( const QString &  mainTypeName,
const QString &  typeName 
)

removeType for subtypes.

Parameters:
mainTypeName main type
typeName type name
Returns:
true if it was possible to delete the type

Definition at line 270 of file keduvocwordtype.cpp.

QString KEduVocWordType::specialType ( const QString &  typeName  ) 

Get the special type, if any.

Parameters:
typeName Name whos special type is requested
Returns:
the special type or an empty string.

Definition at line 299 of file keduvocwordtype.cpp.

void KEduVocWordType::setSpecialType ( const QString &  typeName,
const QString &  newSpecialType 
)

Definition at line 354 of file keduvocwordtype.cpp.

QString KEduVocWordType::specialSubType ( const QString &  mainTypeName,
const QString &  subTypeName 
)

Same as above for a subtype.

Parameters:
typeName Main type name
typeName Sub type name
Returns:
the special type or an empty string.

Definition at line 308 of file keduvocwordtype.cpp.

void KEduVocWordType::setSpecialSubType ( const QString &  mainTypeName,
const QString &  subTypeName,
const QString &  newSpecialType 
)

Definition at line 362 of file keduvocwordtype.cpp.

QString KEduVocWordType::specialTypeNoun (  )  const

Definition at line 321 of file keduvocwordtype.cpp.

QString KEduVocWordType::specialTypeNounMale (  )  const

Definition at line 325 of file keduvocwordtype.cpp.

QString KEduVocWordType::specialTypeNounFemale (  )  const

Definition at line 329 of file keduvocwordtype.cpp.

QString KEduVocWordType::specialTypeNounNeutral (  )  const

Definition at line 333 of file keduvocwordtype.cpp.

QString KEduVocWordType::specialTypeVerb (  )  const

Definition at line 339 of file keduvocwordtype.cpp.

QString KEduVocWordType::specialTypeAdjective (  )  const

Definition at line 344 of file keduvocwordtype.cpp.

QString KEduVocWordType::specialTypeAdverb (  )  const

Definition at line 349 of file keduvocwordtype.cpp.

void KEduVocWordType::clear (  ) 

Definition at line 373 of file keduvocwordtype.cpp.

The documentation for this class was generated from the following files:
  • keduvocwordtype.h
  • keduvocwordtype.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
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  •   docs
  •   src
  • parley
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