summaryrefslogtreecommitdiffstats
path: root/khelpcenter/glossary.h
blob: 1adf64e0e496dd484a128086d651b799ca464f2d (plain)
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 TDE 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 <tdelistview.h>

#include <tqdict.h>
#include <tqdom.h>
#include <tqstringlist.h>

class TDEConfig;
class TDEProcess;

class EntryItem;

namespace KHC {

class GlossaryEntryXRef
{
	friend TQDataStream &operator>>( TQDataStream &, GlossaryEntryXRef & );
	public:
		typedef TQValueList<GlossaryEntryXRef> List;

		GlossaryEntryXRef() {}
		GlossaryEntryXRef( const TQString &term, const TQString &id ) :
			m_term( term ),
			m_id( id )
		{
		}

		TQString term() const { return m_term; }
		TQString id() const { return m_id; }
	
	private:
		TQString m_term;
		TQString m_id;
};

inline TQDataStream &operator<<( TQDataStream &stream, const GlossaryEntryXRef &e )
{
	return stream << e.term() << e.id();
}

inline TQDataStream &operator>>( TQDataStream &stream, GlossaryEntryXRef &e )
{
	return stream >> e.m_term >> e.m_id;
}

class GlossaryEntry
{
	friend TQDataStream &operator>>( TQDataStream &, GlossaryEntry & );
	public:
		GlossaryEntry() {}
		GlossaryEntry( const TQString &term, const TQString &definition,
				const GlossaryEntryXRef::List &seeAlso ) :
			m_term( term ),
			m_definition( definition ),
			m_seeAlso( seeAlso )
			{
			}

		TQString term() const { return m_term; }
		TQString definition() const { return m_definition; }
		GlossaryEntryXRef::List seeAlso() const { return m_seeAlso; }
	
	private:
		TQString m_term;
		TQString m_definition;
		GlossaryEntryXRef::List m_seeAlso;
};

inline TQDataStream &operator<<( TQDataStream &stream, const GlossaryEntry &e )
{
	return stream << e.term() << e.definition() << e.seeAlso();
}

inline TQDataStream &operator>>( TQDataStream &stream, GlossaryEntry &e )
{
	return stream >> e.m_term >> e.m_definition >> e.m_seeAlso;
}

class Glossary : public TDEListView
{
	Q_OBJECT
	public:
		Glossary( TQWidget *parent );
		virtual ~Glossary();

		const GlossaryEntry &entry( const TQString &id ) const;
 
    static TQString entryToHtml( const GlossaryEntry &entry );

    virtual void show();

	public slots:
		void slotSelectGlossEntry( const TQString &id );

	signals:
		void entrySelected( const GlossaryEntry &entry );
		
	private slots:
		void meinprocExited( TDEProcess *meinproc );
		void treeItemSelected( TQListViewItem *item );

	private:
		enum CacheStatus { NeedRebuild, CacheOk };

		CacheStatus cacheStatus() const;
		int glossaryCTime() const;
		void rebuildGlossaryCache();
		void buildGlossaryTree();
		TQDomElement childElement( const TQDomElement &e, const TQString &name );

		TDEConfig *m_config;
		TQListViewItem *m_byTopicItem;
		TQListViewItem *m_alphabItem;
		TQString m_sourceFile;
		TQString m_cacheFile;
		CacheStatus m_status;
		TQDict<GlossaryEntry> m_glossEntries;
    TQDict<EntryItem> m_idDict;
    bool m_initialized;
};

}

#endif // KHC_GLOSSARY_H