Scripting::Text Class Reference

#include <text.h>

Inheritance diagram for Scripting::Text:

Public Slots
void	decGrade ()
void	incBadCount ()
void	incGrade ()
void	incPracticeCount ()
QString	practiceDate () const
QString	practiceDate (const QString &format) const
void	resetGrades ()
void	setPracticeDate (const QString &date)
void	setPracticeDate (const QString &date, const QString &format)

Public Member Functions
	Text (const QString &text=QString())
	Text (KEduVocText *text)
	Text (const KEduVocText &text)
	~Text ()
unsigned int	badCount () const
unsigned int	grade () const
bool	isEmpty ()
KEduVocText *	kEduVocText ()
unsigned int	practiceCount () const
void	setBadCount (unsigned int count)
void	setGrade (unsigned int grade)
void	setPracticeCount (unsigned int count)
void	setText (const QString &expr)
QString	text () const

Protected Attributes
KEduVocText *	m_text

Properties
unsigned int	badCount
unsigned int	grade
bool	isEmpty
unsigned int	practiceCount
QString	text

Detailed Description

Scripting::Text class object provides methods and properties for accessing Parley text's value and grades.

It is inherited and mainly used by Scripting::Translation.

#how to access a translation's object properties/methods
import Parley
for entry in Parley.document.rootLesson.entries(True):
    for translation in entry.translations():
        print translation.text
        print translation.grade
        translation.incBadCount()
        print translation.practiceDate("dd/MM/yyyy")
        translation.grade = 5

Author

Avgoustinos Kadis avgou.nosp@m.stin.nosp@m.os.ka.nosp@m.dis@.nosp@m.kdema.nosp@m.il.n.nosp@m.et

Definition at line 39 of file text.h.

Constructor & Destructor Documentation

Scripting::Text::Text

(

const QString &

text = QString()

)

Definition at line 20 of file text.cpp.

Scripting::Text::Text

(

KEduVocText *

text

)

Definition at line 26 of file text.cpp.

Scripting::Text::Text

(

const KEduVocText &

text

)

Definition at line 31 of file text.cpp.

Scripting::Text::~Text

(

)

Definition at line 37 of file text.cpp.

Member Function Documentation

unsigned int Scripting::Text::badCount ( ) const

inline

Definition at line 122 of file text.h.

void Scripting::Text::decGrade ( )

inlineslot

decrements grade

Definition at line 162 of file text.h.

unsigned int Scripting::Text::grade ( ) const

inline

Definition at line 137 of file text.h.

void Scripting::Text::incBadCount ( )

inlineslot

increment bad query count of given translation by 1

Definition at line 150 of file text.h.

void Scripting::Text::incGrade ( )

inlineslot

increments grade

Definition at line 159 of file text.h.

void Scripting::Text::incPracticeCount ( )

inlineslot

increment query count of given translation by 1

Definition at line 153 of file text.h.

bool Scripting::Text::isEmpty ( )

inline

Definition at line 143 of file text.h.

KEduVocText* Scripting::Text::kEduVocText ( )

inline

Definition at line 81 of file text.h.

unsigned int Scripting::Text::practiceCount ( ) const

inline

Definition at line 112 of file text.h.

QString Scripting::Text::practiceDate ( ) const

inlineslot

returns the last date when this word was practiced

Definition at line 165 of file text.h.

QString Scripting::Text::practiceDate ( const QString &  format ) const

inlineslot

Last date this word was practiced.

Parameters

format

Format of the date (see QDateTime toString(format) function

Returns

the last practice date in the format given by format

print translation.practiceDate("dd/MM/yyyy")
print translation.practiceDate("M-d-yy, h:m:s")

Definition at line 176 of file text.h.

void Scripting::Text::resetGrades ( )

inlineslot

Clears grading and date information.

Definition at line 156 of file text.h.

void Scripting::Text::setBadCount ( unsigned int  count )

inline

Definition at line 127 of file text.h.

void Scripting::Text::setGrade ( unsigned int  grade )

inline

Definition at line 132 of file text.h.

void Scripting::Text::setPracticeCount ( unsigned int  count )

inline

Definition at line 117 of file text.h.

void Scripting::Text::setPracticeDate ( const QString &  date )

inlineslot

Sets the last date when this word was practiced.

Definition at line 179 of file text.h.

void Scripting::Text::setPracticeDate ( const QString &  date, const QString &  format  )

inlineslot

Sets the laast date this word was practiced.

Parameters

date	A string containing the date
format	Format of the date (see QDateTime fromString(date,format) function translation.setPracticeDate("05/12/1999","dd/MM/yyyy") translation.setPracticeDate("02 Jan 05","dd MMM yy")

Definition at line 190 of file text.h.

void Scripting::Text::setText ( const QString &  expr )

inline

Definition at line 93 of file text.h.

QString Scripting::Text::text ( ) const

inline

Definition at line 87 of file text.h.

Member Data Documentation

KEduVocText* Scripting::Text::m_text

protected

Definition at line 193 of file text.h.

Property Documentation

unsigned int Scripting::Text::badCount

readwrite

how many times the word was not found correctly

Definition at line 50 of file text.h.

unsigned int Scripting::Text::grade

read

word grade

Definition at line 53 of file text.h.

bool Scripting::Text::isEmpty

read

true if the word text is empty

Definition at line 59 of file text.h.

unsigned int Scripting::Text::practiceCount

readwrite

how often this entry has been practiced as int

Definition at line 47 of file text.h.

QString Scripting::Text::text

readwrite

The translation as string (the word itself)

Definition at line 44 of file text.h.

---

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

• text.h
• text.cpp