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