KDE 4.2 API Reference kiten/lib
dictFileEdict Class Reference
#include <dictFileEdict.h>
Detailed Description
Definition at line 46 of file dictFileEdict.h.
Public Member Functions | |
| dictFileEdict () | |
| virtual EntryList * | doSearch (const DictQuery &query) |
| virtual QStringList | listDictDisplayOptions (QStringList) const |
| bool | loadDictionary (const QString &file, const QString &name) |
| virtual void | loadSettings (KConfigSkeleton *) |
| virtual DictionaryPreferenceDialog * | preferencesWidget (KConfigSkeleton *, QWidget *parent=NULL) |
| virtual bool | validDictionaryFile (const QString &filename) |
| bool | validQuery (const DictQuery &query) |
| virtual | ~dictFileEdict () |
Protected Member Functions | |
| virtual QMap< QString, QString > | displayOptions () const |
| QStringList * | loadListType (KConfigSkeletonItem *, QStringList *, const QMap< QString, QString > &) |
| virtual Entry * | makeEntry (QString x) |
Protected Attributes | |
| linearEDICTFile | m_file |
Static Protected Attributes | |
| static QStringList * | displayFields = NULL |
Constructor & Destructor Documentation
| dictFileEdict::dictFileEdict | ( | ) |
Definition at line 47 of file dictFileEdict.cpp.
| dictFileEdict::~dictFileEdict | ( | ) | [virtual] |
Definition at line 56 of file dictFileEdict.cpp.
Member Function Documentation
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 122 of file dictFileEdict.cpp.
| QStringList dictFileEdict::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 166 of file dictFileEdict.cpp.
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 106 of file dictFileEdict.cpp.
| QStringList * dictFileEdict::loadListType | ( | KConfigSkeletonItem * | item, | |
| QStringList * | list, | |||
| const QMap< QString, QString > & | long2short | |||
| ) | [protected] |
Definition at line 197 of file dictFileEdict.cpp.
| void dictFileEdict::loadSettings | ( | KConfigSkeleton * | ) | [virtual] |
Load information from the KConfigSkeleton that you've setup in the above preferences widget.
Reimplemented from dictFile.
Reimplemented in dictFileKanjidic.
Definition at line 185 of file dictFileEdict.cpp.
| DictionaryPreferenceDialog * dictFileEdict::preferencesWidget | ( | KConfigSkeleton * | config, | |
| QWidget * | parent = NULL | |||
| ) | [virtual] |
If you want your own dialog to pick preferences for your dict, then override this.
Leaving it blank will leave your dictionary type without a preferences dialog.
- Parameters:
-
config the KConfigSkeleton object that is currently in use parent the parent widget for your preferences dialog.
Reimplemented from dictFile.
Definition at line 178 of file dictFileEdict.cpp.
| bool dictFileEdict::validDictionaryFile | ( | const QString & | filename | ) | [virtual] |
This method allows the user to test if a dictionary is the proper type for this format.
This process is allowed to take some time, but nonetheless you should find checking the format of a few hundred entries sufficient for this.
- Parameters:
-
filename the name of the file, suitable for using with QFile::setFileName()
Implements dictFile.
Reimplemented in dictFileKanjidic.
Definition at line 66 of file dictFileEdict.cpp.
| bool dictFileEdict::validQuery | ( | const DictQuery & | query | ) | [virtual] |
Is this query relevant to this dictionary type? Usually this will return true, unless the query specifies extended attributes that the dictionary does not provide.
- Parameters:
-
query the query to examine for relevence to this dictionary type
Implements dictFile.
Reimplemented in dictFileKanjidic.
Definition at line 101 of file dictFileEdict.cpp.
Member Data Documentation
QStringList * dictFileEdict::displayFields = NULL [static, protected] |
linearEDICTFile dictFileEdict::m_file [protected] |
Definition at line 70 of file dictFileEdict.h.
The documentation for this class was generated from the following files:
