aboutsummaryrefslogblamecommitdiffstats
path: root/doc/api-documentation/html/annotated.html
blob: 6949d282b6077b398e42b6284533ac0e2e8a9107 (plain) (tree)
1
2
3
4
5
6
7
8
9




                                                                                   
                                    
        
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                
































































                                                                                                                                                                                                                                                                                                                                                                                  
        
                                                                                                        

                                                             
                                                 

       
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Annotated Index</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.17 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
<hr><h1>The Sword Project Compound List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_encoding_filter_mgr.html">sword::EncodingFilterMgr</a></td><td class="indexvalue">This class is like a normal <a class="el" href="classsword_1_1_s_w_mgr.html">SWMgr</a>, but you can additonally specify which encoding you want to use</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_g_b_f_footnotes.html">sword::GBFFootnotes</a></td><td class="indexvalue">This Filter shows/hides footnotes in a GBF text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_g_b_f_headings.html">sword::GBFHeadings</a></td><td class="indexvalue">This Filter shows/hides headings in a GBF text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_g_b_f_h_t_m_l.html">sword::GBFHTML</a></td><td class="indexvalue">This filter converts GBF Text into HTML</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_g_b_f_h_t_m_l_h_r_e_f.html">sword::GBFHTMLHREF</a></td><td class="indexvalue">This filter converts GBF text to HTML text with hrefs</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_g_b_f_morph.html">sword::GBFMorph</a></td><td class="indexvalue">This Filter shows/hides morph tags in a GBF text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_g_b_f_o_s_i_s.html">sword::GBFOSIS</a></td><td class="indexvalue">This filter converts GBF text to HTML text with hrefs</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_g_b_f_plain.html">sword::GBFPlain</a></td><td class="indexvalue">This filter converts GBF text into plain text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_g_b_f_r_t_f.html">sword::GBFRTF</a></td><td class="indexvalue">This filter converts GBF text into RTF text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_g_b_f_strongs.html">sword::GBFStrongs</a></td><td class="indexvalue">This Filter shows/hides strong's numbers in a GBF text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_g_b_f_th_m_l.html">sword::GBFThML</a></td><td class="indexvalue">This filter converts GBF text into ThML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_greek_lex_attribs.html">sword::GreekLexAttribs</a></td><td class="indexvalue">This filter converts ThML text to plain text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_latin1_u_t_f16.html">sword::Latin1UTF16</a></td><td class="indexvalue">This filter converts Latin-1 encoded text to UTF-8</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_latin1_u_t_f8.html">sword::Latin1UTF8</a></td><td class="indexvalue">This filter converts Latin-1 encoded text to UTF-8</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_list_key.html">sword::ListKey</a></td><td class="indexvalue"><a class="el" href="classsword_1_1_list_key.html">ListKey</a> is the basis for all types of keys that have lists of specified indexes (e.g</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_locale_mgr.html">sword::LocaleMgr</a></td><td class="indexvalue">The <a class="el" href="classsword_1_1_locale_mgr.html">LocaleMgr</a> class handles all the different locales of Sword</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_markup_filter_mgr.html">sword::MarkupFilterMgr</a></td><td class="indexvalue">This class is like a normal SWEncodingMgr, but you can additonally specify which markup you want to use</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_p_l_a_i_n_footnotes.html">sword::PLAINFootnotes</a></td><td class="indexvalue">Shows or hides footnotes in plain text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_p_l_a_i_n_h_t_m_l.html">sword::PLAINHTML</a></td><td class="indexvalue">This filter converts plain text to HTML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_r_t_f_h_t_m_l.html">sword::RTFHTML</a></td><td class="indexvalue">This filter converts RTF text into HTML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_r_w_p_h_t_m_l.html">sword::RWPHTML</a></td><td class="indexvalue">This filter converts RWP text to HTML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_r_w_p_r_t_f.html">sword::RWPRTF</a></td><td class="indexvalue">This filter converts RWP text to RTF text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_c_s_u_u_t_f8.html">sword::SCSUUTF8</a></td><td class="indexvalue">This filter converts SCSU compressed (encoded) text to UTF-8</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_str_key.html">sword::StrKey</a></td><td class="indexvalue">A standard string key class (used for modules that index on single strings (eg</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_basic_filter.html">sword::SWBasicFilter</a></td><td class="indexvalue">A filter providing commonly used functionality</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_class.html">sword::SWClass</a></td><td class="indexvalue">Class used for SWDYNAMIC_CAST to save the inheritance order</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_com.html">sword::SWCom</a></td><td class="indexvalue">The basis for all commentary modules</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_config.html">sword::SWConfig</a></td><td class="indexvalue">The class to read and save settings using a file on disk</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_display.html">sword::SWDisplay</a></td><td class="indexvalue">Swdisp is the basis for all types of displays (e.g</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_gen_book.html">sword::SWGenBook</a></td><td class="indexvalue">The basis for all types of Lexicon and Dictionary modules (hence the 'LD')</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_key.html">sword::SWKey</a></td><td class="indexvalue"><a class="el" href="classsword_1_1_s_w_key.html">SWKey</a> is the basis for all types of keys for indexing into modules (e.g</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_l_d.html">sword::SWLD</a></td><td class="indexvalue">The basis for all types of Lexicon and Dictionary modules (hence the 'LD')</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_locale.html">sword::SWLocale</a></td><td class="indexvalue"><a class="el" href="classsword_1_1_s_w_locale.html">SWLocale</a> is used for the localisation of the booknames The <a class="el" href="classsword_1_1_s_w_locale.html">SWLocale</a> is a class which holds the information of one language</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_mgr.html">sword::SWMgr</a></td><td class="indexvalue"><a class="el" href="classsword_1_1_s_w_mgr.html">SWMgr</a> is the main class of the Sword library</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_module.html">sword::SWModule</a></td><td class="indexvalue">The class <a class="el" href="classsword_1_1_s_w_module.html">SWModule</a> is the base class for all modules used in Sword</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_object.html">sword::SWObject</a></td><td class="indexvalue">Base class for major Sword classes</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_s_w_text.html">sword::SWText</a></td><td class="indexvalue">The basis for all text modules</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_footnotes.html">sword::ThMLFootnotes</a></td><td class="indexvalue">This Filter shows/hides footnotes in a ThML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_g_b_f.html">sword::ThMLGBF</a></td><td class="indexvalue">This filter converts ThML text to GBF text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_headings.html">sword::ThMLHeadings</a></td><td class="indexvalue">This Filter shows/hides headings in a ThML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_h_t_m_l.html">sword::ThMLHTML</a></td><td class="indexvalue">This filter converts ThML text to HTML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_h_t_m_l_h_r_e_f.html">sword::ThMLHTMLHREF</a></td><td class="indexvalue">This filter converts ThML text to HTML text with hrefs</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_lemma.html">sword::ThMLLemma</a></td><td class="indexvalue">This Filter shows/hides lemmas in a ThML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_morph.html">sword::ThMLMorph</a></td><td class="indexvalue">This Filter shows/hides morph tags in a ThML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_o_l_b.html">sword::ThMLOLB</a></td><td class="indexvalue">This filter converts ThML text to OLB text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_o_s_i_s.html">sword::ThMLOSIS</a></td><td class="indexvalue">This filter converts ThML text to HTML text with hrefs</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_plain.html">sword::ThMLPlain</a></td><td class="indexvalue">This filter converts ThML text to plain text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_r_t_f.html">sword::ThMLRTF</a></td><td class="indexvalue">This filter converts ThML text to RTF text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_scripref.html">sword::ThMLScripref</a></td><td class="indexvalue">This Filter shows/hides scripture references in a ThML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_strongs.html">sword::ThMLStrongs</a></td><td class="indexvalue">This Filter shows/hides strong's numbers in a ThML text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_th_m_l_variants.html">sword::ThMLVariants</a></td><td class="indexvalue">This Filter shows/hides textual variants</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_tree_key.html">sword::TreeKey</a></td><td class="indexvalue">Class <a class="el" href="classsword_1_1_verse_key.html">VerseKey</a> The <a class="el" href="classsword_1_1_s_w_key.html">SWKey</a> implementation used for verse based modules like Bibles or commentaries</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_tree_key_idx.html">sword::TreeKeyIdx</a></td><td class="indexvalue">Class <a class="el" href="classsword_1_1_verse_key.html">VerseKey</a> The <a class="el" href="classsword_1_1_s_w_key.html">SWKey</a> implementation used for verse based modules like Bibles or commentaries</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_unicode_r_t_f.html">sword::UnicodeRTF</a></td><td class="indexvalue">This filter converts UTF-8 text into RTF Unicode tags</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_u_t_f16_u_t_f8.html">sword::UTF16UTF8</a></td><td class="indexvalue">This filter converts UTF-16 encoded text to UTF-8</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_u_t_f8ar_shaping.html">sword::UTF8arShaping</a></td><td class="indexvalue">This Filter shows/hides reorders UTF-8 text according to Unicode BiDi</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_u_t_f8_bi_di_reorder.html">sword::UTF8BiDiReorder</a></td><td class="indexvalue">This Filter shows/hides reorders UTF-8 text according to Unicode BiDi</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_u_t_f8_cantillation.html">sword::UTF8Cantillation</a></td><td class="indexvalue">This Filter shows/hides Hebrew cantillation marks in UTF8 text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_u_t_f8_greek_accents.html">sword::UTF8GreekAccents</a></td><td class="indexvalue">This Filter shows/hides Greek Accents marks in UTF8 text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_u_t_f8_hebrew_points.html">sword::UTF8HebrewPoints</a></td><td class="indexvalue">This Filter shows/hides Hebrew vowel points in UTF8 text</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_u_t_f8_h_t_m_l.html">sword::UTF8HTML</a></td><td class="indexvalue">This filter converts UTF-8 text into HTML escape sequences</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_u_t_f8_latin1.html">sword::UTF8Latin1</a></td><td class="indexvalue">This filter converts UTF-8 encoded text to Latin-1</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_u_t_f8_transliterator.html">sword::UTF8Transliterator</a></td><td class="indexvalue">This Filter uses ICU for transliteration</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_u_t_f8_u_t_f16.html">sword::UTF8UTF16</a></td><td class="indexvalue">This filter converts UTF-8 encoded text to UTF-16</td></tr>
  <tr><td class="indexkey"><a class="el" href="classsword_1_1_verse_key.html">sword::VerseKey</a></td><td class="indexvalue">Class <a class="el" href="classsword_1_1_verse_key.html">VerseKey</a> The <a class="el" href="classsword_1_1_s_w_key.html">SWKey</a> implementation used for verse based modules like Bibles or commentaries</td></tr>
</table>
<hr><address style="align: right;"><small>Generated on Thu Oct 31 12:11:29 2002 for The Sword Project by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.17 </small></address>
</body>
</html>