You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
148 lines
3.6 KiB
148 lines
3.6 KiB
//
|
|
// 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
|