The Sword Project Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
sword::abbrev
sword::BasicFilterUserData
sword::CipherFilter
sword::CURLFTPTransport
sword::CURLFTPTransport_init
sword::DirEntry
sword::EchoMod
sword::EncodingFilterMgrThis class is like a normal SWMgr, but you can additonally specify which encoding you want to use
sword::EntriesBlock
FEMain
sword::FileDescThis class represents one file
sword::FileMgrThis class ist used make file access operations easier
sword::FTPLibFTPTransport
sword::FTPLibFTPTransport_init
ftpparse
sword::FTPTransportTODO: document A base class to be used for reimplementation of network services
sword::GBFFootnotesThis Filter shows/hides footnotes in a GBF text
sword::GBFHeadingsThis Filter shows/hides headings in a GBF text
sword::GBFHTMLThis filter converts GBF text to HTML text
sword::GBFHTML::MyUserData
sword::GBFHTMLHREFThis filter converts GBF text to HTML text with hrefs
sword::GBFHTMLHREF::MyUserData
sword::GBFMorphThis Filter shows/hides morph tags in a GBF text
sword::GBFOSISThis filter converts GBF text to OSIS text
sword::GBFPlainThis filter converts GBF text to plain text
sword::GBFRedLetterWordsThis Filter shows/hides "red letter tags" (marking the words of Jesus) in a GBF text
sword::GBFRTFThis filter converts GBF text into RTF text
sword::GBFStrongsThis Filter shows/hides strong's numbers in a GBF text
sword::GBFThMLThis filter converts GBF text into ThML text
sword::GBFWEBIFThis filter converts GBF text to HTML text with hrefs
sword::GBFWordJSThis Filter shows/hides strong's numbers in a GBF text
sword::GreekLexAttribsThis filter converts ThML text to plain text
sword::HebrewMCIM
sword::HREFCom
sword::InstallMgrTODO: document
sword::InstallSourceTODO: document
sword::Latin1UTF16This filter converts Latin-1 encoded text to UTF-16
sword::Latin1UTF8This filter converts Latin-1 encoded text to UTF-8
sword::ListKeyListKey is the basis for all types of keys that have lists of specified indexes (e.g
sword::LocaleMgrThe LocaleMgr class handles all the different locales of Sword
sword::LZSSCompress
sword::MarkupFilterMgrThis class is like a normal SWEncodingMgr, but you can additonally specify which markup you want to use
sword::multimapwithdefault< Key, T, Compare >
sword::NullIM
sword::OSISFootnotesThis Filter shows/hides headings in a OSIS text
sword::OSISHeadingsThis Filter shows/hides headings in a OSIS text
sword::OSISHTMLHREFThis filter converts OSIS text to HTML text with hrefs
sword::OSISHTMLHREF::MyUserData
sword::OSISLemmaThis Filter shows/hides headings in a OSIS text
sword::OSISMorphThis Filter shows/hides morph tags in a OSIS text
sword::OSISMorphSegmentation
sword::OSISOSISThis filter converts internal OSIS text to public OSIS text
sword::OSISOSIS::MyUserData
sword::OSISPlainThis filter converts OSIS text to plain text
sword::OSISPlain::MyUserData
sword::OSISRedLetterWordsThis Filter shows/hides headings in a OSIS text
sword::OSISRTFThis filter converts OSIS text to RTF text
sword::OSISScriprefThis Filter shows/hides headings in a OSIS text
sword::OSISStrongsThis Filter shows/hides strong's numbers in a OSIS text
sword::OSISVariantsThis Filter shows/hides textual variants
sword::OSISWEBIFThis filter converts OSIS text to HTML text with hrefs
sword::OSISWordJSThis Filter shows/hides strong's numbers in a OSIS text
sword::PapyriPlainThis filter converts Papyri text to plain text
sword::PLAINFootnotesShows or hides footnotes in plain text
sword::PLAINHTMLThis filter converts plain text to HTML text
sword::QuoteStack
sword::QuoteStack::QuoteInstance
sword::RawCom
sword::RawFiles
sword::RawGenBook
sword::RawLD
sword::RawLD4
sword::RawStr
sword::RawStr4
sword::RawText
sword::RawVerse
sword::RTFHTMLThis filter converts RTF text into HTML text
sword::sapphire
sword::sbook
sword::SCSUUTF8This filter converts SCSU compressed (encoded) text to UTF-8
sword::StatusReporterClass for reporting status
sword::StringMgrStringMgr is a way to provide UTf8 handling by the Sword frontend Each platform, if it's up-to-date, should provide functions to handle unicode and utf8
sword::StrKeyStandard string key class (used for modules that index on single strings (eg
sword::SW_POSITIONFor use with = operator to position key
sword::SWBasicFilterA filter providing commonly used functionality
sword::SWBufThis class is used as a transport and utility for data buffers
sword::SWCacherUsed to provide an interface for objects that cache and want a standard interface for cleaning up
sword::SWCipher
sword::SWClassClass used for SWDYNAMIC_CAST to save the inheritance order
sword::SWComThe basis for all commentary modules
sword::SWCompress
sword::SWConfigThe class to read and save settings using a file on disk
sword::SWDisplaySwdisp is the basis for all types of displays (e.g
sword::SWFilterBase class for all filters in sword
sword::SWFilterMgrClass to manage different kinds of filters
sword::SWGenBookThe basis for all Book modules
sword::SWInputMethod
sword::SWKeySWKey is used for positioning an SWModule to a specific entry
sword::SWLDBasis for all types of Lexicon and Dictionary modules (hence the 'LD')
sword::SWLocaleSWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language
sword::SWLog
sword::SWMgrSWMgr exposes an installed module set
sword::SWModuleThe class SWModule is the base class for all modules used in Sword
sword::SWObjectBase class for major Sword classes
sword::SWOptionFilterBase class for all option filters
sword::SWSearchableUsed to provide an interface for objects that be searched
sword::SWTextThe basis for all text modules
sword::SWTransData
sword::SWVersionA basic tool class to handle program version numbers
sword::TEIPlainThis filter converts TEI text to plain text
sword::TEIPlain::MyUserData
sword::TEIRTFThis filter converts TEI text to RTF text
sword::TEIRTF::MyUserData
sword::ThMLFootnotesThis Filter shows/hides footnotes in a ThML text
sword::ThMLGBFThis filter converts ThML text to GBF text
sword::ThMLHeadingsThis Filter shows/hides headings in a ThML text
sword::ThMLHTMLThis filter converts ThML text to HTML text
sword::ThMLHTML::MyUserData
sword::ThMLHTMLHREFThis filter converts ThML text to HTML text with hrefs
sword::ThMLHTMLHREF::MyUserData
sword::ThMLLemmaThis Filter shows/hides lemmas in a ThML text
sword::ThMLMorphThis Filter shows/hides morph tags in a ThML text
sword::ThMLOSISThis filter converts ThML text to OSIS text
sword::ThMLPlainThis filter converts ThML text to plain text
sword::ThMLRTFThis filter converts ThML text to RTF text
sword::ThMLRTF::MyUserData
sword::ThMLScriprefThis Filter shows/hides scripture references in a ThML text
sword::ThMLStrongsThis Filter shows/hides strong's numbers in a ThML text
sword::ThMLVariantsThis Filter shows/hides textual variants
sword::ThMLWEBIFThis filter converts ThML text to HTML text with hrefs
sword::ThMLWordJSThis Filter shows/hides strong's numbers in a ThML text
sword::TreeKeyClass TreeKey The base class for all tree-based key implementations in Sword
sword::TreeKeyIdxClass TreeKeyIdx The TreeKey implementation used for all tree-based modules in Sword, such as GenBooks
sword::TreeKeyIdx::TreeNode
sword::UnicodeRTFThis filter converts UTF-8 text into RTF Unicode tags
sword::URLURL provides URL parsing The URL class provides an interface to work on the data of an URL like "http://www.crosswire.org/index.jsp?page=test&amp;user=nobody"
sword::UTF16UTF8This filter converts UTF-16 encoded text to UTF-8
sword::UTF8arShapingThis Filter controls the arabic shaping of UTF-8 text FIXME: is that correct? how to control it?
sword::UTF8BiDiReorderThis Filter reorders UTF-8 text according to Unicode BiDi
sword::UTF8CantillationThis Filter shows/hides Hebrew cantillation marks in UTF8 text
sword::UTF8GreekAccentsThis Filter shows/hides Greek Accents marks in UTF8 text
sword::UTF8HebrewPointsThis Filter shows/hides Hebrew vowel points in UTF8 text
sword::UTF8HTMLThis filter converts UTF-8 text into HTML escape sequences
sword::UTF8Latin1This filter converts UTF-8 encoded text to Latin-1
sword::UTF8NFC
sword::UTF8NFKD
sword::UTF8TransliteratorThis Filter uses ICU for transliteration
sword::UTF8UTF16This filter converts UTF-8 encoded text to UTF-16
VerseKey
sword::VerseKeyClass VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries
VerseKey2
sword::VerseKey::LocaleCache
sword::VerseTreeKeyClass VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries
sword::XMLTagSimple XML helper class
sword::zCom
sword::ZipCompress
sword::zLD
sword::zStr
sword::zText
sword::zVerse