runtime/khelpcenter/glossary.h

   1 /*
   2  *  glossary.h - part of the KDE Help Center
   3  *
   4  *  Copyright (C) 2002 Frerich Raabe (raabe@kde.org)
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 #ifndef KHC_GLOSSARY_H
  21 #define KHC_GLOSSARY_H
  22
  23 #include <k3listview.h>
  24
  25 #include <QDomElement>
  26 #include <QList>
  27 #include <ksharedconfig.h>
  28 #include <QHash>
  29 #include <KProcess>
  30
  31 class EntryItem;
  32
  33 namespace KHC {
  34
  35 class GlossaryEntryXRef
  36 {
  37     friend QDataStream &operator>>( QDataStream &, GlossaryEntryXRef & );
  38     public:
  39         typedef QList<GlossaryEntryXRef> List;
  40
  41         GlossaryEntryXRef() {}
  42         GlossaryEntryXRef( const QString &term, const QString &id ) :
  43             m_term( term ),
  44             m_id( id )
  45         {
  46         }
  47
  48         QString term() const { return m_term; }
  49         QString id() const { return m_id; }
  50
  51     private:
  52         QString m_term;
  53         QString m_id;
  54 };
  55
  56 inline QDataStream &operator<<( QDataStream &stream, const GlossaryEntryXRef &e )
  57 {
  58     return stream << e.term() << e.id();
  59 }
  60
  61 inline QDataStream &operator>>( QDataStream &stream, GlossaryEntryXRef &e )
  62 {
  63     return stream >> e.m_term >> e.m_id;
  64 }
  65
  66 class GlossaryEntry
  67 {
  68     friend QDataStream &operator>>( QDataStream &, GlossaryEntry & );
  69     public:
  70         GlossaryEntry() {}
  71         GlossaryEntry( const QString &term, const QString &definition,
  72                 const GlossaryEntryXRef::List &seeAlso ) :
  73             m_term( term ),
  74             m_definition( definition ),
  75             m_seeAlso( seeAlso )
  76             {
  77             }
  78
  79         QString term() const { return m_term; }
  80         QString definition() const { return m_definition; }
  81         GlossaryEntryXRef::List seeAlso() const { return m_seeAlso; }
  82
  83     private:
  84         QString m_term;
  85         QString m_definition;
  86         GlossaryEntryXRef::List m_seeAlso;
  87 };
  88
  89 inline QDataStream &operator<<( QDataStream &stream, const GlossaryEntry &e )
  90 {
  91     return stream << e.term() << e.definition() << e.seeAlso();
  92 }
  93
  94 inline QDataStream &operator>>( QDataStream &stream, GlossaryEntry &e )
  95 {
  96     return stream >> e.m_term >> e.m_definition >> e.m_seeAlso;
  97 }
  98
  99 class Glossary : public K3ListView
 100 {
 101     Q_OBJECT
 102     public:
 103         Glossary( QWidget *parent );
 104         virtual ~Glossary();
 105
 106         const GlossaryEntry &entry( const QString &id ) const;
 107
 108     static QString entryToHtml( const GlossaryEntry &entry );
 109
 110     public Q_SLOTS:
 111         void slotSelectGlossEntry( const QString &id );
 112
 113     Q_SIGNALS:
 114         void entrySelected( const GlossaryEntry &entry );
 115
 116     private Q_SLOTS:
 117         void meinprocFinished(int exitCode, QProcess::ExitStatus exitStatus);
 118         void treeItemSelected( Q3ListViewItem *item );
 119
 120         protected:
 121                 virtual void showEvent(QShowEvent *event);
 122
 123     private:
 124         enum CacheStatus { NeedRebuild, CacheOk };
 125
 126         CacheStatus cacheStatus() const;
 127         int glossaryCTime() const;
 128         void rebuildGlossaryCache();
 129         void buildGlossaryTree();
 130         QDomElement childElement( const QDomElement &e, const QString &name );
 131
 132         KSharedConfigPtr m_config;
 133         Q3ListViewItem *m_byTopicItem;
 134         Q3ListViewItem *m_alphabItem;
 135         QString m_sourceFile;
 136         QString m_cacheFile;
 137         CacheStatus m_status;
 138         QHash<QString, GlossaryEntry*> m_glossEntries;
 139         QHash<QString, EntryItem*> m_idDict;
 140         bool m_initialized;
 141         static bool m_alreadyWarned;
 142 };
 143
 144 }
 145
 146 #endif // KHC_GLOSSARY_H
 147 // vim:ts=2:sw=2:et