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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/*********
*
* This file is part of BibleTime's source code, http://www.bibletime.info/.
*
* Copyright 1999-2011 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License version 2.0.
*
**********/
#ifndef CTEXTRENDERING_H
#define CTEXTRENDERING_H
#include <QList>
#include <QSharedPointer>
#include <QString>
class CSwordKey;
class CSwordModuleInfo;
namespace Rendering {
/**
* CTextRendering is BibleTime's place where the actual rendering takes place.
* It provides several methods to convert an abstract tree of items
* into a string of html.
*
* See the implementations @ref CHTMLExportRendering and especially @ref CDisplayRendering.
* @short Text rendering based on trees
* @author The BibleTime team
*/
class CTextRendering {
public: /* Types: */
class KeyTreeItem;
class KeyTreeSharedPointer: public QSharedPointer<KeyTreeItem> {
public:
inline KeyTreeSharedPointer(KeyTreeItem * i)
: QSharedPointer<KeyTreeItem>(i) {}
inline operator const KeyTreeItem * () const { return data(); }
};
typedef QList<KeyTreeSharedPointer> KeyTree;
class KeyTreeItem {
public: /* Types: */
struct Settings {
enum KeyRenderingFace {
NoKey, //< means no key shown at all
SimpleKey, //< means only versenumber or only lexicon entry name
CompleteShort, //< means key like "Gen 1:1"
CompleteLong //< means "Genesis 1:1"
};
Settings(const bool highlight = false,
KeyRenderingFace keyRendering = SimpleKey)
: highlight(highlight)
, keyRenderingFace(keyRendering)
{}
bool highlight;
KeyRenderingFace keyRenderingFace;
}; /* struct Settings */
public: /* Methods: */
KeyTreeItem(const QString &key,
const CSwordModuleInfo *module,
const Settings &settings);
KeyTreeItem(const QString &key,
const QList<const CSwordModuleInfo*> &modules,
const Settings &settings);
KeyTreeItem(const QString &startKey,
const QString &stopKey,
const CSwordModuleInfo *module,
const Settings &settings);
KeyTreeItem(const QString &content, const Settings &settings);
KeyTreeItem(const KeyTreeItem &i);
inline const QString &getAlternativeContent() const {
return m_alternativeContent;
}
inline void setAlternativeContent(const QString& newContent) {
m_alternativeContent = newContent;
}
inline bool hasAlternativeContent() const {
return !m_alternativeContent.isNull();
}
inline const QList<const CSwordModuleInfo*>& modules() const {
return m_moduleList;
}
inline const QString& key() const {
return m_key;
}
inline const Settings& settings() const {
return m_settings;
}
inline KeyTree* childList() const {
return &m_childList;
}
protected: /* Methods: */
KeyTreeItem();
private: /* Fields: */
Settings m_settings;
QList<const CSwordModuleInfo*> m_moduleList;
QString m_key;
mutable KeyTree m_childList;
QString m_stopKey;
QString m_alternativeContent;
}; /* class KeyTreeItem */
public: /* Methods: */
virtual inline ~CTextRendering() {}
const QString renderKeyTree(const KeyTree &tree);
const QString renderKeyRange(
const QString &start,
const QString &stop,
const QList<const CSwordModuleInfo*> &modules,
const QString &hightlightKey = QString::null,
const KeyTreeItem::Settings &settings = KeyTreeItem::Settings());
const QString renderSingleKey(
const QString &key,
const QList<const CSwordModuleInfo*> &modules,
const KeyTreeItem::Settings &settings = KeyTreeItem::Settings());
protected: /* Methods: */
QList<const CSwordModuleInfo*> collectModules(const KeyTree &tree) const;
virtual QString renderEntry(const KeyTreeItem &item, CSwordKey * key = 0) = 0;
virtual QString finishText(const QString &text, const KeyTree &tree) = 0;
virtual void initRendering() = 0;
}; /* class CTextRendering */
} /* namespace Rendering */
#endif
|
