summaryrefslogtreecommitdiffstats
path: root/bibletime/backend/ctextrendering.h
blob: c4689b4c9816db5f93bf30ce6708a738b2b2f27c (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
146
147
//
// C++ Interface: ctextrendering
//
// Description:
//
//
// Author: The BibleTime team <info@bibletime.info>, (C) 2004
//
// Copyright: See COPYING file that comes with this distribution
//
//

#ifndef CTEXTRENDERING_H
#define CTEXTRENDERING_H

//BT includes
#include "backend/cswordmoduleinfo.h"

#include "util/autoptrvector.h"

//QT includes
#include <tqstring.h>

// class CSwordModuleInfo;

class CSwordKey;

/**
 * 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
*/

namespace Rendering {

	class CTextRendering {

public:

	class KeyTreeItem;

	class KeyTree;
	typedef util::AutoPtrVector<KeyTreeItem> KeyTreeItemList;

	class KeyTreeItem {
	public:

		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;
		};

		KeyTreeItem(const TQString& key, CSwordModuleInfo const * module, const Settings settings);
		KeyTreeItem(const TQString& key, const ListCSwordModuleInfo& modules, const Settings settings);
		KeyTreeItem(const TQString& startKey, const TQString& stopKey, CSwordModuleInfo* module, const Settings settings);
		KeyTreeItem(const TQString& content, const Settings settings);
		KeyTreeItem(const KeyTreeItem& i);

		virtual ~KeyTreeItem();

		const TQString& getAlternativeContent() const;
		inline void setAlternativeContent(const TQString& newContent) {
			m_alternativeContent = newContent;
		};

		inline const bool hasAlternativeContent() const {
			return !m_alternativeContent.isNull();
		};

		inline const ListCSwordModuleInfo& modules() const {
			return m_moduleList;
		};

		inline const TQString& key() const {
			return m_key;
		};

		inline const Settings& settings() const {
			return m_settings;
		};

		inline KeyTree* const childList() const;
		inline const bool hasChildItems() const;

	protected:
		KeyTreeItem();

		Settings m_settings;
		ListCSwordModuleInfo m_moduleList;
		TQString m_key;
		mutable KeyTree* m_childList;

		TQString m_stopKey;
		TQString m_alternativeContent;
	};

	class KeyTree : public KeyTreeItemList {		
	public:
		ListCSwordModuleInfo collectModules() const;
	};

	virtual ~CTextRendering() {}

	const TQString renderKeyTree( KeyTree& );

	const TQString renderKeyRange( const TQString& start, const TQString& stop, const ListCSwordModuleInfo& modules, const TQString& hightlightKey = TQString(), const KeyTreeItem::Settings& settings = KeyTreeItem::Settings() );

	const TQString renderSingleKey( const TQString& key, const ListCSwordModuleInfo&, const KeyTreeItem::Settings& settings = KeyTreeItem::Settings() );

protected:
	virtual const TQString renderEntry( const KeyTreeItem&, CSwordKey* = 0 ) = 0;
	virtual const TQString finishText( const TQString&, KeyTree& tree ) = 0;
	virtual void initRendering() = 0;
};

inline CTextRendering::KeyTree* const CTextRendering::KeyTreeItem::childList() const {
	if (!m_childList) {
		m_childList = new KeyTree();
	}

	return m_childList;
}

inline const bool CTextRendering::KeyTreeItem::hasChildItems() const {
	if (!m_childList) {
		return false;
	}

	return !m_childList->isEmpty();
}

}

#endif