Scripting::Expression Class Reference

This class represents. More...

#include <expression.h>

Inheritance diagram for Scripting::Expression:

[legend]

List of all members.

Public Slots
void	removeTranslation (int index)
void	resetGrades (int index)
void	setTranslation (int index, const QString &expression)
void	setTranslations (QStringList translations)
QObject *	translation (int index) const
QVariantList	translationIndices () const
QVariantList	translations () const
QStringList	translationTexts () const
Public Member Functions
	Expression (KEduVocExpression *expression)
	Expression (const Expression &other)
	Expression (const QStringList &translations)
	Expression (const QString &expression)
	Expression ()
bool	isActive () const
KEduVocExpression *	kEduVocExpression () const
QObject *	lesson () const
void	setActive (bool flag=true)
template<class T , class S >
QVariantList	toVariantList (QList< T * > objList) const
	~Expression ()
Properties
bool	active
QObject	lesson

---

Detailed Description

This class represents.

Author:

Avgoustinos Kadis <avgoustinos.kadis@kdemail.net>

Definition at line 35 of file expression.h.

---

Constructor & Destructor Documentation

Scripting::Expression::Expression

(

)

Definition at line 21 of file expression.cpp.

Scripting::Expression::Expression

(

const QString &

expression

)

Definition at line 26 of file expression.cpp.

Scripting::Expression::Expression

(

const QStringList &

translations

)

Definition at line 31 of file expression.cpp.

Scripting::Expression::Expression

(

const Expression &

other

)

Definition at line 41 of file expression.cpp.

Scripting::Expression::Expression

(

KEduVocExpression *

expression

)

Definition at line 36 of file expression.cpp.

Scripting::Expression::~Expression

(

)

Definition at line 46 of file expression.cpp.

---

Member Function Documentation

bool Scripting::Expression::isActive

(

)

const [inline]

Definition at line 79 of file expression.h.

KEduVocExpression* Scripting::Expression::kEduVocExpression

(

)

const [inline]

Definition at line 70 of file expression.h.

QObject* Scripting::Expression::lesson

(

)

const [inline]

Definition at line 76 of file expression.h.

void Scripting::Expression::removeTranslation

(

int

index

)

[inline, slot]

removes a translation

 #how to remove all the translations of a language from a lesson
 import Parley
 for entry in Parley.activeLesson.entries(True):
     entry.removeTranslation(1)

Parameters:

index

number of translation 1..x

Definition at line 144 of file expression.h.

void Scripting::Expression::resetGrades

(

int

index

)

[inline, slot]

reset all grades of the entry

Parameters:

index

identifier (language)

Definition at line 96 of file expression.h.

void Scripting::Expression::setActive

(

bool

flag = true

)

[inline]

Definition at line 81 of file expression.h.

void Scripting::Expression::setTranslation	(	int	index,
		const QString &	expression
	)			[inline, slot]

Add a translation to this expression.

 #how to set translations of an entry with setTranslation(index,expression)
 import Parley
 lesson = Parley.doc.findLesson("Lesson 2")
 if lesson != None:
     new_entry = lesson.newEntry()
     new_entry.setTranslation(0,"day")
     new_entry.setTranslation(0,"jour")
     lesson.appendEntry(new_entry)

Parameters:

	index	number of translation = the identifier
	expression	the translation

Definition at line 116 of file expression.h.

void Scripting::Expression::setTranslations

(

QStringList

translations

)

[slot]

Sets the translations of an entry.

All previous translations are removed

 #how to set the translations of an entry
 import Parley
 new_entry = Parley.activeLesson.newEntry()
 new_entry.setTranslations(["good morning","bonjour"])
 Parley.activeLesson.appendEntry(new_entry)

Parameters:

translations

A list of strings with the translations (must be in correct language order)

Definition at line 101 of file expression.cpp.

template<class T , class S >

QVariantList Scripting::Expression::toVariantList

(

QList< T * >

objList

)

const [inline]

Definition at line 185 of file expression.h.

QObject * Scripting::Expression::translation

(

int

index

)

const [slot]

Get the translation of a specified index (translation index).

Parameters:

index

of the language identifier

Returns:

A Translation object

Definition at line 107 of file expression.cpp.

QVariantList Scripting::Expression::translationIndices

(

)

const [slot]

Returns a list of integers (the translation indices).

Definition at line 50 of file expression.cpp.

QVariantList Scripting::Expression::translations

(

)

const [slot]

Returns a list of all the translations of an entry.

 #iterate through all the translations of all the entries of the root lesson and print their text
 for entry in Parley.doc.rootLesson.entries(True):
    for tr in entry.translations():
        print tr.text

Returns:

A list of Translation objects

Definition at line 60 of file expression.cpp.

QStringList Scripting::Expression::translationTexts

(

)

const [slot]

Returns a list of all the translations texts of an entry.

 #iterate through all the translations of all the entries of the root lesson and print their text
 for entry in Parley.doc.rootLesson.entries(True):
     print entry.translationTexts()

Returns:

A list of strings (list of translation.text property of every translation)

Definition at line 73 of file expression.cpp.

---

Property Documentation

bool Scripting::Expression::active [read, write]

Specifies if the entry is active or not (enabled for queries or not).

Definition at line 41 of file expression.h.

QObject Scripting::Expression::lesson [read]

Parent lesson (if any).

Definition at line 39 of file expression.h.

---

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

• expression.h
• expression.cpp