entry.h

Go to the documentation of this file.

/*****************************************************************************
 * This file is part of Kiten, a KDE Japanese Reference Tool                 *
 * Copyright (C) 2001 Jason Katz-Brown <jason@katzbrown.com>                 *
 * Copyright (C) 2006 Joseph Kerian <jkerian@gmail.com>                      *
 * Copyright (C) 2006 Eric Kjeldergaard <kjelderg@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_ENTRY_H
#define KITEN_ENTRY_H

#include <QHash>
#include <QList>
#include <QStringList>

#include "libkitenexport.h"

#include "dictquery.h"

class Entry;
class EntryList;
class QString;

class KITEN_EXPORT Entry
{
  friend class EntryListModel;

  private:
    Entry();

  protected:
    Entry( const Entry& );
    Entry( const QString &sourceDictionary );
    Entry( const QString &sourceDictionary, const QString &word,
           const QStringList &readings, const QStringList &meanings );

  public:
    virtual ~Entry();
    virtual Entry *clone() const = 0;

    virtual bool matchesQuery( const DictQuery& ) const;

    const QString &getDictName() const;
    virtual QString getDictionaryType() const = 0;
    QString getWord() const;
    QString getMeanings() const;
    QStringList getMeaningsList() const;
    QString getReadings() const;
    QStringList getReadingsList() const;
    const QHash<QString,QString> &getExtendedInfo() const;
    QString getExtendedInfoItem( const QString &x ) const;
    virtual bool extendedItemCheck( const QString &key, const QString &value ) const;

    virtual QString toHTML() const;
    virtual QString toKVTML() const;
    virtual QString toString() const;

    virtual bool loadEntry( const QString& ) = 0;
    virtual QString dumpEntry() const = 0;

    virtual bool sort( const Entry &that, const QStringList &dictionaryList,
                       const QStringList &fieldList ) const;
    virtual bool sortByField( const Entry &that, const QString &field ) const;

  protected:
    QString Word;
    QStringList Meanings;
    QStringList Readings;
    QHash<QString,QString> ExtendedInfo;

    QString sourceDict;
    QString outputListDelimiter;

    void init();

    virtual QString makeLink( const QString &entryString ) const;
    virtual QString HTMLWord() const;
    virtual QString HTMLReadings() const;
    virtual QString HTMLMeanings() const;

    bool listMatch( const QStringList &list, const QStringList &test, DictQuery::MatchType type ) const;
    bool isKanji( const QChar &character ) const;
};

#endif