KanagramGame Class Reference

#include <kanagramgame.h>

Inheritance diagram for KanagramGame:

Public Slots
void	loadDefaultVocabulary ()
void	nextAnagram ()
void	nextVocabulary ()
void	previousVocabulary ()
bool	refreshVocabularyList ()
void	restoreWord ()
void	setCurrentCategory (int index)
void	useVocabulary (const QString &vocabularyname)
void	useVocabulary (int index)

Signals
void	dataLanguageChanged ()
void	fileError (const QString &filename)

Public Member Functions
	KanagramGame ()
	~KanagramGame ()
QString	anagram () const
Q_INVOKABLE int	currentCategory () const
Q_INVOKABLE QString	dataLanguage () const
Q_INVOKABLE int	dataLanguageSelectedIndex () const
QString	documentTitle () const
QString	filename () const
Q_INVOKABLE QString	hint () const
Q_INVOKABLE QStringList	languageNames ()
KUrl	picHint ()
QString	sanitizedDataLanguage () const
Q_INVOKABLE void	setDataLanguage (const QString &dataLanguage)
Q_INVOKABLE QStringList	vocabularyList () const
QString	word () const

Properties
QString	dataLanguage

Detailed Description

game api

Author

Joshua Keel joshu.nosp@m.akee.nosp@m.l@gma.nosp@m.il.c.nosp@m.om

Jeremy Whiting jpwhi.nosp@m.ting.nosp@m.@kde..nosp@m.org

Definition at line 41 of file kanagramgame.h.

Constructor & Destructor Documentation

KanagramGame::KanagramGame

(

)

Default constructor.

Definition at line 42 of file kanagramgame.cpp.

KanagramGame::~KanagramGame

(

)

Default destructor.

Definition at line 51 of file kanagramgame.cpp.

Member Function Documentation

QString KanagramGame::anagram

(

)

const

Get the anagram to show.

Definition at line 232 of file kanagramgame.cpp.

int KanagramGame::currentCategory

(

)

const

Get the index of the current category in the list.

Definition at line 331 of file kanagramgame.cpp.

Q_INVOKABLE QString KanagramGame::dataLanguage

(

)

const

Get the data language for the kvtml and other strings.

void KanagramGame::dataLanguageChanged ( )

signal

Signal the ui that the data language has changed.

int KanagramGame::dataLanguageSelectedIndex

(

)

const

Get the selected index of the data language in the language list.

Definition at line 323 of file kanagramgame.cpp.

QString KanagramGame::documentTitle

(

)

const

Get the current vocabulary file's title.

Definition at line 271 of file kanagramgame.cpp.

void KanagramGame::fileError ( const QString &  filename )

signal

Signal the ui that a there's a file error of some kind.

QString KanagramGame::filename

(

)

const

Get the current vocabulary file's filename.

Definition at line 227 of file kanagramgame.cpp.

QString KanagramGame::hint

(

)

const

Get this anagram's hint.

Definition at line 237 of file kanagramgame.cpp.

QStringList KanagramGame::languageNames

(

)

Return the language names found available in the system.

Definition at line 281 of file kanagramgame.cpp.

void KanagramGame::loadDefaultVocabulary ( )

slot

Load the default vocabulary file.

Todo:

open returns KEduVocDocument::ErrorCode

Definition at line 85 of file kanagramgame.cpp.

void KanagramGame::nextAnagram ( )

slot

Set the index to the next word.

Definition at line 181 of file kanagramgame.cpp.

void KanagramGame::nextVocabulary ( )

slot

Use the next vocabulary file in the list.

Todo:

open returns KEduVocDocument::ErrorCode

Definition at line 162 of file kanagramgame.cpp.

KUrl KanagramGame::picHint

(

)

Get this anagram's picture hint URL.

Definition at line 346 of file kanagramgame.cpp.

void KanagramGame::previousVocabulary ( )

slot

Use the previous vocabulary file in the list.

Todo:

open returns KEduVocDocument::ErrorCode

Definition at line 146 of file kanagramgame.cpp.

bool KanagramGame::refreshVocabularyList ( )

slot

Refresh the list of vocabulary files available from what we find on disk.

Returns

true if the current vocabulary has changed so the ui can refresh

Definition at line 105 of file kanagramgame.cpp.

void KanagramGame::restoreWord ( )

slot

Restore the word, set the anagram to the answer.

Definition at line 247 of file kanagramgame.cpp.

QString KanagramGame::sanitizedDataLanguage

(

)

const

Get the sanitized data language used.

Definition at line 68 of file kanagramgame.cpp.

void KanagramGame::setCurrentCategory ( int  index )

slot

Set the index of the current category in the list as the current active one.

Definition at line 336 of file kanagramgame.cpp.

void KanagramGame::setDataLanguage

(

const QString &

dataLanguage

)

Set the data language for the kvtml and other strings.

Definition at line 317 of file kanagramgame.cpp.

void KanagramGame::useVocabulary ( const QString &  vocabularyname )

slot

Set the vocabulary to use according to the vocabulary name.

Definition at line 120 of file kanagramgame.cpp.

void KanagramGame::useVocabulary ( int  index )

slot

Set the vocabulary to use according to the desired index value.

Todo:

open returns KEduVocDocument::ErrorCode

Definition at line 125 of file kanagramgame.cpp.

QStringList KanagramGame::vocabularyList

(

)

const

Get the list of vocabularies.

Definition at line 115 of file kanagramgame.cpp.

QString KanagramGame::word

(

)

const

Get this anagram's answer.

Definition at line 242 of file kanagramgame.cpp.

Property Documentation

QString KanagramGame::dataLanguage

readwrite

Definition at line 44 of file kanagramgame.h.

---

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

• kanagramgame.h
• kanagramgame.cpp