KEduVocContainer Class Reference

#include <keduvoccontainer.h>

Inheritance diagram for KEduVocContainer:

Public Types
enum	EnumContainerType { Container, Lesson, WordType, Leitner }
enum	EnumEntriesRecursive { NotRecursive = 0, Recursive = 1 }

Public Member Functions
	KEduVocContainer (const QString &name, EnumContainerType type, KEduVocContainer *parent=0)
	KEduVocContainer (const KEduVocContainer &other)
virtual	~KEduVocContainer ()
void	appendChildContainer (KEduVocContainer *child)
double	averageGrade (int translation, EnumEntriesRecursive recursive)
KEduVocContainer *	childContainer (int row)
KEduVocContainer *	childContainer (const QString &name)
int	childContainerCount () const
QList< KEduVocContainer * >	childContainers ()
KEduVocContainer::EnumContainerType	containerType ()
void	deleteChildContainer (int row)
virtual QList < KEduVocExpression * >	entries (EnumEntriesRecursive recursive=NotRecursive)=0
virtual KEduVocExpression *	entry (int row, EnumEntriesRecursive recursive=NotRecursive)=0
virtual int	entryCount (EnumEntriesRecursive recursive=NotRecursive)=0
int	expressionsOfGrade (int translation, grade_t grade, EnumEntriesRecursive recursive)
KUrl	imageUrl ()
bool	inPractice ()
void	insertChildContainer (int row, KEduVocContainer *child)
QString	name ()
KEduVocContainer &	operator= (const KEduVocContainer &)
bool	operator== (const KEduVocContainer &other)
virtual KEduVocContainer *	parent ()
void	removeChildContainer (int row)
void	removeTranslation (int translation)
void	resetGrades (int translation, EnumEntriesRecursive recursive)
int	row () const
void	setContainerType (KEduVocContainer::EnumContainerType type)
void	setImageUrl (const KUrl &url)
void	setInPractice (bool inPractice)
void	setName (const QString &name)

Protected Member Functions
QList< KEduVocExpression * >	entriesRecursive ()
void	invalidateChildLessonEntries ()
void	updateChildLessonEntries ()

Detailed Description

class to store information about a container - that can be a lesson or word types

Definition at line 30 of file keduvoccontainer.h.

Member Enumeration Documentation

enum KEduVocContainer::EnumContainerType

Enumerator
Container
Lesson
WordType
Leitner

Definition at line 35 of file keduvoccontainer.h.

enum KEduVocContainer::EnumEntriesRecursive

Enumerator
NotRecursive
Recursive

Definition at line 42 of file keduvoccontainer.h.

Constructor & Destructor Documentation

KEduVocContainer::KEduVocContainer ( const QString &  name, EnumContainerType  type, KEduVocContainer *  parent = 0  )

explicit

default constructor

Definition at line 52 of file keduvoccontainer.cpp.

KEduVocContainer::KEduVocContainer

(

const KEduVocContainer &

other

)

copy constructor for d-pointer safe copying

Definition at line 62 of file keduvoccontainer.cpp.

KEduVocContainer::~KEduVocContainer ( )

virtual

destructor

Definition at line 72 of file keduvoccontainer.cpp.

Member Function Documentation

void KEduVocContainer::appendChildContainer

(

KEduVocContainer *

child

)

Definition at line 77 of file keduvoccontainer.cpp.

double KEduVocContainer::averageGrade	(	int	translation,
		EnumEntriesRecursive	recursive
	)

Definition at line 250 of file keduvoccontainer.cpp.

KEduVocContainer * KEduVocContainer::childContainer

(

int

row

)

Definition at line 85 of file keduvoccontainer.cpp.

KEduVocContainer * KEduVocContainer::childContainer

(

const QString &

name

)

Retrieve a child container by its name Returns 0 if no container is found.

Parameters

name	container name

Returns

the child container

Definition at line 91 of file keduvoccontainer.cpp.

int KEduVocContainer::childContainerCount

(

)

const

Find a child container.

Parameters

name

Returns

Definition at line 122 of file keduvoccontainer.cpp.

QList< KEduVocContainer * > KEduVocContainer::childContainers

(

)

Definition at line 190 of file keduvoccontainer.cpp.

KEduVocContainer::EnumContainerType KEduVocContainer::containerType

(

)

The type of this container.

See also

EnumContainerType

Returns

Definition at line 205 of file keduvoccontainer.cpp.

void KEduVocContainer::deleteChildContainer

(

int

row

)

Definition at line 107 of file keduvoccontainer.cpp.

virtual QList< KEduVocExpression* > KEduVocContainer::entries ( EnumEntriesRecursive  recursive = NotRecursive )

pure virtual

get a list of all entries in the container

Implemented in KEduVocWordType, KEduVocLesson, and KEduVocLeitnerBox.

QList< KEduVocExpression * > KEduVocContainer::entriesRecursive ( )

protected

Definition at line 182 of file keduvoccontainer.cpp.

virtual KEduVocExpression* KEduVocContainer::entry ( int  row, EnumEntriesRecursive  recursive = NotRecursive  )

pure virtual

Implemented in KEduVocWordType, KEduVocLeitnerBox, and KEduVocLesson.

virtual int KEduVocContainer::entryCount ( EnumEntriesRecursive  recursive = NotRecursive )

pure virtual

Implemented in KEduVocWordType, KEduVocLesson, and KEduVocLeitnerBox.

int KEduVocContainer::expressionsOfGrade	(	int	translation,
		grade_t	grade,
		EnumEntriesRecursive	recursive
	)

Definition at line 261 of file keduvoccontainer.cpp.

KUrl KEduVocContainer::imageUrl

(

)

get the image url for this container if it exists

Definition at line 211 of file keduvoccontainer.cpp.

bool KEduVocContainer::inPractice

(

)

Definition at line 161 of file keduvoccontainer.cpp.

void KEduVocContainer::insertChildContainer	(	int	row,
		KEduVocContainer *	child
	)

Definition at line 221 of file keduvoccontainer.cpp.

void KEduVocContainer::invalidateChildLessonEntries ( )

protected

Set the child entry cache to invalid.

Definition at line 241 of file keduvoccontainer.cpp.

QString KEduVocContainer::name

(

)

get the container name

Definition at line 156 of file keduvoccontainer.cpp.

KEduVocContainer & KEduVocContainer::operator=

(

const KEduVocContainer &

other

)

assignment operator

Definition at line 136 of file keduvoccontainer.cpp.

bool KEduVocContainer::operator==

(

const KEduVocContainer &

other

)

equality operator

Todo:

make this return something useful

Definition at line 143 of file keduvoccontainer.cpp.

KEduVocContainer * KEduVocContainer::parent ( )

virtual

Definition at line 195 of file keduvoccontainer.cpp.

void KEduVocContainer::removeChildContainer

(

int

row

)

Definition at line 115 of file keduvoccontainer.cpp.

void KEduVocContainer::removeTranslation

(

int

translation

)

Removes a translation.

This has to be called when a language is removed from a document.

Parameters

translation

Definition at line 171 of file keduvoccontainer.cpp.

void KEduVocContainer::resetGrades	(	int	translation,
		EnumEntriesRecursive	recursive
	)

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 272 of file keduvoccontainer.cpp.

int KEduVocContainer::row

(

)

const

Definition at line 127 of file keduvoccontainer.cpp.

void KEduVocContainer::setContainerType

(

KEduVocContainer::EnumContainerType

type

)

Set the type of container.

For convenience by default this is taken over from the parent, so no need to set.

Parameters

type	the new type

Definition at line 200 of file keduvoccontainer.cpp.

void KEduVocContainer::setImageUrl

(

const KUrl &

url

)

set the image url for this container

Parameters

url	url of the image

Definition at line 216 of file keduvoccontainer.cpp.

void KEduVocContainer::setInPractice

(

bool

inPractice

)

Definition at line 166 of file keduvoccontainer.cpp.

void KEduVocContainer::setName

(

const QString &

name

)

set the container name

Parameters

name	text to set for the name

Definition at line 151 of file keduvoccontainer.cpp.

void KEduVocContainer::updateChildLessonEntries ( )

protected

Recreate the cache of entries in this lesson's child lessons.

Definition at line 229 of file keduvoccontainer.cpp.

---

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

• keduvoccontainer.h
• keduvoccontainer.cpp