dictfile.h

Go to the documentation of this file.

/*****************************************************************************
 * This file is part of Kiten, a KDE Japanese Reference Tool                 *
 * Copyright (C) 2006 Joseph Kerian <jkerian@gmail.com>                      *
 *                                                                           *
 * This library is free software; you can redistribute it and/or             *
 * modify it under the terms of the GNU Library General Public               *
 * License as published by the Free Software Foundation; either              *
 * version 2 of the License, or (at your option) any later version.          *
 *                                                                           *
 * This library is distributed in the hope that it will be useful,           *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of            *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
 * Library General Public License for more details.                          *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public License *
 * along with this library; see the file COPYING.LIB.  If not, write to      *
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,      *
 * Boston, MA 02110-1301, USA.                                               *
 *****************************************************************************/

#ifndef KITEN_DICTFILE_H
#define KITEN_DICTFILE_H

#include "libkitenexport.h"

#include <QMap>
#include <QString>

class DictQuery;
class DictionaryPreferenceDialog;
class Entry;
class EntryList;
class KConfig;
class KConfigSkeleton;
class QStringList;
class QWidget;

class /* NO_EXPORT */ DictFile
{
  private:
    DictFile() {}
  public:
    DictFile( const QString& dictionaryTypeName ) : m_dictionaryType( dictionaryTypeName ) {}
    virtual ~DictFile() {}
    virtual bool validDictionaryFile( const QString &filename ) = 0;
    virtual bool validQuery( const DictQuery &query ) = 0;
    virtual EntryList *doSearch( const DictQuery &query ) = 0;
    virtual bool loadDictionary( const QString &file, const QString &name ) = 0;
    virtual bool loadNewDictionary( const QString &file, const QString &name )
            { return loadDictionary( file, name ); }
    virtual QStringList listDictDisplayOptions( QStringList ) const = 0 ;
    virtual DictionaryPreferenceDialog *preferencesWidget( KConfigSkeleton *config, QWidget *parent = NULL )
                            { Q_UNUSED( parent ); Q_UNUSED( config ); return NULL; }
    virtual void loadSettings( KConfigSkeleton* ) {}

    virtual QString getName() const { return m_dictionaryName; }
    virtual QString getType() const { return m_dictionaryType; }
    virtual QString getFile() const { return m_dictionaryFile; }
    virtual const QMap<QString,QString> &getSearchableAttributes() const
                                      { return m_searchableAttributes; }
  protected:
    QString m_dictionaryName;

    QString m_dictionaryFile;

    QString m_dictionaryType;
    QMap<QString,QString> m_searchableAttributes;
};

#endif