Scripting::Container Class Reference

KEduVocContainer wrapping class for Kross scripts (inherited by Lesson). More...

#include <container.h>

Inheritance diagram for Scripting::Container:

[legend]

List of all members.

Public Slots
double	averageGrade (int translation, bool recursive)
int	expressionsOfGrade (int translation, unsigned int grade, bool recursive)
void	resetGrades (int translation, bool recursive)
int	row () const
Public Member Functions
	Container (KEduVocContainer *container=0)
	~Container ()
void	appendChildContainer (Container *child)
Container *	childContainer (const QString &name)
Container *	childContainer (int row)
int	childContainerCount () const
QVariantList	childContainers ()
KEduVocContainer *	findContainer (const QString &name)
QString	imageUrl ()
bool	inPractice ()
void	insertChildContainer (int row, Container *child)
KEduVocContainer *	kEduVocContainer ()
QString	name ()
void	removeChildContainer (int row)
void	removeTranslation (int translation)
void	setImageUrl (const QString &url)
void	setInPractice (bool inPractice)
void	setName (const QString &name)
template<class T , class S >
QVariantList	toVariantList (QList< T * > objList) const
Static Public Member Functions
static KEduVocContainer::EnumEntriesRecursive	boolToEnum (bool recursive)
static bool	enumToBool (KEduVocContainer::EnumEntriesRecursive recursive)
static QList< KEduVocContainer * >	flattenContainer (KEduVocContainer *root)
Protected Attributes
KEduVocContainer *	m_container
Properties
QString	imageUrl
bool	inPractice
QString	name

---

Detailed Description

KEduVocContainer wrapping class for Kross scripts (inherited by Lesson).

This class should not be used directly by a script but through Lesson class which inherits all the Container's properties. See Lesson class documentation.

Author:

Avgoustinos Kadis <avgoustinos.kadis@kdemail.net>

Definition at line 34 of file container.h.

---

Constructor & Destructor Documentation

Scripting::Container::Container

(

KEduVocContainer *

container = 0

)

Definition at line 20 of file container.cpp.

Scripting::Container::~Container

(

)

Definition at line 39 of file container.cpp.

---

Member Function Documentation

void Scripting::Container::appendChildContainer

(

Container *

child

)

[inline]

Definition at line 83 of file container.h.

double Scripting::Container::averageGrade	(	int	translation,
		bool	recursive
	)			[inline, slot]

Returns the average grade of the specified translation considering all the lesson entries.

Parameters:

translation

language index

Returns:

A double, the average lesson grade

Definition at line 166 of file container.h.

KEduVocContainer::EnumEntriesRecursive Scripting::Container::boolToEnum

(

bool

recursive

)

[static]

Definition at line 50 of file container.cpp.

Container* Scripting::Container::childContainer

(

const QString &

name

)

[inline]

Definition at line 95 of file container.h.

Container* Scripting::Container::childContainer

(

int

row

)

[inline]

Definition at line 87 of file container.h.

int Scripting::Container::childContainerCount

(

)

const [inline]

Definition at line 97 of file container.h.

QVariantList Scripting::Container::childContainers

(

)

Definition at line 57 of file container.cpp.

bool Scripting::Container::enumToBool

(

KEduVocContainer::EnumEntriesRecursive

recursive

)

[static]

Definition at line 43 of file container.cpp.

int Scripting::Container::expressionsOfGrade	(	int	translation,
		unsigned int	grade,
		bool	recursive
	)			[inline, slot]

Returns how many expressions of language with index translation have grade as grade.

Parameters:

	translation	language index
	grade	grade

Returns:

A number that represents the number of expressions of that grade

Definition at line 152 of file container.h.

KEduVocContainer * Scripting::Container::findContainer

(

const QString &

name

)

Definition at line 74 of file container.cpp.

QList< KEduVocContainer * > Scripting::Container::flattenContainer

(

KEduVocContainer *

root

)

[static]

Definition at line 62 of file container.cpp.

QString Scripting::Container::imageUrl

(

)

[inline]

Definition at line 103 of file container.h.

bool Scripting::Container::inPractice

(

)

[inline]

Definition at line 99 of file container.h.

void Scripting::Container::insertChildContainer	(	int	row,
		Container *	child
	)			[inline]

Definition at line 84 of file container.h.

KEduVocContainer* Scripting::Container::kEduVocContainer

(

)

[inline]

Definition at line 70 of file container.h.

QString Scripting::Container::name

(

)

[inline]

Definition at line 81 of file container.h.

void Scripting::Container::removeChildContainer

(

int

row

)

[inline]

Definition at line 86 of file container.h.

void Scripting::Container::removeTranslation

(

int

translation

)

[inline]

Definition at line 117 of file container.h.

void Scripting::Container::resetGrades	(	int	translation,
		bool	recursive
	)			[inline, slot]

Remove grades from all entries of this lessons.

Parameters:

	translation	which translation to remove. -1 for all.
	recursive	whether to include child lessons

Definition at line 159 of file container.h.

int Scripting::Container::row

(

)

const [inline, slot]

Returns an integer, the Container's unique row.

Useful for Lesson::removeChildLesson() function

Definition at line 129 of file container.h.

void Scripting::Container::setImageUrl

(

const QString &

url

)

[inline]

Definition at line 108 of file container.h.

void Scripting::Container::setInPractice

(

bool

inPractice

)

[inline]

Definition at line 100 of file container.h.

void Scripting::Container::setName

(

const QString &

name

)

[inline]

Definition at line 78 of file container.h.

template<class T , class S >

QVariantList Scripting::Container::toVariantList

(

QList< T * >

objList

)

const [inline]

Definition at line 174 of file container.h.

---

Member Data Documentation

KEduVocContainer* Scripting::Container::m_container [protected]

Definition at line 169 of file container.h.

---

Property Documentation

QString Scripting::Container::imageUrl [read, write]

Container image URL.

Definition at line 42 of file container.h.

bool Scripting::Container::inPractice [read, write]

Boolean value if lesson is in Practice or not.

Definition at line 40 of file container.h.

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

Container name.

Definition at line 38 of file container.h.

---

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

• container.h
• container.cpp