dictionarymanager.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>                      *
 * Copyright (C) 2011 Daniel E. Moctezuma <democtezuma@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_DICTIONARYMANAGER_H
#define KITEN_DICTIONARYMANAGER_H

#include "libkitenexport.h"

#include <QMap>
#include <QPair>

class DictFile;
class DictQuery;
class DictionaryPreferenceDialog;
class EntryList;
class KConfig;
class KConfigSkeleton;
class QString;
class QStringList;
class QWidget;

class KITEN_EXPORT DictionaryManager
{
  public:
    DictionaryManager();
    virtual ~DictionaryManager();

    bool addDictionary( const QString &file, const QString &name, const QString &type );
    void removeAllDictionaries();
    bool removeDictionary( const QString &name );
    QStringList listDictionaries() const;
    QPair<QString, QString> listDictionaryInfo( const QString &name ) const;
    QStringList listDictionariesOfType( const QString &type ) const;
    EntryList *doSearch( const DictQuery &query ) const;
    EntryList *doSearchInList( const DictQuery &query, const EntryList *list ) const;
    static QStringList listDictFileTypes();
    static QMap<QString,DictionaryPreferenceDialog*>
            generatePreferenceDialogs( KConfigSkeleton *config, QWidget *parent = NULL );
    static QMap<QString,QString> generateExtendedFieldsList();
    void loadDictSettings( const QString &dict, KConfigSkeleton *config );
    void loadSettings( const KConfig &config );

  private:
    static DictFile *makeDictFile( const QString &type );
    class Private;
    Private* const d;
};

#endif