DictFileKanjidic Class Reference

#include <dictfilekanjidic.h>

Inheritance diagram for DictFileKanjidic:

Public Member Functions
	DictFileKanjidic ()
virtual	~DictFileKanjidic ()
QMap< QString, QString >	displayOptions () const
virtual EntryList *	doSearch (const DictQuery &query)
QStringList	dumpDictionary ()
virtual QStringList	listDictDisplayOptions (QStringList list) const
bool	loadDictionary (const QString &file, const QString &name)
QStringList *	loadListType (KConfigSkeletonItem *item, QStringList *list, const QMap< QString, QString > &long2short)
void	loadSettings ()
virtual void	loadSettings (KConfigSkeleton *item)
bool	validDictionaryFile (const QString &filename)
bool	validQuery (const DictQuery &query)
Public Member Functions inherited from DictFile
	DictFile (const QString &dictionaryTypeName)
virtual	~DictFile ()
virtual QString	getFile () const
virtual QString	getName () const
virtual const QMap< QString, QString > &	getSearchableAttributes () const
virtual QString	getType () const
virtual bool	loadNewDictionary (const QString &file, const QString &name)
virtual DictionaryPreferenceDialog *	preferencesWidget (KConfigSkeleton *config, QWidget *parent=NULL)

Protected Member Functions
virtual Entry *	makeEntry (const QString &entry)

Static Protected Attributes
static QStringList *	displayFields = NULL

Additional Inherited Members
Protected Attributes inherited from DictFile
QString	m_dictionaryFile
QString	m_dictionaryName
QString	m_dictionaryType
QMap< QString, QString >	m_searchableAttributes

Detailed Description

Definition at line 39 of file dictfilekanjidic.h.

Constructor & Destructor Documentation

DictFileKanjidic::DictFileKanjidic

(

)

Definition at line 40 of file dictfilekanjidic.cpp.

DictFileKanjidic::~DictFileKanjidic ( )

virtual

Definition at line 69 of file dictfilekanjidic.cpp.

Member Function Documentation

QMap< QString, QString > DictFileKanjidic::displayOptions

(

)

const

Definition at line 73 of file dictfilekanjidic.cpp.

EntryList * DictFileKanjidic::doSearch ( const DictQuery &  query )

virtual

This actually conducts the search on the given query.

This is usually most of the work

Parameters

query

the DictQuery that specifies what results to return

Implements DictFile.

Definition at line 104 of file dictfilekanjidic.cpp.

QStringList DictFileKanjidic::dumpDictionary

(

)

Definition at line 148 of file dictfilekanjidic.cpp.

QStringList DictFileKanjidic::listDictDisplayOptions ( QStringList  ) const

virtual

Return a list of the fields that can be displayed, note the following should probably always be retured: –NewLine–, Word/Kanji, Meaning, Reading.

This function is passed a list originally containing those four items. This function is used to enumerate possible types the user chooses to have displayed in the preferences dialog box. This will often be a very similer list to getSearchableAttributes(), but due to optional forms of spelling and other situations, it may not be exactly the same. Note: The "Dictionary" option will be appended to your list at the end.

Implements DictFile.

Definition at line 158 of file dictfilekanjidic.cpp.

bool DictFileKanjidic::loadDictionary ( const QString &  file, const QString &  name  )

virtual

Load a dictionary as at system startup.

Parameters

file	the file to open, in a format suitable for use with QFile::setFileName()
name	the name of the file to open, used in various user-interface aspects. It may be related to the file parameter, but perhaps not.

Implements DictFile.

Definition at line 164 of file dictfilekanjidic.cpp.

QStringList * DictFileKanjidic::loadListType	(	KConfigSkeletonItem *	item,
		QStringList *	list,
		const QMap< QString, QString > &	long2short
	)

Definition at line 216 of file dictfilekanjidic.cpp.

void DictFileKanjidic::loadSettings

(

)

Definition at line 244 of file dictfilekanjidic.cpp.

void DictFileKanjidic::loadSettings ( KConfigSkeleton *  )

virtual

Load information from the KConfigSkeleton that you've setup in the above preferences widget.

Reimplemented from DictFile.

Definition at line 249 of file dictfilekanjidic.cpp.

Entry * DictFileKanjidic::makeEntry ( const QString &  entry )

inlineprotectedvirtual

Definition at line 255 of file dictfilekanjidic.cpp.

bool DictFileKanjidic::validDictionaryFile ( const QString &  filename )

virtual

Scan a potential file for the correct format, remembering to skip comment characters.

This is not a foolproof scan, but it should be checked before adding a new dictionary.

Implements DictFile.

Definition at line 265 of file dictfilekanjidic.cpp.

bool DictFileKanjidic::validQuery ( const DictQuery &  query )

virtual

Reject queries that specify anything we don't understand.

Implements DictFile.

Definition at line 302 of file dictfilekanjidic.cpp.

Member Data Documentation

QStringList * DictFileKanjidic::displayFields = NULL

staticprotected

Definition at line 64 of file dictfilekanjidic.h.

---

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

• dictfilekanjidic.h
• dictfilekanjidic.cpp