Scripting::Identifier Class Reference

Identifier class can be accessed from Document class and is used for specifying the document languages, articles and personal pronouns. More...

#include <identifier.h>

Inheritance diagram for Scripting::Identifier:

[legend]

List of all members.

Public Slots
QString	article (const KEduVocWordFlags &flags)
QString	personalPronoun (const KEduVocWordFlags &flags) const
QStringList	personalPronouns ()
void	setArticle (const QString &article, const KEduVocWordFlags &flags)
void	setPersonalPronoun (const QString &conjugation, const KEduVocWordFlags &flags)
void	setTenses (QStringList names)
QStringList	tenses () const
Public Member Functions
	Identifier (KEduVocIdentifier &identifier)
	Identifier (KEduVocIdentifier *identifier)
	Identifier ()
	~Identifier ()
KEduVocIdentifier *	kEduVocIdentifier ()
QString	locale () const
QString	name () const
void	setLocale (const QString &name)
void	setName (const QString &name)
Properties
QString	locale
QString	name

---

Detailed Description

Identifier class can be accessed from Document class and is used for specifying the document languages, articles and personal pronouns.

    #how to specify the articles and personal pronouns of a language (German in this example)
    import Parley
    newid = Parley.doc.newIdentifier()
    newid.name = "German"
    newid.locale = "de"
    newid.setArticle("der",Parley.Singular|Parley.Definite|Parley.Masculine)
    newid.setArticle("die",Parley.Singular|Parley.Definite|Parley.Feminine)
    newid.setArticle("das",Parley.Singular|Parley.Definite|Parley.Neuter)
    newid.setArticle("ein",Parley.Singular|Parley.Indefinite|Parley.Masculine)
    newid.setArticle("eine",Parley.Singular|Parley.Indefinite|Parley.Feminine)
    newid.setArticle("ein",Parley.Singular|Parley.Indefinite|Parley.Neuter)
    newid.setPersonalPronoun("ich",Parley.Singular|Parley.First)
    newid.setPersonalPronoun("du",Parley.Singular|Parley.Second)
    newid.setPersonalPronoun("er",Parley.Singular|Parley.Third|Parley.Masculine)
    newid.setPersonalPronoun("sie",Parley.Singular|Parley.Third|Parley.Feminine)
    newid.setPersonalPronoun("es",Parley.Singular|Parley.Third|Parley.Neuter)
    newid.setPersonalPronoun("wir",Parley.Plural|Parley.First)
    newid.setPersonalPronoun("ihr",Parley.Plural|Parley.Second)
    newid.setPersonalPronoun("sie",Parley.Plural|Parley.Third)
    index = Parley.doc.appendIdentifier(newid)

Author:

Avgoustinos Kadis <avgoustinos.kadis@kdemail.net>

Definition at line 54 of file identifier.h.

---

Constructor & Destructor Documentation

Scripting::Identifier::Identifier

(

)

Definition at line 24 of file identifier.cpp.

Scripting::Identifier::Identifier

(

KEduVocIdentifier *

identifier

)

Definition at line 30 of file identifier.cpp.

Scripting::Identifier::Identifier

(

KEduVocIdentifier &

identifier

)

Definition at line 35 of file identifier.cpp.

Scripting::Identifier::~Identifier

(

)

Definition at line 42 of file identifier.cpp.

---

Member Function Documentation

QString Scripting::Identifier::article

(

const KEduVocWordFlags &

flags

)

[slot]

Articles (a, the in English, el, la,.

.. in Spanish)

Returns:

articles Returns the article in the given number, definiteness and gender flags: - Number flags: Parley.Singular, Parley.Dual, Parley.Plural

• Definiteness flags: Parley.Definite, Parley.Indefinite
• Gender flags: Parley.Masculine, Parley.Feninine, Parley.Neuter

Parameters:

flags

Flags to indicate which article to return

Returns:

A string containing the requested article. Empty string if does not exist

Definition at line 46 of file identifier.cpp.

KEduVocIdentifier* Scripting::Identifier::kEduVocIdentifier

(

)

[inline]

Definition at line 69 of file identifier.h.

QString Scripting::Identifier::locale

(

)

const [inline]

The locale of the contents: en, de, es, .

..

Returns:

locale

Definition at line 86 of file identifier.h.

QString Scripting::Identifier::name

(

)

const [inline]

Name of this identifier.

(English, Anatomy, Fruit salad...)

Returns:

name

Definition at line 75 of file identifier.h.

QString Scripting::Identifier::personalPronoun

(

const KEduVocWordFlags &

flags

)

const [slot]

Get the personal pronouns for this identifier.

Returns:

a KEduVocPersonalPronoun containing the personal pronouns

Definition at line 59 of file identifier.cpp.

QStringList Scripting::Identifier::personalPronouns

(

)

[slot]

Definition at line 71 of file identifier.cpp.

void Scripting::Identifier::setArticle	(	const QString &	article,
		const KEduVocWordFlags &	flags
	)			[slot]

Sets the article in the given number, definiteness and gender flags:.

• Number flags: Parley.Singular, Parley.Dual, Parley.Plural
• Definiteness flags: Parley.Definite, Parley.Indefinite
• Gender flags: Parley.Masculine, Parley.Feninine, Parley.Neuter

Parameters:

	article	The article to set
	flags	Flags to indicate which article to set

Definition at line 52 of file identifier.cpp.

void Scripting::Identifier::setLocale

(

const QString &

name

)

[inline]

Set the locale.

Parameters:

name

Definition at line 91 of file identifier.h.

void Scripting::Identifier::setName

(

const QString &

name

)

[inline]

Set the name.

Parameters:

name

Definition at line 80 of file identifier.h.

void Scripting::Identifier::setPersonalPronoun	(	const QString &	conjugation,
		const KEduVocWordFlags &	flags
	)			[slot]

Sets personal pronouns.

Parameters:

pronouns

a KEduVocConjugation containing the personal pronouns

Definition at line 64 of file identifier.cpp.

void Scripting::Identifier::setTenses

(

QStringList

names

)

[inline, slot]

Sets the document tenses.

 #how to add new tenses to a language
 import Parley
 for ident in Parley.doc.identifiers():
    T = ident.tenses()
    print T
    T.append("Present Perfect")
    T.append("Past Simple")
    T.append("Past Perfect")
    ident.setTenses(T)
    print ident.tenses()

Parameters:

names

A string list of the document tenses we want to be using

Definition at line 166 of file identifier.h.

QStringList Scripting::Identifier::tenses

(

)

const [inline, slot]

Gets the language tenses (see example in Identifier::setTenses()).

Returns:

A string list of all the language tenses

Definition at line 172 of file identifier.h.

---

Property Documentation

QString Scripting::Identifier::locale [read, write]

Definition at line 58 of file identifier.h.

QString Scripting::Identifier::name [read, write]

Definition at line 57 of file identifier.h.

---

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

• identifier.h
• identifier.cpp