diff options
Diffstat (limited to 'doc/api-documentation/man')
102 files changed, 11706 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/EncodingFilterMgr.3 b/doc/api-documentation/man/man3/EncodingFilterMgr.3 new file mode 100644 index 0000000..2c14a90 --- /dev/null +++ b/doc/api-documentation/man/man3/EncodingFilterMgr.3 @@ -0,0 +1,120 @@ +.TH "EncodingFilterMgr" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +EncodingFilterMgr \- This class is like a normal \fBSWMgr\fP, but you can additonally specify which encoding you want to use. +.SH SYNOPSIS +.br +.PP +\fC#include <encfiltmgr.h>\fP +.PP +Inherits SWFilterMgr. +.PP +Inherited by \fBMarkupFilterMgr\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBEncodingFilterMgr\fP (char encoding=ENC_UTF8)" +.br +.RI "\fIConstructor of SWEncodingMgr.\fP" +.ti -1c +.RI "\fB~EncodingFilterMgr\fP ()" +.br +.RI "\fIThe destructor of SWEncodingMgr.\fP" +.ti -1c +.RI "char \fBEncoding\fP (char enc)" +.br +.RI "\fIMarkup sets/gets the encoding after initialization.\fP" +.ti -1c +.RI "virtual void \fBAddRawFilters\fP (\fBSWModule\fP *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the raw filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP" +.ti -1c +.RI "virtual void \fBAddEncodingFilters\fP (\fBSWModule\fP *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the encoding filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP" +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "SWFilter * \fBlatin1utf8\fP" +.br +.ti -1c +.RI "SWFilter * \fBscsuutf8\fP" +.br +.ti -1c +.RI "SWFilter * \fBtargetenc\fP" +.br +.ti -1c +.RI "char \fBencoding\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This class is like a normal \fBSWMgr\fP, but you can additonally specify which encoding you want to use. +.PP +Definition at line 33 of file encfiltmgr.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "EncodingFilterMgr::EncodingFilterMgr (char encoding = ENC_UTF8)" +.PP +Constructor of SWEncodingMgr. +.PP +Parameters: +.in +1c +.TP +\fB\fIiconfig\fP\fP +.TP +\fB\fIisysconfig\fP\fP +.TP +\fB\fIautoload\fP\fP +If this bool is true the constructor starts loading the installed modules. If you reimplemented \fBSWMgr\fP you can set autoload=false to load the modules with your own reimplemented function. +.TP +\fB\fIencoding\fP\fP +The desired encoding. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual void EncodingFilterMgr::AddEncodingFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [virtual]\fP" +.PP +Adds the encoding filters which are defined in 'section' to the \fBSWModule\fP object 'module'. +.PP +Parameters: +.in +1c +.TP +\fB\fImodule\fP\fP +To this module the encoding filter(s) are added +.TP +\fB\fIsection\fP\fP +We use this section to get a list of filters we should apply to the module +.SS "virtual void EncodingFilterMgr::AddRawFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [virtual]\fP" +.PP +Adds the raw filters which are defined in 'section' to the \fBSWModule\fP object 'module'. +.PP +Parameters: +.in +1c +.TP +\fB\fImodule\fP\fP +To this module the raw filter(s) are added +.TP +\fB\fIsection\fP\fP +We use this section to get a list of filters we should apply to the module +.SS "char EncodingFilterMgr::Encoding (char enc)" +.PP +Markup sets/gets the encoding after initialization. +.PP +Parameters: +.in +1c +.TP +\fB\fIm\fP\fP +The new encoding or ENC_UNKNOWN if you just want to get the current markup. +.PP +\fBReturns: \fP +.in +1c +The current (possibly changed) encoding format. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/GBFFootnotes.3 b/doc/api-documentation/man/man3/GBFFootnotes.3 new file mode 100644 index 0000000..7c50809 --- /dev/null +++ b/doc/api-documentation/man/man3/GBFFootnotes.3 @@ -0,0 +1,75 @@ +.TH "GBFFootnotes" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFFootnotes \- This Filter shows/hides footnotes in a GBF text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbffootnotes.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBGBFFootnotes\fP ()" +.br +.ti -1c +.RI "virtual \fB~GBFFootnotes\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides footnotes in a GBF text. +.PP +Definition at line 30 of file gbffootnotes.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/GBFHTML.3 b/doc/api-documentation/man/man3/GBFHTML.3 new file mode 100644 index 0000000..623068c --- /dev/null +++ b/doc/api-documentation/man/man3/GBFHTML.3 @@ -0,0 +1,31 @@ +.TH "GBFHTML" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFHTML \- This filter converts GBF Text into HTML. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfhtml.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBGBFHTML\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts GBF Text into HTML. +.PP +Definition at line 31 of file gbfhtml.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/GBFHTMLHREF.3 b/doc/api-documentation/man/man3/GBFHTMLHREF.3 new file mode 100644 index 0000000..6ab15e1 --- /dev/null +++ b/doc/api-documentation/man/man3/GBFHTMLHREF.3 @@ -0,0 +1,35 @@ +.TH "GBFHTMLHREF" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFHTMLHREF \- this filter converts GBF text to HTML text with hrefs. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfhtmlhref.h>\fP +.PP +Inherits SWBasicFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBGBFHTMLHREF\fP ()" +.br +.in -1c +.SS "Protected Methods" + +.in +1c +.ti -1c +.RI "virtual bool \fBhandleToken\fP (char **buf, const char *token, DualStringMap &userData)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts GBF text to HTML text with hrefs. +.PP +Definition at line 26 of file gbfhtmlhref.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/GBFHeadings.3 b/doc/api-documentation/man/man3/GBFHeadings.3 new file mode 100644 index 0000000..1d344b9 --- /dev/null +++ b/doc/api-documentation/man/man3/GBFHeadings.3 @@ -0,0 +1,75 @@ +.TH "GBFHeadings" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFHeadings \- This Filter shows/hides headings in a GBF text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfheadings.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBGBFHeadings\fP ()" +.br +.ti -1c +.RI "virtual \fB~GBFHeadings\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides headings in a GBF text. +.PP +Definition at line 30 of file gbfheadings.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/GBFMorph.3 b/doc/api-documentation/man/man3/GBFMorph.3 new file mode 100644 index 0000000..5aa4a17 --- /dev/null +++ b/doc/api-documentation/man/man3/GBFMorph.3 @@ -0,0 +1,75 @@ +.TH "GBFMorph" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFMorph \- This Filter shows/hides morph tags in a GBF text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfmorph.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBGBFMorph\fP ()" +.br +.ti -1c +.RI "virtual \fB~GBFMorph\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides morph tags in a GBF text. +.PP +Definition at line 29 of file gbfmorph.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/GBFPlain.3 b/doc/api-documentation/man/man3/GBFPlain.3 new file mode 100644 index 0000000..a9c3832 --- /dev/null +++ b/doc/api-documentation/man/man3/GBFPlain.3 @@ -0,0 +1,31 @@ +.TH "GBFPlain" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFPlain \- This filter converts GBF text into plain text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfplain.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBGBFPlain\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts GBF text into plain text. +.PP +Definition at line 30 of file gbfplain.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/GBFRTF.3 b/doc/api-documentation/man/man3/GBFRTF.3 new file mode 100644 index 0000000..1c1a523 --- /dev/null +++ b/doc/api-documentation/man/man3/GBFRTF.3 @@ -0,0 +1,31 @@ +.TH "GBFRTF" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFRTF \- This filter converts GBF text into RTF text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfrtf.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBGBFRTF\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts GBF text into RTF text. +.PP +Definition at line 30 of file gbfrtf.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/GBFStrongs.3 b/doc/api-documentation/man/man3/GBFStrongs.3 new file mode 100644 index 0000000..65cf644 --- /dev/null +++ b/doc/api-documentation/man/man3/GBFStrongs.3 @@ -0,0 +1,75 @@ +.TH "GBFStrongs" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFStrongs \- This Filter shows/hides strong's numbers in a GBF text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfstrongs.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBGBFStrongs\fP ()" +.br +.ti -1c +.RI "virtual \fB~GBFStrongs\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides strong's numbers in a GBF text. +.PP +Definition at line 30 of file gbfstrongs.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/GBFThML.3 b/doc/api-documentation/man/man3/GBFThML.3 new file mode 100644 index 0000000..72b2cef --- /dev/null +++ b/doc/api-documentation/man/man3/GBFThML.3 @@ -0,0 +1,31 @@ +.TH "GBFThML" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFThML \- this filter converts GBF text into ThML text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfthml.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBGBFThML\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen=-1)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts GBF text into ThML text. +.PP +Definition at line 27 of file gbfthml.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/Latin1UTF16.3 b/doc/api-documentation/man/man3/Latin1UTF16.3 new file mode 100644 index 0000000..12eeaf7 --- /dev/null +++ b/doc/api-documentation/man/man3/Latin1UTF16.3 @@ -0,0 +1,31 @@ +.TH "Latin1UTF16" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Latin1UTF16 \- This filter converts Latin-1 encoded text to UTF-8. +.SH SYNOPSIS +.br +.PP +\fC#include <latin1utf16.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBLatin1UTF16\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts Latin-1 encoded text to UTF-8. +.PP +Definition at line 29 of file latin1utf16.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/Latin1UTF8.3 b/doc/api-documentation/man/man3/Latin1UTF8.3 new file mode 100644 index 0000000..893d8bc --- /dev/null +++ b/doc/api-documentation/man/man3/Latin1UTF8.3 @@ -0,0 +1,31 @@ +.TH "Latin1UTF8" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Latin1UTF8 \- This filter converts Latin-1 encoded text to UTF-8. +.SH SYNOPSIS +.br +.PP +\fC#include <latin1utf8.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBLatin1UTF8\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts Latin-1 encoded text to UTF-8. +.PP +Definition at line 29 of file latin1utf8.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ListKey.3 b/doc/api-documentation/man/man3/ListKey.3 new file mode 100644 index 0000000..45237de --- /dev/null +++ b/doc/api-documentation/man/man3/ListKey.3 @@ -0,0 +1,277 @@ +.TH "ListKey" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ListKey \- ListKey is the basis for all types of keys that have lists of specified indexes (e.g. +.SH SYNOPSIS +.br +.PP +\fC#include <listkey.h>\fP +.PP +Inherits \fBSWKey\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBListKey\fP (const char *ikey=0)" +.br +.RI "\fIinitializes instance of ListKey.\fP" +.ti -1c +.RI "\fBListKey\fP (ListKey const &k)" +.br +.ti -1c +.RI "virtual \fB~ListKey\fP ()" +.br +.RI "\fIcleans up instance of ListKey.\fP" +.ti -1c +.RI "virtual \fBSWKey\fP * \fBclone\fP () const" +.br +.RI "\fIReturns a copy of this \fBSWKey\fP object.\fP" +.ti -1c +.RI "virtual void \fBClearList\fP ()" +.br +.RI "\fIClears out elements of list.\fP" +.ti -1c +.RI "virtual int \fBCount\fP ()" +.br +.RI "\fIReturns number of elements in list.\fP" +.ti -1c +.RI "virtual void \fBRemove\fP ()" +.br +.RI "\fIRemoves current element from list.\fP" +.ti -1c +.RI "virtual char \fBSetToElement\fP (int ielement, SW_POSITION=TOP)" +.br +.RI "\fISets key to element number.\fP" +.ti -1c +.RI "virtual \fBSWKey\fP * \fBGetElement\fP (int pos=-1)" +.br +.RI "\fIGets a key element number.\fP" +.ti -1c +.RI "ListKey & \fBoperator<<\fP (const \fBSWKey\fP &ikey)" +.br +.RI "\fIAdds an element to the list.\fP" +.ti -1c +.RI "virtual void \fBadd\fP (const \fBSWKey\fP &ikey)" +.br +.ti -1c +.RI "virtual void \fBcopyFrom\fP (const ListKey &ikey)" +.br +.RI "\fIEquates this ListKey to another ListKey object.\fP" +.ti -1c +.RI "virtual void \fBcopyFrom\fP (const \fBSWKey\fP &ikey)" +.br +.RI "\fIEquates this \fBSWKey\fP to another \fBSWKey\fP object.\fP" +.ti -1c +.RI "virtual void \fBsetPosition\fP (SW_POSITION)" +.br +.RI "\fIPositions this key.\fP" +.ti -1c +.RI "virtual void \fBdecrement\fP (int step)" +.br +.RI "\fIDecrements a number of elements.\fP" +.ti -1c +.RI "virtual void \fBincrement\fP (int step)" +.br +.RI "\fIIncrements a number of elements.\fP" +.ti -1c +.RI "virtual char \fBTraversable\fP ()" +.br +.ti -1c +.RI "virtual long \fBIndex\fP () const" +.br +.RI "\fIUse this function to get te current position withing a module.\fP" +.ti -1c +.RI "virtual long \fBIndex\fP (long index)" +.br +.RI "\fIReturns the index for the new one given as as parameter.\fP" +.ti -1c +.RI "SWKEY_OPERATORS ListKey & \fBoperator=\fP (const ListKey &key)" +.br +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "int \fBarraypos\fP" +.br +.ti -1c +.RI "int \fBarraymax\fP" +.br +.ti -1c +.RI "int \fBarraycnt\fP" +.br +.ti -1c +.RI "\fBSWKey\fP ** \fBarray\fP" +.br +.in -1c +.SS "Private Methods" + +.in +1c +.ti -1c +.RI "void \fBinit\fP ()" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "\fBSWClass\fP \fBclassdef\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +ListKey is the basis for all types of keys that have lists of specified indexes (e.g. +.PP +a list of verses, place, etc.) +.PP +Definition at line 36 of file listkey.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "ListKey::ListKey (const char * ikey = 0)" +.PP +initializes instance of ListKey. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +text key +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual int ListKey::Count ()\fC [virtual]\fP" +.PP +Returns number of elements in list. +.PP +\fBReturns: \fP +.in +1c +number of elements in list +.SS "virtual \fBSWKey\fP* ListKey::GetElement (int pos = -1)\fC [virtual]\fP" +.PP +Gets a key element number. +.PP +Parameters: +.in +1c +.TP +\fB\fIpos\fP\fP +element number to get (or default current) +.PP +\fBReturns: \fP +.in +1c +Key or null on error +.SS "virtual long ListKey::Index (long index)\fC [inline, virtual]\fP" +.PP +Returns the index for the new one given as as parameter. +.PP +The first parameter is the new index. +.PP +Reimplemented from \fBSWKey\fP. +.PP +Definition at line 112 of file listkey.h. +.SS "virtual long ListKey::Index () const\fC [inline, virtual]\fP" +.PP +Use this function to get te current position withing a module. +.PP +Here's a small example how to use this function and \fBIndex\fP(long). This function uses the GerLut module and chooses a random verse from the Bible and returns it. +.PP +.nf + const char* randomVerse() { + VerseKey vk; + SWMgr mgr; + LocaleMgr::systemLocaleMgr.setDefaultLocaleName('de'); + + SWModule* module = mgr->Modules('GerLut'); + srand( time(0) ); + const double newIndex = (double(rand())/RAND_MAX)*(24108+8224); + vk.Index(newIndex); + module->SetKey(vk); + + char* text; + sprintf(text, '%s: %s',(const char*)vk ,module->StripText(&vk)); + return text; +.fi + +.PP +Reimplemented from \fBSWKey\fP. +.PP +Definition at line 106 of file listkey.h. +.SS "virtual char ListKey::SetToElement (int ielement, SW_POSITION = TOP)\fC [virtual]\fP" +.PP +Sets key to element number. +.PP +Parameters: +.in +1c +.TP +\fB\fIielement\fP\fP +element number to set to +.PP +\fBReturns: \fP +.in +1c +error status +.PP +Referenced by Index(). +.PP +.SS "virtual \fBSWKey\fP* ListKey::clone () const\fC [virtual]\fP" +.PP +Returns a copy of this \fBSWKey\fP object. +.PP +This is useful to get a 1:1 copy of an \fBSWKey\fP based object. +.PP +\fBReturns: \fP +.in +1c +\fBSWKey\fP +.PP +Reimplemented from \fBSWKey\fP. +.SS "virtual void ListKey::copyFrom (const \fBSWKey\fP & ikey)\fC [inline, virtual]\fP" +.PP +Equates this \fBSWKey\fP to another \fBSWKey\fP object. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +other swkey object +.PP +Reimplemented from \fBSWKey\fP. +.PP +Definition at line 90 of file listkey.h. +.SS "virtual void ListKey::copyFrom (const ListKey & ikey)\fC [virtual]\fP" +.PP +Equates this ListKey to another ListKey object. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +other ListKey object +.SS "ListKey& ListKey::operator<< (const \fBSWKey\fP & ikey)\fC [inline]\fP" +.PP +Adds an element to the list. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +the element to add +.PP +Definition at line 82 of file listkey.h. +.SS "virtual void ListKey::setPosition (SW_POSITION)\fC [virtual]\fP" +.PP +Positions this key. +.PP +Parameters: +.in +1c +.TP +\fB\fIp\fP\fP +position +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Reimplemented from \fBSWKey\fP. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/LocaleMgr.3 b/doc/api-documentation/man/man3/LocaleMgr.3 new file mode 100644 index 0000000..64c38bb --- /dev/null +++ b/doc/api-documentation/man/man3/LocaleMgr.3 @@ -0,0 +1,163 @@ +.TH "LocaleMgr" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +LocaleMgr \- The LocaleMgr class handles all the different locales of Sword. +.SH SYNOPSIS +.br +.PP +\fC#include <localemgr.h>\fP +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBLocaleMgr\fP (const char *iConfigPath=0)" +.br +.RI "\fIDefault constructor of LocaleMgr You do normally not need this constructor, use \fBLocaleMgr::systemLocaleMgr\fP instead.\fP" +.ti -1c +.RI "virtual \fB~LocaleMgr\fP ()" +.br +.RI "\fIDefault destructor of LocaleMgr.\fP" +.ti -1c +.RI "virtual \fBSWLocale\fP * \fBgetLocale\fP (const char *name)" +.br +.RI "\fIGet the locale connected with the name 'name'.\fP" +.ti -1c +.RI "virtual list< string > \fBgetAvailableLocales\fP ()" +.br +.RI "\fIGet the list of available locales.\fP" +.ti -1c +.RI "virtual const char * \fBtranslate\fP (const char *name, const char *text)" +.br +.RI "\fIReturns translated text.\fP" +.ti -1c +.RI "virtual const char * \fBgetDefaultLocaleName\fP ()" +.br +.RI "\fIGet the default locale name.\fP" +.ti -1c +.RI "virtual void \fBsetDefaultLocaleName\fP (const char *name)" +.br +.RI "\fISet the new standard locale of Sword.\fP" +.in -1c +.SS "Static Public Attributes" + +.in +1c +.ti -1c +.RI "LocaleMgr \fBsystemLocaleMgr\fP" +.br +.RI "\fIThe LocaleMgr object used globally in the Sword world.\fP" +.in -1c +.SS "Protected Methods" + +.in +1c +.ti -1c +.RI "virtual void \fBloadConfigDir\fP (const char *ipath)" +.br +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "LocaleMap \fBlocales\fP" +.br +.in -1c +.SS "Private Methods" + +.in +1c +.ti -1c +.RI "void \fBdeleteLocales\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "char * \fBdefaultLocaleName\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +The LocaleMgr class handles all the different locales of Sword. +.PP +It provides functions to get a list of all available locales, to get the default locale name and to get it. The other functions are not interesting for frontend programmers. +.PP +To get the default locale name use +.PP +\fBSee also: \fP +.in +1c +\fBgetDefaultLocaleName\fP To set the default locale name use , \fBsetDefaultLocaleName\fP To get the locale for a language name use , \fBgetLocale\fP To get a list of availble locales use , \fBgetAvailableLocales\fP +.PP +Definition at line 49 of file localemgr.h. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual list< string > LocaleMgr::getAvailableLocales ()\fC [virtual]\fP" +.PP +Get the list of available locales. +.PP +@ret Returns a list of strings, which contains the names of the available locales. +.SS "virtual const char* LocaleMgr::getDefaultLocaleName ()\fC [virtual]\fP" +.PP +Get the default locale name. +.PP +To set it use +.PP +\fBSee also: \fP +.in +1c +\fBsetDefaultLocaleName\fP +.PP +@ret Returns the default locale name +.SS "virtual \fBSWLocale\fP* LocaleMgr::getLocale (const char * name)\fC [virtual]\fP" +.PP +Get the locale connected with the name 'name'. +.PP +Parameters: +.in +1c +.TP +\fB\fIname\fP\fP +The name of the locale you want to have. For example use getLocale('de') to get the locale for the German language. +.PP +\fBReturns: \fP +.in +1c +Returns the locale object if the locale with the name given as parameter was found. If it wasn't found return NULL. +.SS "virtual void LocaleMgr::setDefaultLocaleName (const char * name)\fC [virtual]\fP" +.PP +Set the new standard locale of Sword. +.PP +Parameters: +.in +1c +.TP +\fB\fIname\fP\fP +The name of the new default locale +.SS "virtual const char* LocaleMgr::translate (const char * name, const char * text)\fC [virtual]\fP" +.PP +Returns translated text. +.PP +This function uses both parameters to return the translated version of the given text. +.PP +Parameters: +.in +1c +.TP +\fB\fIname\fP\fP +The name of the locale Sword should use +.PP +\fBan The text to translate into the language given by the first parameter.\fP +.in +1c + +.PP +\fBReturns: \fP +.in +1c +Returns the translated text. +.SH "MEMBER DATA DOCUMENTATION" +.PP +.SS "LocaleMgr LocaleMgr::systemLocaleMgr\fC [static]\fP" +.PP +The LocaleMgr object used globally in the Sword world. +.PP +Do not create your own LocaleMgr, use this static object instead. +.PP +Definition at line 107 of file localemgr.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/MarkupFilterMgr.3 b/doc/api-documentation/man/man3/MarkupFilterMgr.3 new file mode 100644 index 0000000..5415e48 --- /dev/null +++ b/doc/api-documentation/man/man3/MarkupFilterMgr.3 @@ -0,0 +1,115 @@ +.TH "MarkupFilterMgr" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +MarkupFilterMgr \- This class is like a normal SWEncodingMgr, but you can additonally specify which markup you want to use. +.SH SYNOPSIS +.br +.PP +\fC#include <markupfiltmgr.h>\fP +.PP +Inherits \fBEncodingFilterMgr\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBMarkupFilterMgr\fP (char markup=FMT_THML, char encoding=ENC_UTF8)" +.br +.RI "\fIConstructor of SWMarkupMgr.\fP" +.ti -1c +.RI "\fB~MarkupFilterMgr\fP ()" +.br +.RI "\fIThe destructor of SWMarkupMgr.\fP" +.ti -1c +.RI "char \fBMarkup\fP (char m=FMT_UNKNOWN)" +.br +.RI "\fIMarkup sets/gets the markup after initialization.\fP" +.ti -1c +.RI "virtual void \fBAddRenderFilters\fP (\fBSWModule\fP *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the render filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP" +.in -1c +.SS "Protected Methods" + +.in +1c +.ti -1c +.RI "void \fBCreateFilters\fP (char markup)" +.br +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "SWFilter * \fBfromthml\fP" +.br +.ti -1c +.RI "SWFilter * \fBfromgbf\fP" +.br +.ti -1c +.RI "SWFilter * \fBfromplain\fP" +.br +.ti -1c +.RI "SWFilter * \fBfromosis\fP" +.br +.ti -1c +.RI "char \fBmarkup\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This class is like a normal SWEncodingMgr, but you can additonally specify which markup you want to use. +.PP +Definition at line 31 of file markupfiltmgr.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "MarkupFilterMgr::MarkupFilterMgr (char markup = FMT_THML, char encoding = ENC_UTF8)" +.PP +Constructor of SWMarkupMgr. +.PP +Parameters: +.in +1c +.TP +\fB\fIiconfig\fP\fP +.TP +\fB\fIisysconfig\fP\fP +.TP +\fB\fIautoload\fP\fP +If this bool is true the constructor starts loading the installed modules. If you reimplemented \fBSWMgr\fP you can set autoload=false to load the modules with your own reimplemented function. +.TP +\fB\fIencoding\fP\fP +The desired encoding. +.TP +\fB\fImarkup\fP\fP +The desired markup format. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual void MarkupFilterMgr::AddRenderFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [virtual]\fP" +.PP +Adds the render filters which are defined in 'section' to the \fBSWModule\fP object 'module'. +.PP +Parameters: +.in +1c +.TP +\fB\fImodule\fP\fP +To this module the render filter(s) are added +.TP +\fB\fIsection\fP\fP +We use this section to get a list of filters we should apply to the module +.SS "char MarkupFilterMgr::Markup (char m = FMT_UNKNOWN)" +.PP +Markup sets/gets the markup after initialization. +.PP +Parameters: +.in +1c +.TP +\fB\fIm\fP\fP +The new markup or FMT_UNKNOWN if you just want to get the current markup. +.PP +\fBReturns: \fP +.in +1c +The current (possibly changed) markup format. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/PLAINFootnotes.3 b/doc/api-documentation/man/man3/PLAINFootnotes.3 new file mode 100644 index 0000000..9edc336 --- /dev/null +++ b/doc/api-documentation/man/man3/PLAINFootnotes.3 @@ -0,0 +1,79 @@ +.TH "PLAINFootnotes" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +PLAINFootnotes \- Shows or hides footnotes in plain text. +.SH SYNOPSIS +.br +.PP +\fC#include <plainfootnotes.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBPLAINFootnotes\fP ()" +.br +.ti -1c +.RI "virtual \fB~PLAINFootnotes\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +Shows or hides footnotes in plain text. +.PP +\fBAuthor: \fP +.in +1c +The team of BibleTime +.PP +Definition at line 33 of file plainfootnotes.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/PLAINHTML.3 b/doc/api-documentation/man/man3/PLAINHTML.3 new file mode 100644 index 0000000..013b048 --- /dev/null +++ b/doc/api-documentation/man/man3/PLAINHTML.3 @@ -0,0 +1,31 @@ +.TH "PLAINHTML" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +PLAINHTML \- this filter converts plain text to HTML text. +.SH SYNOPSIS +.br +.PP +\fC#include <plainhtml.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBPLAINHTML\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts plain text to HTML text. +.PP +Definition at line 31 of file plainhtml.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/RTFHTML.3 b/doc/api-documentation/man/man3/RTFHTML.3 new file mode 100644 index 0000000..aa1b153 --- /dev/null +++ b/doc/api-documentation/man/man3/RTFHTML.3 @@ -0,0 +1,31 @@ +.TH "RTFHTML" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +RTFHTML \- this filter converts RTF text into HTML text. +.SH SYNOPSIS +.br +.PP +\fC#include <rtfhtml.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBRTFHTML\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts RTF text into HTML text. +.PP +Definition at line 30 of file rtfhtml.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/RWPHTML.3 b/doc/api-documentation/man/man3/RWPHTML.3 new file mode 100644 index 0000000..0c83dac --- /dev/null +++ b/doc/api-documentation/man/man3/RWPHTML.3 @@ -0,0 +1,31 @@ +.TH "RWPHTML" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +RWPHTML \- this filter converts RWP text to HTML text. +.SH SYNOPSIS +.br +.PP +\fC#include <rwphtml.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBRWPHTML\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts RWP text to HTML text. +.PP +Definition at line 31 of file rwphtml.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/RWPRTF.3 b/doc/api-documentation/man/man3/RWPRTF.3 new file mode 100644 index 0000000..44f63fc --- /dev/null +++ b/doc/api-documentation/man/man3/RWPRTF.3 @@ -0,0 +1,31 @@ +.TH "RWPRTF" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +RWPRTF \- this filter converts RWP text to RTF text. +.SH SYNOPSIS +.br +.PP +\fC#include <rwprtf.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBRWPRTF\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts RWP text to RTF text. +.PP +Definition at line 33 of file rwprtf.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SCSUUTF8.3 b/doc/api-documentation/man/man3/SCSUUTF8.3 new file mode 100644 index 0000000..7801082 --- /dev/null +++ b/doc/api-documentation/man/man3/SCSUUTF8.3 @@ -0,0 +1,48 @@ +.TH "SCSUUTF8" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SCSUUTF8 \- This filter converts SCSU compressed (encoded) text to UTF-8. +.SH SYNOPSIS +.br +.PP +\fC#include <scsuutf8.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSCSUUTF8\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SS "Private Methods" + +.in +1c +.ti -1c +.RI "unsigned char * \fBUTF8Output\fP (unsigned long, unsigned char *text)" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "unsigned long \fBc\fP" +.br +.ti -1c +.RI "unsigned long \fBd\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts SCSU compressed (encoded) text to UTF-8. +.PP +Definition at line 29 of file scsuutf8.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWClass.3 b/doc/api-documentation/man/man3/SWClass.3 new file mode 100644 index 0000000..673417d --- /dev/null +++ b/doc/api-documentation/man/man3/SWClass.3 @@ -0,0 +1,36 @@ +.TH "SWClass" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWClass \- Class used for SWDYNAMIC_CAST to save the inheritance order. +.SH SYNOPSIS +.br +.PP +\fC#include <swobject.h>\fP +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWClass\fP (const char **descends)" +.br +.ti -1c +.RI "bool \fBisAssignableFrom\fP (const char *className) const" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "const char ** \fBdescends\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +Class used for SWDYNAMIC_CAST to save the inheritance order. +.PP +Definition at line 18 of file swobject.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWCom.3 b/doc/api-documentation/man/man3/SWCom.3 new file mode 100644 index 0000000..8362a5e --- /dev/null +++ b/doc/api-documentation/man/man3/SWCom.3 @@ -0,0 +1,74 @@ +.TH "SWCom" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWCom \- The basis for all commentary modules. +.SH SYNOPSIS +.br +.PP +\fC#include <swcom.h>\fP +.PP +Inherits \fBSWModule\fP. +.PP +Inherited by HREFCom, RawCom, RawFiles, and zCom. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWCom\fP (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fP *idisp=0, SWTextEncoding enc=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup mark=FMT_UNKNOWN, const char *ilang=0)" +.br +.RI "\fIInitializes data for instance of SWCom.\fP" +.ti -1c +.RI "virtual \fB~SWCom\fP ()" +.br +.ti -1c +.RI "virtual \fBSWKey\fP * \fBCreateKey\fP ()" +.br +.RI "\fIAllocates a key of specific type for module The different reimplementatiosn of \fBSWModule\fP (e.g.\fP" +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +The basis for all commentary modules. +.PP +Definition at line 33 of file swcom.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWCom::SWCom (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fP * idisp = 0, SWTextEncoding enc = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup mark = FMT_UNKNOWN, const char * ilang = 0)" +.PP +Initializes data for instance of SWCom. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodname\fP\fP +Internal name for module +.TP +\fB\fIimoddesc\fP\fP +Name to display to user for module +.TP +\fB\fIidisp\fP\fP +Display object to use for displaying +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual \fBSWKey\fP* SWCom::CreateKey ()\fC [inline, virtual]\fP" +.PP +Allocates a key of specific type for module The different reimplementatiosn of \fBSWModule\fP (e.g. +.PP +\fBSWText\fP) support \fBSWKey\fP implementations, which support special. This functions returns a \fBSWKey\fP object which works with the current implementation of \fBSWModule\fP. For example for the \fBSWText\fP class it returns a \fBVerseKey\fP object. +.PP +\fBSee also: \fP +.in +1c +\fBVerseKey\fP, \fBListKey\fP, \fBSWText\fP, \fBSWLD\fP, SWCom +.PP +\fBReturns: \fP +.in +1c +pointer to allocated key +.PP +Reimplemented from \fBSWModule\fP. +.PP +Definition at line 44 of file swcom.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWConfig.3 b/doc/api-documentation/man/man3/SWConfig.3 new file mode 100644 index 0000000..ea9bf94 --- /dev/null +++ b/doc/api-documentation/man/man3/SWConfig.3 @@ -0,0 +1,100 @@ +.TH "SWConfig" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWConfig \- The class to read and save settings using a file on disk. +.SH SYNOPSIS +.br +.PP +\fC#include <swconfig.h>\fP +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWConfig\fP (const char *ifilename)" +.br +.RI "\fIConstructor of SWConfig.\fP" +.ti -1c +.RI "virtual \fB~SWConfig\fP ()" +.br +.ti -1c +.RI "virtual void \fBLoad\fP ()" +.br +.RI "\fILoad from disk Load the contzent from disk.\fP" +.ti -1c +.RI "virtual void \fBSave\fP ()" +.br +.RI "\fISave to disk Save the content of this config object to disk.\fP" +.ti -1c +.RI "virtual SWConfig & \fBoperator+=\fP (SWConfig &addFrom)" +.br +.RI "\fIMerges the values of addFrom.\fP" +.ti -1c +.RI "virtual ConfigEntMap & \fBoperator[]\fP (const char *section)" +.br +.RI "\fIGet a section This is an easy way to get and store config values.\fP" +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "string \fBfilename\fP" +.br +.RI "\fIThe filename used by this SWConfig object.\fP" +.ti -1c +.RI "SectionMap \fBSections\fP" +.br +.RI "\fIMap of available sections The map of available sections.\fP" +.in -1c +.SS "Private Methods" + +.in +1c +.ti -1c +.RI "char \fBgetline\fP (FILE *fp, string &line)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +The class to read and save settings using a file on disk. +.PP +Definition at line 56 of file swconfig.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWConfig::SWConfig (const char * ifilename)" +.PP +Constructor of SWConfig. +.PP +Parameters: +.in +1c +.TP +\fB\fIifilename\fP\fP +The file, which should be used for this config. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual SWConfig& SWConfig::operator+= (SWConfig & addFrom)\fC [virtual]\fP" +.PP +Merges the values of addFrom. +.PP +Parameters: +.in +1c +.TP +\fB\fIThe\fP\fP +config which values should be merged to this config object. Already existing values will be overwritten. +.SS "virtual ConfigEntMap& SWConfig::operator[] (const char * section)\fC [virtual]\fP" +.PP +Get a section This is an easy way to get and store config values. +.PP +The following will work: +.br + +.PP +.nf + SWConfig config('/home/user/.setttings'); + config['Colors']['Background'] = 'red'; +.fi + + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWDisplay.3 b/doc/api-documentation/man/man3/SWDisplay.3 new file mode 100644 index 0000000..eba516a --- /dev/null +++ b/doc/api-documentation/man/man3/SWDisplay.3 @@ -0,0 +1,49 @@ +.TH "SWDisplay" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWDisplay \- swdisp is the basis for all types of displays (e.g. +.SH SYNOPSIS +.br +.PP +\fC#include <swdisp.h>\fP +.PP +Inherited by TBDisp. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWDisplay\fP ()" +.br +.ti -1c +.RI "virtual char \fBDisplay\fP (\fBSWModule\fP &imodule)" +.br +.RI "\fIcasts a module to a character pointer and displays it to raw output (overriden for different display types and module types if necessary).\fP" +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +swdisp is the basis for all types of displays (e.g. +.PP +raw textout, curses, xwindow, etc.) +.PP +Definition at line 33 of file swdisp.h. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual char SWDisplay::Display (\fBSWModule\fP & imodule)\fC [virtual]\fP" +.PP +casts a module to a character pointer and displays it to raw output (overriden for different display types and module types if necessary). +.PP +Parameters: +.in +1c +.TP +\fB\fIimodule\fP\fP +module to display +.PP +\fBReturns: \fP +.in +1c +error status + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWEncodingMgr.3 b/doc/api-documentation/man/man3/SWEncodingMgr.3 new file mode 100644 index 0000000..acdbd11 --- /dev/null +++ b/doc/api-documentation/man/man3/SWEncodingMgr.3 @@ -0,0 +1,124 @@ +.TH "SWEncodingMgr" 3 "30 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWEncodingMgr \- This class is like a normal \fBSWMgr\fP, but you can additonally specify which encoding you want to use. +.SH SYNOPSIS +.br +.PP +\fC#include <swencodingmgr.h>\fP +.PP +Inherits \fBSWMgr\fP. +.PP +Inherited by \fBSWMarkupMgr\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWEncodingMgr\fP (\fBSWConfig\fP *iconfig=0, \fBSWConfig\fP *isysconfig=0, bool autoload=true, char encoding=ENC_UTF8)" +.br +.RI "\fIConstructor of SWEncodingMgr.\fP" +.ti -1c +.RI "\fB~SWEncodingMgr\fP ()" +.br +.RI "\fIThe destructor of SWEncodingMgr.\fP" +.ti -1c +.RI "char \fBEncoding\fP (char enc)" +.br +.RI "\fIMarkup sets/gets the encoding after initialization.\fP" +.ti -1c +.RI "virtual void \fBAddRawFilters\fP (\fBSWModule\fP *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the raw filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP" +.ti -1c +.RI "virtual void \fBAddEncodingFilters\fP (\fBSWModule\fP *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the encoding filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP" +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "\fBSWFilter\fP * \fBlatin1utf8\fP" +.br +.ti -1c +.RI "\fBSWFilter\fP * \fBscsuutf8\fP" +.br +.ti -1c +.RI "\fBSWFilter\fP * \fBtargetenc\fP" +.br +.ti -1c +.RI "char \fBencoding\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This class is like a normal \fBSWMgr\fP, but you can additonally specify which encoding you want to use. +.PP +Definition at line 31 of file swencodingmgr.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWEncodingMgr::SWEncodingMgr (\fBSWConfig\fP * iconfig = 0, \fBSWConfig\fP * isysconfig = 0, bool autoload = true, char encoding = ENC_UTF8)" +.PP +Constructor of SWEncodingMgr. +.PP +Parameters: +.in +1c +.TP +\fB\fIiconfig\fP\fP +.TP +\fB\fIisysconfig\fP\fP +.TP +\fB\fIautoload\fP\fP +If this bool is true the constructor starts loading the installed modules. If you reimplemented \fBSWMgr\fP you can set autoload=false to load the modules with your own reimplemented function. +.TP +\fB\fIencoding\fP\fP +The desired encoding. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual void SWEncodingMgr::AddEncodingFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [virtual]\fP" +.PP +Adds the encoding filters which are defined in 'section' to the \fBSWModule\fP object 'module'. +.PP +Parameters: +.in +1c +.TP +\fB\fImodule\fP\fP +To this module the encoding filter(s) are added +.TP +\fB\fIsection\fP\fP +We use this section to get a list of filters we should apply to the module +.PP +Reimplemented from \fBSWMgr\fP. +.SS "virtual void SWEncodingMgr::AddRawFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [virtual]\fP" +.PP +Adds the raw filters which are defined in 'section' to the \fBSWModule\fP object 'module'. +.PP +Parameters: +.in +1c +.TP +\fB\fImodule\fP\fP +To this module the raw filter(s) are added +.TP +\fB\fIsection\fP\fP +We use this section to get a list of filters we should apply to the module +.PP +Reimplemented from \fBSWMgr\fP. +.SS "char SWEncodingMgr::Encoding (char enc)" +.PP +Markup sets/gets the encoding after initialization. +.PP +Parameters: +.in +1c +.TP +\fB\fIm\fP\fP +The new encoding or ENC_UNKNOWN if you just want to get the current markup. +.PP +\fBReturns: \fP +.in +1c +The current (possibly changed) encoding format. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWFilter.3 b/doc/api-documentation/man/man3/SWFilter.3 new file mode 100644 index 0000000..396ed0e --- /dev/null +++ b/doc/api-documentation/man/man3/SWFilter.3 @@ -0,0 +1,151 @@ +.TH "SWFilter" 3 "5 Dec 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWFilter \- Base class for all filters in sword. +.SH SYNOPSIS +.br +.PP +\fC#include <swfilter.h>\fP +.PP +Inherited by CipherFilter, \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFHTML\fP, \fBGBFMorph\fP, \fBGBFPlain\fP, \fBGBFRTF\fP, \fBGBFStrongs\fP, \fBGBFThML\fP, \fBLatin1UTF16\fP, \fBLatin1UTF8\fP, \fBPLAINFootnotes\fP, \fBPLAINHTML\fP, \fBRTFHTML\fP, \fBRWPHTML\fP, \fBRWPRTF\fP, \fBSCSUUTF8\fP, SWBasicFilter, \fBThMLFootnotes\fP, \fBThMLGBF\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLOLB\fP, \fBThMLPlain\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUnicodeRTF\fP, \fBUTF16UTF8\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, \fBUTF8HebrewPoints\fP, \fBUTF8HTML\fP, \fBUTF8Latin1\fP, and \fBUTF8UTF16\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "virtual \fB~SWFilter\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.RI "\fIgets the name of the option of this filter.\fP" +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fP" +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.RI "\fIreturns a list of the possible option values might be.\fP" +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *)" +.br +.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to 'on' / 'off' - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fP.\fP" +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *)" +.br +.RI "\fIThis is the main filter function.\fP" +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen=-1)" +.br +.RI "\fIThis is the main filter function without the 3rd parameter.\fP" +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +Base class for all filters in sword. +.PP +Filters are used to filter/convert text between different formats like GBF, HTML, RTF ... +.PP +Definition at line 41 of file swfilter.h. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual char SWFilter::ProcessText (char * text, int maxlen = -1)\fC [inline, virtual]\fP" +.PP +This is the main filter function without the 3rd parameter. +.PP +Parameters: +.in +1c +.TP +\fB\fItext\fP\fP +the text to be filtered/converted +.TP +\fB\fImaxlen\fP\fP +maximal length of text to be processed +.PP +\fBReturns: \fP +.in +1c +0 +.PP +Reimplemented in \fBGBFThML\fP, \fBThMLGBF\fP, \fBThMLOLB\fP, and \fBThMLPlain\fP. +.PP +Definition at line 100 of file swfilter.h. +.SS "virtual char SWFilter::ProcessText (char * text, int maxlen, const \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +This is the main filter function. +.PP +Parameters: +.in +1c +.TP +\fB\fItext\fP\fP +the text to be filtered/converted +.TP +\fB\fImaxlen\fP\fP +maximal length of text to be processed +.TP +\fB\fIkey\fP\fP +sorry I don't know +.PP +\fBReturns: \fP +.in +1c +0 +.PP +Reimplemented in \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFHTML\fP, \fBGBFMorph\fP, \fBGBFPlain\fP, \fBGBFRTF\fP, \fBGBFStrongs\fP, \fBLatin1UTF16\fP, \fBLatin1UTF8\fP, \fBPLAINFootnotes\fP, \fBPLAINHTML\fP, \fBRTFHTML\fP, \fBRWPHTML\fP, \fBRWPRTF\fP, \fBSCSUUTF8\fP, \fBThMLFootnotes\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUnicodeRTF\fP, \fBUTF16UTF8\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, \fBUTF8HebrewPoints\fP, \fBUTF8HTML\fP, \fBUTF8Latin1\fP, and \fBUTF8UTF16\fP. +.PP +Definition at line 91 of file swfilter.h. +.PP +Referenced by ProcessText(). +.PP +.SS "virtual const char* SWFilter::getOptionName ()\fC [inline, virtual]\fP" +.PP +gets the name of the option of this filter. +.PP +\fBReturns: \fP +.in +1c +option name +.PP +Reimplemented in \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFMorph\fP, \fBGBFStrongs\fP, \fBPLAINFootnotes\fP, \fBThMLFootnotes\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, and \fBUTF8HebrewPoints\fP. +.PP +Definition at line 51 of file swfilter.h. +.SS "virtual const char* SWFilter::getOptionTip ()\fC [inline, virtual]\fP" +.PP +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +.PP +\fBReturns: \fP +.in +1c +option tip/explanation +.PP +Reimplemented in \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFMorph\fP, \fBGBFStrongs\fP, \fBPLAINFootnotes\fP, \fBThMLFootnotes\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, and \fBUTF8HebrewPoints\fP. +.PP +Definition at line 59 of file swfilter.h. +.SS "virtual OptionsList SWFilter::getOptionValues ()\fC [inline, virtual]\fP" +.PP +returns a list of the possible option values might be. +.PP +\fBReturns: \fP +.in +1c +list of option values +.PP +Reimplemented in \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFMorph\fP, \fBGBFStrongs\fP, \fBPLAINFootnotes\fP, \fBThMLFootnotes\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, and \fBUTF8HebrewPoints\fP. +.PP +Definition at line 67 of file swfilter.h. +.SS "virtual void SWFilter::setOptionValue (const char * ival)\fC [inline, virtual]\fP" +.PP +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to 'on' / 'off' - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fP. +.PP +Parameters: +.in +1c +.TP +\fB\fIival\fP\fP +the new option valus +.PP +Reimplemented in \fBGBFFootnotes\fP, \fBGBFHeadings\fP, \fBGBFMorph\fP, \fBGBFStrongs\fP, \fBPLAINFootnotes\fP, \fBThMLFootnotes\fP, \fBThMLHeadings\fP, \fBThMLLemma\fP, \fBThMLMorph\fP, \fBThMLScripref\fP, \fBThMLStrongs\fP, \fBUTF8Cantillation\fP, \fBUTF8GreekAccents\fP, and \fBUTF8HebrewPoints\fP. +.PP +Definition at line 78 of file swfilter.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWKey.3 b/doc/api-documentation/man/man3/SWKey.3 new file mode 100644 index 0000000..b8bb5a6 --- /dev/null +++ b/doc/api-documentation/man/man3/SWKey.3 @@ -0,0 +1,318 @@ +.TH "SWKey" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWKey \- SWKey is the basis for all types of keys for indexing into modules (e.g. +.SH SYNOPSIS +.br +.PP +\fC#include <swkey.h>\fP +.PP +Inherits \fBSWObject\fP. +.PP +Inherited by \fBListKey\fP, \fBStrKey\fP, and \fBVerseKey\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWKey\fP (const char *ikey=0)" +.br +.RI "\fIinitializes instance of SWKey.\fP" +.ti -1c +.RI "\fBSWKey\fP (SWKey const &k)" +.br +.RI "\fICopy Constructor.\fP" +.ti -1c +.RI "virtual \fB~SWKey\fP ()" +.br +.RI "\fIDestructor, cleans up this instance of SWKey.\fP" +.ti -1c +.RI "virtual SWKey * \fBclone\fP () const" +.br +.RI "\fIReturns a copy of this SWKey object.\fP" +.ti -1c +.RI "char \fBPersist\fP () const" +.br +.RI "\fIGets whether this object itself persists within a module that it was used to SetKey or just a copy.\fP" +.ti -1c +.RI "char \fBPersist\fP (char ikey)" +.br +.RI "\fISet/gets whether this object itself persists within a module that it was used to SetKey or just a copy.\fP" +.ti -1c +.RI "virtual char \fBError\fP ()" +.br +.RI "\fIGets and clears error status.\fP" +.ti -1c +.RI "virtual void \fBsetText\fP (const char *ikey)" +.br +.RI "\fIEquates this SWKey to a character string.\fP" +.ti -1c +.RI "virtual void \fBcopyFrom\fP (const SWKey &ikey)" +.br +.RI "\fIEquates this SWKey to another SWKey object.\fP" +.ti -1c +.RI "virtual const char * \fBgetText\fP () const" +.br +.RI "\fIreturns text key if (char *) cast is requested.\fP" +.ti -1c +.RI "virtual int \fBcompare\fP (const SWKey &ikey)" +.br +.RI "\fICompares another \fBVerseKey\fP object.\fP" +.ti -1c +.RI "virtual bool \fBequals\fP (const SWKey &ikey)" +.br +.RI "\fICompares another \fBVerseKey\fP object.\fP" +.ti -1c +.RI "virtual void \fBsetPosition\fP (SW_POSITION)" +.br +.ti -1c +.RI "virtual void \fBdecrement\fP (int steps=1)" +.br +.RI "\fIDecrements key a number of entries.\fP" +.ti -1c +.RI "virtual void \fBincrement\fP (int steps=1)" +.br +.RI "\fIIncrements key a number of entries.\fP" +.ti -1c +.RI "virtual char \fBTraversable\fP ()" +.br +.ti -1c +.RI "virtual long \fBIndex\fP () const" +.br +.RI "\fIUse this function to get te current position withing a module.\fP" +.ti -1c +.RI "virtual long \fBIndex\fP (long iindex)" +.br +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "char * \fBkeytext\fP" +.br +.ti -1c +.RI "char \fBpersist\fP" +.br +.ti -1c +.RI "char \fBerror\fP" +.br +.in -1c +.SS "Private Methods" + +.in +1c +.ti -1c +.RI "void \fBinit\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "long \fBindex\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "\fBSWClass\fP \fBclassdef\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +SWKey is the basis for all types of keys for indexing into modules (e.g. +.PP +verse, word, place, etc.) +.PP +Definition at line 76 of file swkey.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWKey::SWKey (const char * ikey = 0)" +.PP +initializes instance of SWKey. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +text key +.SS "SWKey::SWKey (SWKey const & k)" +.PP +Copy Constructor. +.PP +Parameters: +.in +1c +.TP +\fB\fIThe\fP\fP +SWKey object to copy. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual char SWKey::Error ()\fC [virtual]\fP" +.PP +Gets and clears error status. +.PP +\fBReturns: \fP +.in +1c +error status +.SS "virtual long SWKey::Index () const\fC [inline, virtual]\fP" +.PP +Use this function to get te current position withing a module. +.PP +Here's a small example how to use this function and Index(long). This function uses the GerLut module and chooses a random verse from the Bible and returns it. +.PP +.nf + const char* randomVerse() { + VerseKey vk; + SWMgr mgr; + LocaleMgr::systemLocaleMgr.setDefaultLocaleName('de'); + + SWModule* module = mgr->Modules('GerLut'); + srand( time(0) ); + const double newIndex = (double(rand())/RAND_MAX)*(24108+8224); + vk.Index(newIndex); + module->SetKey(vk); + + char* text; + sprintf(text, '%s: %s',(const char*)vk ,module->StripText(&vk)); + return text; +.fi + +.PP +Reimplemented in \fBListKey\fP, and \fBVerseKey\fP. +.PP +Definition at line 204 of file swkey.h. +.PP +Referenced by ListKey::Index(). +.PP +.SS "char SWKey::Persist (char ikey)" +.PP +Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy. +.PP +(1 - persists in module; 0 - a copy is attempted +.PP +Parameters: +.in +1c +.TP +\fB\fIipersist\fP\fP +value which to set persist; [-1] - only get +.PP +\fBReturns: \fP +.in +1c +value of persist +.SS "char SWKey::Persist () const" +.PP +Gets whether this object itself persists within a module that it was used to SetKey or just a copy. +.PP +(1 - persists in module; 0 - a copy is attempted +.PP +\fBReturns: \fP +.in +1c +value of persist +.SS "virtual SWKey* SWKey::clone () const\fC [virtual]\fP" +.PP +Returns a copy of this SWKey object. +.PP +This is useful to get a 1:1 copy of an SWKey based object. +.PP +\fBReturns: \fP +.in +1c +SWKey +.PP +Reimplemented in \fBListKey\fP, and \fBVerseKey\fP. +.SS "virtual int SWKey::compare (const SWKey & ikey)\fC [virtual]\fP" +.PP +Compares another \fBVerseKey\fP object. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +key to compare with this one +.PP +\fBReturns: \fP +.in +1c +>0 if this key is greater than compare key; <0 if this key is smaller than compare key; 0 if the keys are the same +.PP +Reimplemented in \fBVerseKey\fP. +.PP +Referenced by equals(). +.PP +.SS "virtual void SWKey::copyFrom (const SWKey & ikey)\fC [virtual]\fP" +.PP +Equates this SWKey to another SWKey object. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +other swkey object +.PP +Reimplemented in \fBListKey\fP, and \fBVerseKey\fP. +.PP +Referenced by ListKey::copyFrom(). +.PP +.SS "virtual void SWKey::decrement (int step = 1)\fC [virtual]\fP" +.PP +Decrements key a number of entries. +.PP +Parameters: +.in +1c +.TP +\fB\fIsteps\fP\fP +Number of entries to jump backward +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Reimplemented in \fBListKey\fP, and \fBVerseKey\fP. +.SS "virtual bool SWKey::equals (const SWKey & ikey)\fC [inline, virtual]\fP" +.PP +Compares another \fBVerseKey\fP object. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +key to compare with this one +.PP +\fBReturns: \fP +.in +1c +true if the keys are the same +.PP +Definition at line 163 of file swkey.h. +.SS "virtual void SWKey::increment (int step = 1)\fC [virtual]\fP" +.PP +Increments key a number of entries. +.PP +Parameters: +.in +1c +.TP +\fB\fIincrement\fP\fP +Number of entries to jump forward +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Reimplemented in \fBListKey\fP, and \fBVerseKey\fP. +.SS "virtual void SWKey::setText (const char * ikey)\fC [virtual]\fP" +.PP +Equates this SWKey to a character string. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +string to set this key to +.PP +Reimplemented in \fBVerseKey\fP. +.PP +Referenced by VerseKey::setText(). +.PP + + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWLD.3 b/doc/api-documentation/man/man3/SWLD.3 new file mode 100644 index 0000000..4f1a273 --- /dev/null +++ b/doc/api-documentation/man/man3/SWLD.3 @@ -0,0 +1,100 @@ +.TH "SWLD" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWLD \- the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). +.SH SYNOPSIS +.br +.PP +\fC#include <swld.h>\fP +.PP +Inherits \fBSWModule\fP. +.PP +Inherited by RawLD, RawLD4, and zLD. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWLD\fP (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fP *idisp=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *ilang=0)" +.br +.RI "\fIInitializes data for instance of SWLD.\fP" +.ti -1c +.RI "virtual \fB~SWLD\fP ()" +.br +.ti -1c +.RI "virtual \fBSWKey\fP * \fBCreateKey\fP ()" +.br +.RI "\fIAllocates a key of specific type for module The different reimplementatiosn of \fBSWModule\fP (e.g.\fP" +.ti -1c +.RI "virtual const char * \fBKeyText\fP (const char *ikeytext)" +.br +.RI "\fISets/gets module KeyText, getting from saved text if key is persistent.\fP" +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "char * \fBentkeytxt\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). +.PP +Definition at line 34 of file swld.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWLD::SWLD (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fP * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char * ilang = 0)" +.PP +Initializes data for instance of SWLD. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodname\fP\fP +Internal name for module +.TP +\fB\fIimoddesc\fP\fP +Name to display to user for module +.TP +\fB\fIidisp\fP\fP +Display object to use for displaying +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual \fBSWKey\fP* SWLD::CreateKey ()\fC [inline, virtual]\fP" +.PP +Allocates a key of specific type for module The different reimplementatiosn of \fBSWModule\fP (e.g. +.PP +\fBSWText\fP) support \fBSWKey\fP implementations, which support special. This functions returns a \fBSWKey\fP object which works with the current implementation of \fBSWModule\fP. For example for the \fBSWText\fP class it returns a \fBVerseKey\fP object. +.PP +\fBSee also: \fP +.in +1c +\fBVerseKey\fP, \fBListKey\fP, \fBSWText\fP, SWLD, \fBSWCom\fP +.PP +\fBReturns: \fP +.in +1c +pointer to allocated key +.PP +Reimplemented from \fBSWModule\fP. +.PP +Definition at line 47 of file swld.h. +.SS "virtual const char* SWLD::KeyText (const char * ikeytext)\fC [virtual]\fP" +.PP +Sets/gets module KeyText, getting from saved text if key is persistent. +.PP +Parameters: +.in +1c +.TP +\fB\fIikeytext\fP\fP +value which to set keytext; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to keytext +.PP +Reimplemented from \fBSWModule\fP. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWLocale.3 b/doc/api-documentation/man/man3/SWLocale.3 new file mode 100644 index 0000000..e7dcb2c --- /dev/null +++ b/doc/api-documentation/man/man3/SWLocale.3 @@ -0,0 +1,93 @@ +.TH "SWLocale" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWLocale \- SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language. +.SH SYNOPSIS +.br +.PP +\fC#include <swlocale.h>\fP +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWLocale\fP (const char *ifilename)" +.br +.ti -1c +.RI "virtual \fB~SWLocale\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetName\fP ()" +.br +.RI "\fIThis function is used to get the name of the languages which this object is handling.\fP" +.ti -1c +.RI "virtual const char * \fBgetDescription\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBtranslate\fP (const char *text)" +.br +.ti -1c +.RI "virtual SWLocale & \fBoperator+=\fP (SWLocale &addFrom)" +.br +.ti -1c +.RI "virtual const struct abbrev * \fBgetBookAbbrevs\fP ()" +.br +.ti -1c +.RI "virtual void \fBgetBooks\fP (char **iBMAX, struct sbook ***ibooks)" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "LookupMap \fBlookupTable\fP" +.br +.ti -1c +.RI "\fBSWConfig\fP * \fBlocaleSource\fP" +.br +.ti -1c +.RI "char * \fBname\fP" +.br +.ti -1c +.RI "char * \fBdescription\fP" +.br +.ti -1c +.RI "abbrev * \fBbookAbbrevs\fP" +.br +.ti -1c +.RI "char * \fBBMAX\fP" +.br +.ti -1c +.RI "sbook ** \fBbooks\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language. +.PP +Every language supported by Sword has one SWLocale object, get the name of the Language using +.PP +\fBSee also: \fP +.in +1c +getname of this class. Another functions useful for frontend developers is , \fBgetDescription\fP. +.PP +Definition at line 44 of file swlocale.h. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual const char* SWLocale::getDescription ()\fC [virtual]\fP" +.PP +\fBReturns: \fP +.in +1c +The description. A possible example is 'German'. +.SS "virtual const char* SWLocale::getName ()\fC [virtual]\fP" +.PP +This function is used to get the name of the languages which this object is handling. +.PP +\fBReturns: \fP +.in +1c +The name of the managed language. A possible example is 'de'. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWMarkupMgr.3 b/doc/api-documentation/man/man3/SWMarkupMgr.3 new file mode 100644 index 0000000..024e16d --- /dev/null +++ b/doc/api-documentation/man/man3/SWMarkupMgr.3 @@ -0,0 +1,117 @@ +.TH "SWMarkupMgr" 3 "30 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWMarkupMgr \- This class is like a normal \fBSWEncodingMgr\fP, but you can additonally specify which markup you want to use. +.SH SYNOPSIS +.br +.PP +\fC#include <swmarkupmgr.h>\fP +.PP +Inherits \fBSWEncodingMgr\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWMarkupMgr\fP (\fBSWConfig\fP *iconfig=0, \fBSWConfig\fP *isysconfig=0, bool autoload=true, char encoding=ENC_UTF8, char markup=FMT_THML)" +.br +.RI "\fIConstructor of SWMarkupMgr.\fP" +.ti -1c +.RI "\fB~SWMarkupMgr\fP ()" +.br +.RI "\fIThe destructor of SWMarkupMgr.\fP" +.ti -1c +.RI "char \fBMarkup\fP (char m=FMT_UNKNOWN)" +.br +.RI "\fIMarkup sets/gets the markup after initialization.\fP" +.ti -1c +.RI "virtual void \fBAddRenderFilters\fP (\fBSWModule\fP *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the render filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP" +.in -1c +.SS "Protected Methods" + +.in +1c +.ti -1c +.RI "void \fBCreateFilters\fP (char markup)" +.br +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "\fBSWFilter\fP * \fBfromthml\fP" +.br +.ti -1c +.RI "\fBSWFilter\fP * \fBfromgbf\fP" +.br +.ti -1c +.RI "\fBSWFilter\fP * \fBfromplain\fP" +.br +.ti -1c +.RI "\fBSWFilter\fP * \fBfromosis\fP" +.br +.ti -1c +.RI "char \fBmarkup\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This class is like a normal \fBSWEncodingMgr\fP, but you can additonally specify which markup you want to use. +.PP +Definition at line 31 of file swmarkupmgr.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWMarkupMgr::SWMarkupMgr (\fBSWConfig\fP * iconfig = 0, \fBSWConfig\fP * isysconfig = 0, bool autoload = true, char encoding = ENC_UTF8, char markup = FMT_THML)" +.PP +Constructor of SWMarkupMgr. +.PP +Parameters: +.in +1c +.TP +\fB\fIiconfig\fP\fP +.TP +\fB\fIisysconfig\fP\fP +.TP +\fB\fIautoload\fP\fP +If this bool is true the constructor starts loading the installed modules. If you reimplemented \fBSWMgr\fP you can set autoload=false to load the modules with your own reimplemented function. +.TP +\fB\fIencoding\fP\fP +The desired encoding. +.TP +\fB\fImarkup\fP\fP +The desired markup format. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual void SWMarkupMgr::AddRenderFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [virtual]\fP" +.PP +Adds the render filters which are defined in 'section' to the \fBSWModule\fP object 'module'. +.PP +Parameters: +.in +1c +.TP +\fB\fImodule\fP\fP +To this module the render filter(s) are added +.TP +\fB\fIsection\fP\fP +We use this section to get a list of filters we should apply to the module +.PP +Reimplemented from \fBSWMgr\fP. +.SS "char SWMarkupMgr::Markup (char m = FMT_UNKNOWN)" +.PP +Markup sets/gets the markup after initialization. +.PP +Parameters: +.in +1c +.TP +\fB\fIm\fP\fP +The new markup or FMT_UNKNOWN if you just want to get the current markup. +.PP +\fBReturns: \fP +.in +1c +The current (possibly changed) markup format. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWMgr.3 b/doc/api-documentation/man/man3/SWMgr.3 new file mode 100644 index 0000000..c7758a9 --- /dev/null +++ b/doc/api-documentation/man/man3/SWMgr.3 @@ -0,0 +1,452 @@ +.TH "SWMgr" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWMgr \- SWMgr is the main class of the Sword library. +.SH SYNOPSIS +.br +.PP +\fC#include <swmgr.h>\fP +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWMgr\fP (\fBSWConfig\fP *iconfig=0, \fBSWConfig\fP *isysconfig=0, bool autoload=true, SWFilterMgr *filterMgr=0)" +.br +.RI "\fIConstructor of SWMgr.\fP" +.ti -1c +.RI "\fBSWMgr\fP (SWFilterMgr *filterMgr)" +.br +.ti -1c +.RI "\fBSWMgr\fP (const char *iConfigPath, bool autoload=true, SWFilterMgr *filterMgr=0)" +.br +.ti -1c +.RI "virtual \fB~SWMgr\fP ()" +.br +.RI "\fIThe destructor of SWMgr.\fP" +.ti -1c +.RI "virtual void \fBInstallScan\fP (const char *dir)" +.br +.RI "\fIInstalls a scan for modules in the directory givan as parameter.\fP" +.ti -1c +.RI "virtual void \fBLoad\fP ()" +.br +.RI "\fILoad the modules.\fP" +.ti -1c +.RI "virtual void \fBsetGlobalOption\fP (const char *option, const char *value)" +.br +.RI "\fISet a global option Set a global option using the parameters.\fP" +.ti -1c +.RI "virtual const char * \fBgetGlobalOption\fP (const char *option)" +.br +.RI "\fIGives the value of the given option.\fP" +.ti -1c +.RI "virtual const char * \fBgetGlobalOptionTip\fP (const char *option)" +.br +.RI "\fIGives a description for the given option.\fP" +.ti -1c +.RI "virtual OptionsList \fBgetGlobalOptions\fP ()" +.br +.RI "\fIA list of all availble options with the currently set values.\fP" +.ti -1c +.RI "virtual OptionsList \fBgetGlobalOptionValues\fP (const char *option)" +.br +.ti -1c +.RI "virtual signed char \fBsetCipherKey\fP (const char *modName, const char *key)" +.br +.RI "\fISets the cipher key for the given module.\fP" +.in -1c +.SS "Static Public Methods" + +.in +1c +.ti -1c +.RI "void \fBfindConfig\fP (char *configType, char **\fBprefixPath\fP, char **configPath)" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "\fBSWConfig\fP * \fBconfig\fP" +.br +.RI "\fIThe global config object.\fP" +.ti -1c +.RI "\fBSWConfig\fP * \fBsysconfig\fP" +.br +.ti -1c +.RI "ModMap \fBModules\fP" +.br +.RI "\fIThe map of available modules.\fP" +.ti -1c +.RI "char * \fBprefixPath\fP" +.br +.RI "\fIThe path to your Sword directory.\fP" +.ti -1c +.RI "char * \fBconfigPath\fP" +.br +.in -1c +.SS "Static Public Attributes" + +.in +1c +.ti -1c +.RI "bool \fBdebug\fP" +.br +.RI "\fIEnable / Disable debug output on runtime Set this to true to get more verbose output of SWMgr at runtime.\fP" +.ti -1c +.RI "const char * \fBglobalConfPath\fP" +.br +.in -1c +.SS "Protected Methods" + +.in +1c +.ti -1c +.RI "void \fBCreateMods\fP ()" +.br +.ti -1c +.RI "\fBSWModule\fP * \fBCreateMod\fP (string name, string driver, ConfigEntMap §ion)" +.br +.ti -1c +.RI "void \fBDeleteMods\fP ()" +.br +.ti -1c +.RI "virtual void \fBinit\fP ()" +.br +.ti -1c +.RI "virtual char \fBAddModToConfig\fP (int conffd, const char *fname)" +.br +.ti -1c +.RI "virtual void \fBloadConfigDir\fP (const char *ipath)" +.br +.ti -1c +.RI "virtual void \fBAddGlobalOptions\fP (\fBSWModule\fP *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end)" +.br +.ti -1c +.RI "virtual void \fBAddLocalOptions\fP (\fBSWModule\fP *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end)" +.br +.ti -1c +.RI "virtual void \fBAddEncodingFilters\fP (\fBSWModule\fP *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the encoding filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP" +.ti -1c +.RI "virtual void \fBAddRenderFilters\fP (\fBSWModule\fP *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the render filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP" +.ti -1c +.RI "virtual void \fBAddStripFilters\fP (\fBSWModule\fP *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the strip filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP" +.ti -1c +.RI "virtual void \fBAddRawFilters\fP (\fBSWModule\fP *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the raw filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP" +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "SWFilterMgr * \fBfilterMgr\fP" +.br +.ti -1c +.RI "\fBSWConfig\fP * \fBmyconfig\fP" +.br +.ti -1c +.RI "\fBSWConfig\fP * \fBmysysconfig\fP" +.br +.ti -1c +.RI "char \fBconfigType\fP" +.br +.ti -1c +.RI "FilterMap \fBoptionFilters\fP" +.br +.ti -1c +.RI "FilterMap \fBcipherFilters\fP" +.br +.ti -1c +.RI "SWFilter * \fBgbfplain\fP" +.br +.ti -1c +.RI "SWFilter * \fBthmlplain\fP" +.br +.ti -1c +.RI "FilterList \fBcleanupFilters\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Private Methods" + +.in +1c +.ti -1c +.RI "void \fBcommonInit\fP (\fBSWConfig\fP *iconfig, \fBSWConfig\fP *isysconfig, bool autoload, SWFilterMgr *filterMgr)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +SWMgr is the main class of the Sword library. +.PP +SWmgr manages the installed modules, the filters and global options like footnotes or strong numbers. The class SWMgr is the most important class of Sword. It is used to manage the installed modules. It also manages the filters (Render-, Strip- and Rawfilters). +.PP +To get the \fBSWModule\fP objects of the instalelled modules use \fBModules\fP for this. +.PP +\fBSee also: \fP +.in +1c +\fBAddRawFilters\fP(), \fBAddRenderFilters\fP(), \fBAddStripFilters\fP() +.PP +\fBVersion: \fP +.in +1c +\fBId: \fP +.in +1c + swmgr.h,v 1.36 2002/01/04 23:36:32 scribe Exp +.PP +Definition at line 69 of file swmgr.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWMgr::SWMgr (\fBSWConfig\fP * iconfig = 0, \fBSWConfig\fP * isysconfig = 0, bool autoload = true, SWFilterMgr * filterMgr = 0)" +.PP +Constructor of SWMgr. +.PP +Parameters: +.in +1c +.TP +\fB\fIiconfig\fP\fP +.TP +\fB\fIisysconfig\fP\fP +.TP +\fB\fIautoload\fP\fP +If this bool is true the constructor starts loading the installed modules. If you reimplemented SWMgr you can set autoload=false to load the modules with your own reimplemented function. +.TP +\fB\fIfilterMgr\fP\fP +an SWFilterMgr subclass to use to manager filters on modules THIS WILL BE DELETED BY SWMgr +.SS "SWMgr::SWMgr (SWFilterMgr * filterMgr)" +.PP +Parameters: +.in +1c +.TP +\fB\fIfilterMgr\fP\fP +an SWFilterMgr subclass to use to manager filters on modules THIS WILL BE DELETED BY SWMgr +.SS "SWMgr::SWMgr (const char * iConfigPath, bool autoload = true, SWFilterMgr * filterMgr = 0)" +.PP +Parameters: +.in +1c +.TP +\fB\fIautoload\fP\fP +If this bool is true the constructor starts loading the installed modules. If you reimplemented SWMgr you can set autoload=false to load the modules with your own reimplemented function. +.TP +\fB\fIfilterMgr\fP\fP +an SWFilterMgr subclass to use to manager filters on modules THIS WILL BE DELETED BY SWMgr +.SS "virtual SWMgr::~SWMgr ()\fC [virtual]\fP" +.PP +The destructor of SWMgr. +.PP +This function cleans up the modules and deletes the created object. Destroy the SWMgr at last object in your application, because otherwise you may experience crashes because the \fBSWModule\fP objects become invalid. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual void SWMgr::AddEncodingFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [protected, virtual]\fP" +.PP +Adds the encoding filters which are defined in 'section' to the \fBSWModule\fP object 'module'. +.PP +Parameters: +.in +1c +.TP +\fB\fImodule\fP\fP +To this module the encoding filter(s) are added +.TP +\fB\fIsection\fP\fP +We use this section to get a list of filters we should apply to the module +.SS "virtual void SWMgr::AddRawFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [protected, virtual]\fP" +.PP +Adds the raw filters which are defined in 'section' to the \fBSWModule\fP object 'module'. +.PP +Parameters: +.in +1c +.TP +\fB\fImodule\fP\fP +To this module the raw filter(s) are added +.TP +\fB\fIsection\fP\fP +We use this section to get a list of filters we should apply to the module +.SS "virtual void SWMgr::AddRenderFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [protected, virtual]\fP" +.PP +Adds the render filters which are defined in 'section' to the \fBSWModule\fP object 'module'. +.PP +Parameters: +.in +1c +.TP +\fB\fImodule\fP\fP +To this module the render filter(s) are added +.TP +\fB\fIsection\fP\fP +We use this section to get a list of filters we should apply to the module +.SS "virtual void SWMgr::AddStripFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [protected, virtual]\fP" +.PP +Adds the strip filters which are defined in 'section' to the \fBSWModule\fP object 'module'. +.PP +Parameters: +.in +1c +.TP +\fB\fImodule\fP\fP +To this module the strip filter(s) are added +.TP +\fB\fIsection\fP\fP +We use this section to get a list of filters we should apply to the module +.SS "virtual void SWMgr::InstallScan (const char * dir)\fC [virtual]\fP" +.PP +Installs a scan for modules in the directory givan as parameter. +.PP +Parameters: +.in +1c +.TP +\fB\fIdir\fP\fP +The directory where new modules should be searched. +.SS "virtual void SWMgr::Load ()\fC [virtual]\fP" +.PP +Load the modules. +.PP +Reimplement this function to use your own Load function, for example to use your own filters. +.SS "virtual const char* SWMgr::getGlobalOption (const char * option)\fC [virtual]\fP" +.PP +Gives the value of the given option. +.PP +Parameters: +.in +1c +.TP +\fB\fIThe\fP\fP +option, which should be used to return the value of it +.PP +\fBReturns: \fP +.in +1c +The value of the given option +.SS "virtual const char* SWMgr::getGlobalOptionTip (const char * option)\fC [virtual]\fP" +.PP +Gives a description for the given option. +.PP +Parameters: +.in +1c +.TP +\fB\fIoption\fP\fP +The option, which should be used +.PP +\fBReturns: \fP +.in +1c +A description of the given option +.PP +\fBSee also: \fP +.in +1c +\fBsetGlobalOption\fP, \fBgetGlobalOption\fP, \fBgetGlobalOptions\fP +.SS "virtual OptionsList SWMgr::getGlobalOptions ()\fC [virtual]\fP" +.PP +A list of all availble options with the currently set values. +.PP +\fBReturns: \fP +.in +1c +This function returns a list of global options. +.SS "virtual signed char SWMgr::setCipherKey (const char * modName, const char * key)\fC [virtual]\fP" +.PP +Sets the cipher key for the given module. +.PP +This function updates the key at runtime, but it does not write to the config file. To write the new unlock key to the config file use code like this: +.PP +.nf + SectionMap::iterator section; + ConfigEntMap::iterator entry; + DIR *dir = opendir(configPath); + struct dirent *ent; + char* modFile; + if (dir) { // find and update .conf file + rewinddir(dir); + while ((ent = readdir(dir))) + { + if ((strcmp(ent->d_name, '.')) && (strcmp(ent->d_name, '..'))) + { + modFile = m_backend->configPath; + modFile += '/'; + modFile += ent->d_name; + SWConfig *myConfig = new SWConfig( modFile ); + section = myConfig->Sections.find( m_module->Name() ); + if ( section != myConfig->Sections.end() ) + { + entry = section->second.find('CipherKey'); + if (entry != section->second.end()) + { + entry->second = unlockKey;//set cipher key + myConfig->Save();//save config file + } + } + delete myConfig; + } + } + } + closedir(dir); +.fi +Parameters: +.in +1c +.TP +\fB\fImodName\fP\fP +For this module we change the unlockKey +.PP +\fBan key This is the new unlck key we use for te module.\fP +.in +1c +.SS "virtual void SWMgr::setGlobalOption (const char * option, const char * value)\fC [virtual]\fP" +.PP +Set a global option Set a global option using the parameters. +.PP +A global option could be for example footnotes. +.PP +Parameters: +.in +1c +.TP +\fB\fIoption\fP\fP +The name of the option, for which you want to change the value. Well known and often used values are 'Footnotes' or 'Strongs' +.TP +\fB\fIvalue\fP\fP +The value. Common values are 'On' and 'Off' +.SH "MEMBER DATA DOCUMENTATION" +.PP +.SS "ModMap SWMgr::Modules" +.PP +The map of available modules. +.PP +This map contains thew list of available modules in Sword. Here's an example how to got through the map and how toc ehck for the module type. +.PP +.nf + ModMap::iterator it; + SWModule* curMod = 0; + + for (it = Modules.begin(); it != Modules.end(); it++) { + curMod = (*it).second; + if (!strcmp(curMod->Type(), 'Biblical Texts')) { + //do something with curMod + } + else if (!strcmp(curMod->Type(), 'Commentaries')) { + //do something with curMod + } + else if (!strcmp(curMod->Type(), 'Lexicons / Dictionaries')) { + //do something with curMod + } + } +.fi + +.PP +Definition at line 170 of file swmgr.h. +.SS "\fBSWConfig\fP* SWMgr::config" +.PP +The global config object. +.PP +This is the global config object. It contains all items of all modules, so lookups of entries should use this config object. If you want to save a cipher key or other things to the module config file, DO NOT USE this object, because it would corrupt your config files after config->Save(). +.PP +If you want to write to the modules config file read the informtaion of \fBsetCipherKey\fP() for an example of this. +.PP +Definition at line 143 of file swmgr.h. +.SS "bool SWMgr::debug\fC [static]\fP" +.PP +Enable / Disable debug output on runtime Set this to true to get more verbose output of SWMgr at runtime. +.PP +Set it to false to get no debug output. The default is 'false'. +.PP +Definition at line 128 of file swmgr.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWModule.3 b/doc/api-documentation/man/man3/SWModule.3 new file mode 100644 index 0000000..65580e3 --- /dev/null +++ b/doc/api-documentation/man/man3/SWModule.3 @@ -0,0 +1,1131 @@ +.TH "SWModule" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWModule \- The class SWModule is the base class for all modules used in Sword. +.SH SYNOPSIS +.br +.PP +\fC#include <swmodule.h>\fP +.PP +Inherited by \fBSWCom\fP, \fBSWLD\fP, and \fBSWText\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWModule\fP (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fP *idisp=0, char *imodtype=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *modlang=0)" +.br +.RI "\fIInitializes data for instance of SWModule.\fP" +.ti -1c +.RI "virtual \fB~SWModule\fP ()" +.br +.RI "\fICleans up instance of SWModule.\fP" +.ti -1c +.RI "virtual char \fBError\fP ()" +.br +.RI "\fIGets and clears error status.\fP" +.ti -1c +.RI "virtual const bool \fBisUnicode\fP () const" +.br +.ti -1c +.RI "virtual const int \fBgetEntrySize\fP () const" +.br +.ti -1c +.RI "virtual char \fBSetKey\fP (const \fBSWKey\fP *ikey)" +.br +.RI "\fISets a key to this module for position to a particular record or set of records.\fP" +.ti -1c +.RI "virtual char \fBSetKey\fP (const \fBSWKey\fP &ikey)" +.br +.RI "\fISets the key of this module.\fP" +.ti -1c +.RI "virtual \fBSWKey\fP & \fBKey\fP () const" +.br +.RI "\fIGets the current module key.\fP" +.ti -1c +.RI "virtual char \fBKey\fP (const \fBSWKey\fP &ikey)" +.br +.RI "\fISets the current key of the module to ikey, and returns the keytext.\fP" +.ti -1c +.RI "virtual const char * \fBKeyText\fP (const char *imodtype=0)" +.br +.RI "\fISets/gets module KeyText.\fP" +.ti -1c +.RI "virtual char \fBDisplay\fP ()" +.br +.RI "\fICalls this modules display object and passes itself.\fP" +.ti -1c +.RI "virtual \fBSWDisplay\fP * \fBDisp\fP (\fBSWDisplay\fP *idisp=0)" +.br +.RI "\fISets/gets display driver.\fP" +.ti -1c +.RI "virtual char * \fBName\fP (const char *imodname=0)" +.br +.RI "\fISets/gets module name.\fP" +.ti -1c +.RI "virtual char * \fBDescription\fP (const char *imoddesc=0)" +.br +.RI "\fISets/gets module description.\fP" +.ti -1c +.RI "virtual char * \fBType\fP (const char *imodtype=0)" +.br +.RI "\fISets/gets module type.\fP" +.ti -1c +.RI "virtual char \fBDirection\fP (signed char newdir=-1)" +.br +.RI "\fISets/gets module direction.\fP" +.ti -1c +.RI "virtual char \fBEncoding\fP (signed char enc=-1)" +.br +.RI "\fISets/gets module encoding.\fP" +.ti -1c +.RI "virtual char \fBMarkup\fP (signed char enc=-1)" +.br +.RI "\fISets/gets module markup.\fP" +.ti -1c +.RI "virtual char * \fBLang\fP (const char *imodlang=0)" +.br +.RI "\fISets/gets module language.\fP" +.ti -1c +.RI "virtual \fBListKey\fP & \fBSearch\fP (const char *istr, int searchType=0, int flags=0, \fBSWKey\fP *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0)" +.br +.RI "\fISearches a module for a string.\fP" +.ti -1c +.RI "virtual signed char \fBcreateSearchFramework\fP ()" +.br +.ti -1c +.RI "virtual bool \fBhasSearchFramework\fP ()" +.br +.ti -1c +.RI "virtual bool \fBisSearchOptimallySupported\fP (const char *istr, int searchType, int flags, \fBSWKey\fP *scope)" +.br +.RI "\fICheck if the search is optimally supported (e.g.\fP" +.ti -1c +.RI "virtual \fBSWKey\fP * \fBCreateKey\fP ()" +.br +.RI "\fIAllocates a key of specific type for module The different reimplementatiosn of SWModule (e.g.\fP" +.ti -1c +.RI "virtual \fBoperator char *\fP ()" +.br +.RI "\fIRenders and returns the current module text.\fP" +.ti -1c +.RI "virtual char * \fBgetRawEntry\fP ()=0" +.br +.RI "\fIThis function is reimplemented by the different kinds of module objects.\fP" +.ti -1c +.RI "virtual \fBoperator SWKey &\fP ()" +.br +.RI "\fICast operator to cast to a \fBSWKey\fP reference.\fP" +.ti -1c +.RI "virtual \fBoperator SWKey *\fP ()" +.br +.RI "\fIOperator to cast to an \fBSWKey\fP pointer.\fP" +.ti -1c +.RI "virtual bool \fBisWritable\fP ()" +.br +.RI "\fIIs the module writable? :).\fP" +.ti -1c +.RI "virtual SWModule & \fBsetentry\fP (const char *inbuf, long len)" +.br +.RI "\fIModify the current module entry text only if module \fBisWritable\fP.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator<<\fP (const char *)" +.br +.RI "\fIModify the current module entry text only if module \fBisWritable\fP.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator<<\fP (const \fBSWKey\fP *)" +.br +.RI "\fILink the current module entry to another module entry only if module \fBisWritable\fP.\fP" +.ti -1c +.RI "virtual void \fBdeleteEntry\fP ()" +.br +.RI "\fIDelete current module entry - only if module \fBisWritable\fP.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator-=\fP (int decrement)" +.br +.RI "\fIDecrements module key a number of entries.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator+=\fP (int increment)" +.br +.RI "\fIIncrements module key a number of entries.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator++\fP (int)" +.br +.RI "\fIIncrements module key by 1 entry.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator--\fP (int)" +.br +.RI "\fIDecrements module key by 1 entry.\fP" +.ti -1c +.RI "virtual SWModule & \fBoperator=\fP (SW_POSITION p)" +.br +.RI "\fIPositions this modules to an entry.\fP" +.ti -1c +.RI "virtual SWModule & \fBAddRenderFilter\fP (SWFilter *newfilter)" +.br +.RI "\fIAdds a RenderFilter to this module's.\fP" +.ti -1c +.RI "virtual SWModule & \fBRemoveRenderFilter\fP (SWFilter *oldfilter)" +.br +.RI "\fIRemoves a RenderFilter from this module's.\fP" +.ti -1c +.RI "virtual SWModule & \fBReplaceRenderFilter\fP (SWFilter *oldfilter, SWFilter *newfilter)" +.br +.RI "\fIReplaces a RenderFilter in this module's.\fP" +.ti -1c +.RI "virtual void \fBrenderFilter\fP (char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIRenderFilter a text buffer.\fP" +.ti -1c +.RI "virtual SWModule & \fBAddEncodingFilter\fP (SWFilter *newfilter)" +.br +.RI "\fIAdds an EncodingFilter to this module's.\fP" +.ti -1c +.RI "virtual SWModule & \fBRemoveEncodingFilter\fP (SWFilter *oldfilter)" +.br +.RI "\fIRemoves an EncodingFilter from this module's.\fP" +.ti -1c +.RI "virtual SWModule & \fBReplaceEncodingFilter\fP (SWFilter *oldfilter, SWFilter *newfilter)" +.br +.RI "\fIReplaces an EncodingFilter in this module's.\fP" +.ti -1c +.RI "virtual void \fBencodingFilter\fP (char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIencodingFilter a text buffer.\fP" +.ti -1c +.RI "virtual SWModule & \fBAddStripFilter\fP (SWFilter *newfilter)" +.br +.RI "\fIAdds a StripFilter to this module's stripfilters queue.\fP" +.ti -1c +.RI "virtual void \fBstripFilter\fP (char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIStripFilter a text buffer.\fP" +.ti -1c +.RI "virtual SWModule & \fBAddRawFilter\fP (SWFilter *newfilter)" +.br +.RI "\fIAdds a RawFilter to this module's rawfilters queue.\fP" +.ti -1c +.RI "virtual void \fBfilterBuffer\fP (FilterList *filters, char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIFilterBuffer a text buffer.\fP" +.ti -1c +.RI "virtual void \fBrawFilter\fP (char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIRawFilter a text buffer.\fP" +.ti -1c +.RI "virtual SWModule & \fBAddOptionFilter\fP (SWFilter *newfilter)" +.br +.RI "\fIAdds an OptionFilter to this module's optionfilters queue.\fP" +.ti -1c +.RI "virtual void \fBoptionFilter\fP (char *buf, long size, \fBSWKey\fP *\fBkey\fP)" +.br +.RI "\fIOptionFilter a text buffer.\fP" +.ti -1c +.RI "virtual const char * \fBStripText\fP (char *buf=0, int len=-1)" +.br +.RI "\fIcalls all StripFilters on buffer or current text.\fP" +.ti -1c +.RI "virtual const char * \fBRenderText\fP (char *buf=0, int len=-1)" +.br +.RI "\fIcalls all RenderFilters on buffer or current text.\fP" +.ti -1c +.RI "virtual const char * \fBStripText\fP (\fBSWKey\fP *tmpKey)" +.br +.RI "\fIcalls all StripFilters on current text.\fP" +.ti -1c +.RI "virtual const char * \fBRenderText\fP (\fBSWKey\fP *tmpKey)" +.br +.RI "\fIcalls all RenderFilters on current text.\fP" +.in -1c +.SS "Static Public Methods" + +.in +1c +.ti -1c +.RI "void \fBnullPercent\fP (char percent, void *userData)" +.br +.RI "\fIThis is the default callback function for searching.\fP" +.ti -1c +.RI "signed char \fBcreateModule\fP (const char *)" +.br +.RI "\fICreates a new module.\fP" +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "bool \fBterminateSearch\fP" +.br +.RI "\fISet this bool to false to terminate the search which is executed by this module (\fBSearch\fP).\fP" +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "char \fBerror\fP" +.br +.ti -1c +.RI "\fBSWKey\fP * \fBkey\fP" +.br +.RI "\fIthe current key.\fP" +.ti -1c +.RI "\fBListKey\fP \fBlistkey\fP" +.br +.ti -1c +.RI "char * \fBmodname\fP" +.br +.ti -1c +.RI "char * \fBmoddesc\fP" +.br +.ti -1c +.RI "char * \fBmodtype\fP" +.br +.ti -1c +.RI "char * \fBmodlang\fP" +.br +.ti -1c +.RI "char \fBdirection\fP" +.br +.ti -1c +.RI "char \fBmarkup\fP" +.br +.ti -1c +.RI "char \fBencoding\fP" +.br +.ti -1c +.RI "\fBSWDisplay\fP * \fBdisp\fP" +.br +.RI "\fIthis module's display object.\fP" +.ti -1c +.RI "char * \fBentrybuf\fP" +.br +.ti -1c +.RI "FilterList * \fBstripFilters\fP" +.br +.RI "\fIexecuted to remove all markup (for searches).\fP" +.ti -1c +.RI "FilterList * \fBrawFilters\fP" +.br +.RI "\fIexecuted immediately upon fileread.\fP" +.ti -1c +.RI "FilterList * \fBrenderFilters\fP" +.br +.RI "\fIexecuted to format for display.\fP" +.ti -1c +.RI "FilterList * \fBoptionFilters\fP" +.br +.RI "\fIexecuted to change markup to user prefs.\fP" +.ti -1c +.RI "FilterList * \fBencodingFilters\fP" +.br +.RI "\fIexecuted to decode text for display.\fP" +.ti -1c +.RI "bool \fBrender\fP" +.br +.ti -1c +.RI "int \fBentrySize\fP" +.br +.in -1c +.SS "Static Protected Attributes" + +.in +1c +.ti -1c +.RI "\fBSWDisplay\fP \fBrawdisp\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +The class SWModule is the base class for all modules used in Sword. +.PP +It provides functions to look up a text passage, to search in the module, to switch on/off the state of optional things like Strong's numbers or footnotes. +.PP +SWModule has also functions to write to the data files. This might be useful in future for frontend authors to support user-created modules. +.PP +Definition at line 57 of file swmodule.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWModule::SWModule (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fP * idisp = 0, char * imodtype = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char * modlang = 0)" +.PP +Initializes data for instance of SWModule. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodname\fP\fP +Internal name for module; see also \fBName\fP +.TP +\fB\fIimoddesc\fP\fP +Name to display to user for module; see also \fBDescription\fP +.TP +\fB\fIidisp\fP\fP +Display object to use for displaying see also \fBDisp\fP +.TP +\fB\fIimodtype\fP\fP +Type of Module (All modules will be displayed with others of same type under their modtype heading) see also \fBType\fP +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual SWModule& SWModule::AddEncodingFilter (SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Adds an EncodingFilter to this module's. +.PP +\fBSee also: \fP +.in +1c +encodingfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fInewfilter\fP\fP +the filter to add +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 430 of file swmodule.h. +.SS "virtual SWModule& SWModule::AddOptionFilter (SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Adds an OptionFilter to this module's optionfilters queue. +.PP +Parameters: +.in +1c +.TP +\fB\fInewfilter\fP\fP +the filter to add +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 515 of file swmodule.h. +.SS "virtual SWModule& SWModule::AddRawFilter (SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Adds a RawFilter to this module's rawfilters queue. +.PP +Parameters: +.in +1c +.TP +\fB\fInewfilter\fP\fP +the filter to add +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 484 of file swmodule.h. +.SS "virtual SWModule& SWModule::AddRenderFilter (SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Adds a RenderFilter to this module's. +.PP +\fBSee also: \fP +.in +1c +renderfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fInewfilter\fP\fP +the filter to add +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 393 of file swmodule.h. +.SS "virtual SWModule& SWModule::AddStripFilter (SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Adds a StripFilter to this module's stripfilters queue. +.PP +Parameters: +.in +1c +.TP +\fB\fInewfilter\fP\fP +the filter to add +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 467 of file swmodule.h. +.SS "virtual \fBSWKey\fP* SWModule::CreateKey ()\fC [virtual]\fP" +.PP +Allocates a key of specific type for module The different reimplementatiosn of SWModule (e.g. +.PP +\fBSWText\fP) support \fBSWKey\fP implementations, which support special. This functions returns a \fBSWKey\fP object which works with the current implementation of SWModule. For example for the \fBSWText\fP class it returns a \fBVerseKey\fP object. +.PP +\fBSee also: \fP +.in +1c +\fBVerseKey\fP, \fBListKey\fP, \fBSWText\fP, \fBSWLD\fP, \fBSWCom\fP +.PP +\fBReturns: \fP +.in +1c +pointer to allocated key +.PP +Reimplemented in \fBSWCom\fP, \fBSWLD\fP, and \fBSWText\fP. +.SS "virtual char* SWModule::Description (const char * imoddesc = 0)\fC [virtual]\fP" +.PP +Sets/gets module description. +.PP +Parameters: +.in +1c +.TP +\fB\fIimoddesc\fP\fP +value which to set moddesc; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to moddesc +.SS "virtual char SWModule::Direction (signed char newdir = -1)\fC [virtual]\fP" +.PP +Sets/gets module direction. +.PP +Parameters: +.in +1c +.TP +\fB\fInewdir\fP\fP +value which to set direction; [-1] - only get +.PP +\fBReturns: \fP +.in +1c +char direction +.SS "virtual \fBSWDisplay\fP* SWModule::Disp (\fBSWDisplay\fP * idisp = 0)\fC [virtual]\fP" +.PP +Sets/gets display driver. +.PP +Parameters: +.in +1c +.TP +\fB\fIidisp\fP\fP +value which to set disp; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to disp +.SS "virtual char SWModule::Display ()\fC [virtual]\fP" +.PP +Calls this modules display object and passes itself. +.PP +\fBReturns: \fP +.in +1c +error status +.SS "virtual char SWModule::Encoding (signed char enc = -1)\fC [virtual]\fP" +.PP +Sets/gets module encoding. +.PP +Parameters: +.in +1c +.TP +\fB\fInewdir\fP\fP +value which to set encoding; [-1] - only get +.PP +\fBReturns: \fP +.in +1c +char encoding +.SS "virtual char SWModule::Error ()\fC [virtual]\fP" +.PP +Gets and clears error status. +.PP +\fBReturns: \fP +.in +1c +error status +.SS "virtual char SWModule::Key (const \fBSWKey\fP & ikey)\fC [inline, virtual]\fP" +.PP +Sets the current key of the module to ikey, and returns the keytext. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +new current key for the module +.PP +\fBReturns: \fP +.in +1c +the keytext of the current module key +.PP +Definition at line 168 of file swmodule.h. +.SS "virtual \fBSWKey\fP& SWModule::Key () const\fC [inline, virtual]\fP" +.PP +Gets the current module key. +.PP +\fBReturns: \fP +.in +1c +the current key of this module +.PP +Definition at line 159 of file swmodule.h. +.SS "virtual const char* SWModule::KeyText (const char * ikeytext = 0)\fC [virtual]\fP" +.PP +Sets/gets module KeyText. +.PP +Parameters: +.in +1c +.TP +\fB\fIikeytext\fP\fP +value which to set keytext; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to keytext +.PP +Reimplemented in \fBSWLD\fP. +.SS "virtual char* SWModule::Lang (const char * imodlang = 0)\fC [virtual]\fP" +.PP +Sets/gets module language. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodlang\fP\fP +value which to set modlang; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to modlang +.SS "virtual char SWModule::Markup (signed char enc = -1)\fC [virtual]\fP" +.PP +Sets/gets module markup. +.PP +Parameters: +.in +1c +.TP +\fB\fInewdir\fP\fP +value which to set markup; [-1] - only get +.PP +\fBReturns: \fP +.in +1c +char markup +.SS "virtual char* SWModule::Name (const char * imodname = 0)\fC [virtual]\fP" +.PP +Sets/gets module name. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodname\fP\fP +value which to set modname; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to modname +.SS "virtual SWModule& SWModule::RemoveEncodingFilter (SWFilter * oldfilter)\fC [inline, virtual]\fP" +.PP +Removes an EncodingFilter from this module's. +.PP +\fBSee also: \fP +.in +1c +encodingfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fIoldfilter\fP\fP +the filter to remove +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 438 of file swmodule.h. +.SS "virtual SWModule& SWModule::RemoveRenderFilter (SWFilter * oldfilter)\fC [inline, virtual]\fP" +.PP +Removes a RenderFilter from this module's. +.PP +\fBSee also: \fP +.in +1c +renderfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fIoldfilter\fP\fP +the filter to remove +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 401 of file swmodule.h. +.SS "virtual const char* SWModule::RenderText (\fBSWKey\fP * tmpKey)\fC [virtual]\fP" +.PP +calls all RenderFilters on current text. +.PP +Parameters: +.in +1c +.TP +\fB\fItmpKey\fP\fP +key to use to grab text +.PP +\fBReturns: \fP +.in +1c +this module's text at specified key location massaged by Render filters +.SS "virtual const char* SWModule::RenderText (char * buf = 0, int len = -1)\fC [virtual]\fP" +.PP +calls all RenderFilters on buffer or current text. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +buffer to Render instead of current module position; if buf is NULL, the current text will be used +.TP +\fB\fIlen\fP\fP +max len of buf OR current text -- will be applied anyway +.PP +\fBReturns: \fP +.in +1c +this module's text at specified key location massaged by Render filters +.SS "virtual SWModule& SWModule::ReplaceEncodingFilter (SWFilter * oldfilter, SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Replaces an EncodingFilter in this module's. +.PP +\fBSee also: \fP +.in +1c +encodingfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fIoldfilter\fP\fP +the filter to remove +.TP +\fB\fInewfilter\fP\fP +the filter to add in its place +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 447 of file swmodule.h. +.SS "virtual SWModule& SWModule::ReplaceRenderFilter (SWFilter * oldfilter, SWFilter * newfilter)\fC [inline, virtual]\fP" +.PP +Replaces a RenderFilter in this module's. +.PP +\fBSee also: \fP +.in +1c +renderfilters queue +.PP +Parameters: +.in +1c +.TP +\fB\fIoldfilter\fP\fP +the filter to remove +.TP +\fB\fInewfilter\fP\fP +the filter to add in its place +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 410 of file swmodule.h. +.SS "virtual \fBListKey\fP& SWModule::Search (const char * istr, int searchType = 0, int flags = 0, \fBSWKey\fP * scope = 0, bool * justCheckIfSupported = 0, void(* percent)(char, void *) = &nullPercent, void * percentUserData = 0)\fC [virtual]\fP" +.PP +Searches a module for a string. +.PP +Parameters: +.in +1c +.TP +\fB\fIistr\fP\fP +string for which to search +.TP +\fB\fIsearchType\fP\fP +type of search to perform <=0 ->regex; 1->phrase; 2->multiword; +.TP +\fB\fIflags\fP\fP +options flags for search +.TP +\fB\fIjustCheckIfSupported\fP\fP +if set, don't search, only tell if this function supports requested search. +.PP +\fBReturns: \fP +.in +1c +listkey set to verses that contain istr +.PP +Referenced by isSearchOptimallySupported(). +.PP +.SS "virtual char SWModule::SetKey (const \fBSWKey\fP & ikey)\fC [virtual]\fP" +.PP +Sets the key of this module. +.PP +Similair to +.PP +\fBSee also: \fP +.in +1c +\fBSetKey\fP(const SWKey*) . +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +The \fBSWKey\fP which should be used as new key. +.PP +\fBReturns: \fP +.in +1c +Error status +.SS "virtual char SWModule::SetKey (const \fBSWKey\fP * ikey)\fC [virtual]\fP" +.PP +Sets a key to this module for position to a particular record or set of records. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +key with which to set this module +.PP +\fBReturns: \fP +.in +1c +error status +.PP +Referenced by Key(). +.PP +.SS "virtual const char* SWModule::StripText (\fBSWKey\fP * tmpKey)\fC [virtual]\fP" +.PP +calls all StripFilters on current text. +.PP +Parameters: +.in +1c +.TP +\fB\fItmpKey\fP\fP +key to use to grab text +.PP +\fBReturns: \fP +.in +1c +this module's text at specified key location massaged by Strip filters +.SS "virtual const char* SWModule::StripText (char * buf = 0, int len = -1)\fC [virtual]\fP" +.PP +calls all StripFilters on buffer or current text. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +buf to massage instead of current module position; if buf is NULL, the current text will be used +.TP +\fB\fIlen\fP\fP +max len of buf OR current text -- will be applied anyway +.PP +\fBReturns: \fP +.in +1c +this module's text at specified key location massaged by Strip filters +.SS "virtual char* SWModule::Type (const char * imodtype = 0)\fC [virtual]\fP" +.PP +Sets/gets module type. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodtype\fP\fP +value which to set modtype; [0] - only get +.PP +\fBReturns: \fP +.in +1c +pointer to modtype +.SS "signed char SWModule::createModule (const char * path)\fC [inline, static]\fP" +.PP +Creates a new module. +.PP +Parameters: +.in +1c +.TP +\fB\fIpath\fP\fP +The first parameter is path of the new module +.PP +\fBReturns: \fP +.in +1c +error +.PP +Definition at line 328 of file swmodule.h. +.SS "virtual void SWModule::encodingFilter (char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +encodingFilter a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 460 of file swmodule.h. +.SS "virtual void SWModule::filterBuffer (FilterList * filters, char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +FilterBuffer a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIfilters\fP\fP +the FilterList of filters to iterate +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 495 of file swmodule.h. +.PP +Referenced by encodingFilter(), optionFilter(), rawFilter(), renderFilter(), and stripFilter(). +.PP +.SS "virtual const int SWModule::getEntrySize () const\fC [inline, virtual]\fP" +.PP +\fBReturns: \fP +.in +1c +The size of the current entry. +.PP +Definition at line 141 of file swmodule.h. +.SS "virtual char* SWModule::getRawEntry ()\fC [pure virtual]\fP" +.PP +This function is reimplemented by the different kinds of module objects. +.PP +\fBReturns: \fP +.in +1c +the raw module text of the current entry +.SS "virtual bool SWModule::isSearchOptimallySupported (const char * istr, int searchType, int flags, \fBSWKey\fP * scope)\fC [inline, virtual]\fP" +.PP +Check if the search is optimally supported (e.g. +.PP +if index files are presnt and working) This function checks whether the search framework may work in the best way. +.PP +\fBReturns: \fP +.in +1c +True if the the search is optimally supported, false if it's not working in the best way. +.PP +Definition at line 274 of file swmodule.h. +.SS "virtual const bool SWModule::isUnicode () const\fC [inline, virtual]\fP" +.PP +\fBReturns: \fP +.in +1c +True if this module is encoded in Unicode, otherwise return false. +.PP +Definition at line 137 of file swmodule.h. +.SS "virtual bool SWModule::isWritable ()\fC [inline, virtual]\fP" +.PP +Is the module writable? :). +.PP +\fBReturns: \fP +.in +1c +yes or no +.PP +Definition at line 321 of file swmodule.h. +.SS "void SWModule::nullPercent (char percent, void * userData)\fC [static]\fP" +.PP +This is the default callback function for searching. +.PP +This function is a placeholder and does nothing. You can define your own function for search progress evaluation, and pass it over to \fBSearch\fP. +.SS "virtual SWModule::operator \fBSWKey\fP & ()\fC [inline, virtual]\fP" +.PP +Cast operator to cast to a \fBSWKey\fP reference. +.PP +This operator may be used to cast this module to a \fBSWKey\fP object. +.PP +\fBSee also: \fP +.in +1c +\fBSWKey\fP*() +.PP +Definition at line 301 of file swmodule.h. +.SS "virtual SWModule::operator \fBSWKey\fP * ()\fC [inline, virtual]\fP" +.PP +Operator to cast to an \fBSWKey\fP pointer. +.PP +This function may be used to cast this object to an \fBSWKey\fP pointer. +.PP +.nf + //we assume here that SWModule* module is already defined and valid. + SWKey* currentKey = (SWKey*)module; + // do something with currentKey (e.g. print out on screen) +.fi + +.PP +Definition at line 312 of file swmodule.h. +.SS "virtual SWModule::operator char * ()\fC [virtual]\fP" +.PP +Renders and returns the current module text. +.PP +\fBReturns: \fP +.in +1c +the rendered current module text +.SS "virtual SWModule& SWModule::operator+= (int increment)\fC [virtual]\fP" +.PP +Increments module key a number of entries. +.PP +Parameters: +.in +1c +.TP +\fB\fIincrement\fP\fP +Number of entries to jump forward +.PP +\fBReturns: \fP +.in +1c +*this +.SS "virtual SWModule& SWModule::operator-= (int decrement)\fC [virtual]\fP" +.PP +Decrements module key a number of entries. +.PP +Parameters: +.in +1c +.TP +\fB\fIdecrement\fP\fP +Number of entries to jump backward +.PP +\fBReturns: \fP +.in +1c +*this +.SS "virtual SWModule& SWModule::operator<< (const \fBSWKey\fP * linkKey)\fC [inline, virtual]\fP" +.PP +Link the current module entry to another module entry only if module \fBisWritable\fP. +.PP +.TP +\fBReturns: \fP +.in +1c +*this +.PP +.PP +Definition at line 349 of file swmodule.h. +.SS "virtual SWModule& SWModule::operator<< (const char * inbuf)\fC [inline, virtual]\fP" +.PP +Modify the current module entry text only if module \fBisWritable\fP. +.PP +.TP +\fBReturns: \fP +.in +1c +*this +.PP +.PP +Definition at line 342 of file swmodule.h. +.SS "virtual SWModule& SWModule::operator= (SW_POSITION pos)\fC [virtual]\fP" +.PP +Positions this modules to an entry. +.PP +Parameters: +.in +1c +.TP +\fB\fIp\fP\fP +position (e.g. TOP, BOTTOM) +.PP +\fBReturns: \fP +.in +1c +*this +.SS "virtual void SWModule::optionFilter (char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +OptionFilter a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 525 of file swmodule.h. +.SS "virtual void SWModule::rawFilter (char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +RawFilter a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 507 of file swmodule.h. +.SS "virtual void SWModule::renderFilter (char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +RenderFilter a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 423 of file swmodule.h. +.SS "virtual SWModule& SWModule::setentry (const char * inbuf, long len)\fC [inline, virtual]\fP" +.PP +Modify the current module entry text only if module \fBisWritable\fP. +.PP +.TP +\fBReturns: \fP +.in +1c +*this +.PP +.PP +Definition at line 335 of file swmodule.h. +.SS "virtual void SWModule::stripFilter (char * buf, long size, \fBSWKey\fP * key)\fC [inline, virtual]\fP" +.PP +StripFilter a text buffer. +.PP +Parameters: +.in +1c +.TP +\fB\fIbuf\fP\fP +the buffer to filter +.TP +\fB\fIsize\fP\fP +the allocated size of the buffer +.TP +\fB\fIkey\fP\fP +key location from where this buffer was extracted +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Definition at line 477 of file swmodule.h. +.SH "MEMBER DATA DOCUMENTATION" +.PP +.SS "bool SWModule::terminateSearch" +.PP +Set this bool to false to terminate the search which is executed by this module (\fBSearch\fP). +.PP +This is useful for threaded applications to terminate the search in another thread. +.PP +Definition at line 112 of file swmodule.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWObject.3 b/doc/api-documentation/man/man3/SWObject.3 new file mode 100644 index 0000000..cd24894 --- /dev/null +++ b/doc/api-documentation/man/man3/SWObject.3 @@ -0,0 +1,49 @@ +.TH "SWObject" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWObject \- Base class for major Sword classes. +.SH SYNOPSIS +.br +.PP +\fC#include <swobject.h>\fP +.PP +Inherited by \fBSWKey\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "const \fBSWClass\fP * \fBgetClass\fP () const" +.br +.RI "\fIUse this to get the class definition and inheritance order.\fP" +.in -1c +.SS "Protected Attributes" + +.in +1c +.ti -1c +.RI "\fBSWClass\fP * \fBmyclass\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +Base class for major Sword classes. +.PP +SWObject is the base class for major Sword classes like \fBSWKey\fP. It is used because dynamic_cast is not available on all plattforms supported by Sword. Use SWDYNAMIC_CAST(classname, object) instead of dynamic_cast<classname>(object). +.PP +Definition at line 41 of file swobject.h. +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "const \fBSWClass\fP* SWObject::getClass () const\fC [inline]\fP" +.PP +Use this to get the class definition and inheritance order. +.PP +\fBReturns: \fP +.in +1c +The class definition of this object +.PP +Definition at line 49 of file swobject.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/SWText.3 b/doc/api-documentation/man/man3/SWText.3 new file mode 100644 index 0000000..60fc4af --- /dev/null +++ b/doc/api-documentation/man/man3/SWText.3 @@ -0,0 +1,55 @@ +.TH "SWText" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWText \- The basis for all text modules. +.SH SYNOPSIS +.br +.PP +\fC#include <swtext.h>\fP +.PP +Inherits \fBSWModule\fP. +.PP +Inherited by EchoMod, RawGBF, RawText, and zText. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWText\fP (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fP *idisp=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *ilang=0)" +.br +.RI "\fIInitializes data for instance of SWText.\fP" +.ti -1c +.RI "virtual \fB~SWText\fP ()" +.br +.ti -1c +.RI "virtual \fBSWKey\fP * \fBCreateKey\fP ()" +.br +.RI "\fICreate the correct key (\fBVerseKey\fP) for use with SWText.\fP" +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +The basis for all text modules. +.PP +Definition at line 34 of file swtext.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWText::SWText (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fP * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char * ilang = 0)" +.PP +Initializes data for instance of SWText. +.PP +Parameters: +.in +1c +.TP +\fB\fIimodname\fP\fP +Internal name for module +.TP +\fB\fIimoddesc\fP\fP +Name to display to user for module +.TP +\fB\fIidisp\fP\fP +Display object to use for displaying + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/StrKey.3 b/doc/api-documentation/man/man3/StrKey.3 new file mode 100644 index 0000000..4f1f215 --- /dev/null +++ b/doc/api-documentation/man/man3/StrKey.3 @@ -0,0 +1,60 @@ +.TH "StrKey" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +StrKey \- a standard string key class (used for modules that index on single strings (eg. +.SH SYNOPSIS +.br +.PP +\fC#include <strkey.h>\fP +.PP +Inherits \fBSWKey\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBStrKey\fP (const char *ikey=0)" +.br +.RI "\fIinitializes instance of StrKey.\fP" +.ti -1c +.RI "virtual \fB~StrKey\fP ()" +.br +.RI "\fIcleans up instance of StrKey.\fP" +.in -1c +.SS "Private Methods" + +.in +1c +.ti -1c +.RI "void \fBinit\fP ()" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "\fBSWClass\fP \fBclassdef\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +a standard string key class (used for modules that index on single strings (eg. +.PP +cities, names, words, etc.) +.PP +Definition at line 35 of file strkey.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "StrKey::StrKey (const char * ikey = 0)" +.PP +initializes instance of StrKey. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +text key (word, city, name, etc.) + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLFootnotes.3 b/doc/api-documentation/man/man3/ThMLFootnotes.3 new file mode 100644 index 0000000..1da5684 --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLFootnotes.3 @@ -0,0 +1,75 @@ +.TH "ThMLFootnotes" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLFootnotes \- This Filter shows/hides footnotes in a ThML text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlfootnotes.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLFootnotes\fP ()" +.br +.ti -1c +.RI "virtual \fB~ThMLFootnotes\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides footnotes in a ThML text. +.PP +Definition at line 30 of file thmlfootnotes.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLGBF.3 b/doc/api-documentation/man/man3/ThMLGBF.3 new file mode 100644 index 0000000..44207b6 --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLGBF.3 @@ -0,0 +1,31 @@ +.TH "ThMLGBF" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLGBF \- this filter converts ThML text to GBF text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlgbf.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLGBF\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen=-1)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts ThML text to GBF text. +.PP +Definition at line 30 of file thmlgbf.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLHTML.3 b/doc/api-documentation/man/man3/ThMLHTML.3 new file mode 100644 index 0000000..31bf9f2 --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLHTML.3 @@ -0,0 +1,35 @@ +.TH "ThMLHTML" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLHTML \- this filter converts ThML text to HTML text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlhtml.h>\fP +.PP +Inherits SWBasicFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLHTML\fP ()" +.br +.in -1c +.SS "Protected Methods" + +.in +1c +.ti -1c +.RI "virtual bool \fBhandleToken\fP (char **buf, const char *token, DualStringMap &userData)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts ThML text to HTML text. +.PP +Definition at line 28 of file thmlhtml.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLHTMLHREF.3 b/doc/api-documentation/man/man3/ThMLHTMLHREF.3 new file mode 100644 index 0000000..22f2f4c --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLHTMLHREF.3 @@ -0,0 +1,35 @@ +.TH "ThMLHTMLHREF" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLHTMLHREF \- this filter converts ThML text to HTML text with hrefs. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlhtmlhref.h>\fP +.PP +Inherits SWBasicFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLHTMLHREF\fP ()" +.br +.in -1c +.SS "Protected Methods" + +.in +1c +.ti -1c +.RI "virtual bool \fBhandleToken\fP (char **buf, const char *token, DualStringMap &userData)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts ThML text to HTML text with hrefs. +.PP +Definition at line 26 of file thmlhtmlhref.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLHeadings.3 b/doc/api-documentation/man/man3/ThMLHeadings.3 new file mode 100644 index 0000000..10ce5d6 --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLHeadings.3 @@ -0,0 +1,75 @@ +.TH "ThMLHeadings" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLHeadings \- This Filter shows/hides headings in a ThML text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlheadings.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLHeadings\fP ()" +.br +.ti -1c +.RI "virtual \fB~ThMLHeadings\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides headings in a ThML text. +.PP +Definition at line 30 of file thmlheadings.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLLemma.3 b/doc/api-documentation/man/man3/ThMLLemma.3 new file mode 100644 index 0000000..b8ede44 --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLLemma.3 @@ -0,0 +1,75 @@ +.TH "ThMLLemma" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLLemma \- This Filter shows/hides lemmas in a ThML text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmllemma.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLLemma\fP ()" +.br +.ti -1c +.RI "virtual \fB~ThMLLemma\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides lemmas in a ThML text. +.PP +Definition at line 30 of file thmllemma.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLMorph.3 b/doc/api-documentation/man/man3/ThMLMorph.3 new file mode 100644 index 0000000..cfaa05d --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLMorph.3 @@ -0,0 +1,75 @@ +.TH "ThMLMorph" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLMorph \- This Filter shows/hides morph tags in a ThML text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlmorph.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLMorph\fP ()" +.br +.ti -1c +.RI "virtual \fB~ThMLMorph\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides morph tags in a ThML text. +.PP +Definition at line 29 of file thmlmorph.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLOLB.3 b/doc/api-documentation/man/man3/ThMLOLB.3 new file mode 100644 index 0000000..bcb1b12 --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLOLB.3 @@ -0,0 +1,31 @@ +.TH "ThMLOLB" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLOLB \- this filter converts ThML text to OLB text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlolb.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLOLB\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen=-1)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts ThML text to OLB text. +.PP +Definition at line 30 of file thmlolb.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLPlain.3 b/doc/api-documentation/man/man3/ThMLPlain.3 new file mode 100644 index 0000000..17542c1 --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLPlain.3 @@ -0,0 +1,31 @@ +.TH "ThMLPlain" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLPlain \- this filter converts ThML text to plain text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlplain.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLPlain\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen=-1)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts ThML text to plain text. +.PP +Definition at line 30 of file thmlplain.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLRTF.3 b/doc/api-documentation/man/man3/ThMLRTF.3 new file mode 100644 index 0000000..d727a8c --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLRTF.3 @@ -0,0 +1,35 @@ +.TH "ThMLRTF" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLRTF \- this filter converts ThML text to RTF text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlrtf.h>\fP +.PP +Inherits SWBasicFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLRTF\fP ()" +.br +.in -1c +.SS "Protected Methods" + +.in +1c +.ti -1c +.RI "virtual bool \fBhandleToken\fP (char **buf, const char *token, DualStringMap &userData)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +this filter converts ThML text to RTF text. +.PP +Definition at line 30 of file thmlrtf.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLScripref.3 b/doc/api-documentation/man/man3/ThMLScripref.3 new file mode 100644 index 0000000..5a6d5d2 --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLScripref.3 @@ -0,0 +1,75 @@ +.TH "ThMLScripref" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLScripref \- This Filter shows/hides scripture references in a ThML text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlscripref.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLScripref\fP ()" +.br +.ti -1c +.RI "virtual \fB~ThMLScripref\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides scripture references in a ThML text. +.PP +Definition at line 30 of file thmlscripref.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/ThMLStrongs.3 b/doc/api-documentation/man/man3/ThMLStrongs.3 new file mode 100644 index 0000000..fea1eeb --- /dev/null +++ b/doc/api-documentation/man/man3/ThMLStrongs.3 @@ -0,0 +1,75 @@ +.TH "ThMLStrongs" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLStrongs \- This Filter shows/hides strong's numbers in a ThML text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlstrongs.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBThMLStrongs\fP ()" +.br +.ti -1c +.RI "virtual \fB~ThMLStrongs\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides strong's numbers in a ThML text. +.PP +Definition at line 30 of file thmlstrongs.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/UTF16UTF8.3 b/doc/api-documentation/man/man3/UTF16UTF8.3 new file mode 100644 index 0000000..2e7d184 --- /dev/null +++ b/doc/api-documentation/man/man3/UTF16UTF8.3 @@ -0,0 +1,31 @@ +.TH "UTF16UTF8" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF16UTF8 \- This filter converts UTF-16 encoded text to UTF-8. +.SH SYNOPSIS +.br +.PP +\fC#include <utf16utf8.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBUTF16UTF8\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts UTF-16 encoded text to UTF-8. +.PP +Definition at line 29 of file utf16utf8.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/UTF8Cantillation.3 b/doc/api-documentation/man/man3/UTF8Cantillation.3 new file mode 100644 index 0000000..16a9cdb --- /dev/null +++ b/doc/api-documentation/man/man3/UTF8Cantillation.3 @@ -0,0 +1,75 @@ +.TH "UTF8Cantillation" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF8Cantillation \- This Filter shows/hides Hebrew cantillation marks in UTF8 text. +.SH SYNOPSIS +.br +.PP +\fC#include <utf8cantillation.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBUTF8Cantillation\fP ()" +.br +.ti -1c +.RI "virtual \fB~UTF8Cantillation\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides Hebrew cantillation marks in UTF8 text. +.PP +Definition at line 29 of file utf8cantillation.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/UTF8GreekAccents.3 b/doc/api-documentation/man/man3/UTF8GreekAccents.3 new file mode 100644 index 0000000..53dd8ed --- /dev/null +++ b/doc/api-documentation/man/man3/UTF8GreekAccents.3 @@ -0,0 +1,75 @@ +.TH "UTF8GreekAccents" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF8GreekAccents \- This Filter shows/hides Greek Accents marks in UTF8 text. +.SH SYNOPSIS +.br +.PP +\fC#include <utf8greekaccents.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBUTF8GreekAccents\fP ()" +.br +.ti -1c +.RI "virtual \fB~UTF8GreekAccents\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides Greek Accents marks in UTF8 text. +.PP +Definition at line 29 of file utf8greekaccents.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/UTF8HTML.3 b/doc/api-documentation/man/man3/UTF8HTML.3 new file mode 100644 index 0000000..2149fe2 --- /dev/null +++ b/doc/api-documentation/man/man3/UTF8HTML.3 @@ -0,0 +1,31 @@ +.TH "UTF8HTML" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF8HTML \- This filter converts UTF-8 text into HTML escape sequences. +.SH SYNOPSIS +.br +.PP +\fC#include <utf8html.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBUTF8HTML\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts UTF-8 text into HTML escape sequences. +.PP +Definition at line 29 of file utf8html.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/UTF8HebrewPoints.3 b/doc/api-documentation/man/man3/UTF8HebrewPoints.3 new file mode 100644 index 0000000..5059ea6 --- /dev/null +++ b/doc/api-documentation/man/man3/UTF8HebrewPoints.3 @@ -0,0 +1,75 @@ +.TH "UTF8HebrewPoints" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF8HebrewPoints \- This Filter shows/hides Hebrew vowel points in UTF8 text. +.SH SYNOPSIS +.br +.PP +\fC#include <utf8hebrewpoints.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBUTF8HebrewPoints\fP ()" +.br +.ti -1c +.RI "virtual \fB~UTF8HebrewPoints\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionName\fP ()" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionTip\fP ()" +.br +.ti -1c +.RI "virtual void \fBsetOptionValue\fP (const char *ival)" +.br +.ti -1c +.RI "virtual const char * \fBgetOptionValue\fP ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fP ()" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "bool \fBoption\fP" +.br +.ti -1c +.RI "OptionsList \fBoptions\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "const char \fBon\fP []" +.br +.ti -1c +.RI "const char \fBoff\fP []" +.br +.ti -1c +.RI "const char \fBoptName\fP []" +.br +.ti -1c +.RI "const char \fBoptTip\fP []" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This Filter shows/hides Hebrew vowel points in UTF8 text. +.PP +Definition at line 29 of file utf8hebrewpoints.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/UTF8Latin1.3 b/doc/api-documentation/man/man3/UTF8Latin1.3 new file mode 100644 index 0000000..b22e6d8 --- /dev/null +++ b/doc/api-documentation/man/man3/UTF8Latin1.3 @@ -0,0 +1,38 @@ +.TH "UTF8Latin1" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF8Latin1 \- This filter converts UTF-8 encoded text to Latin-1. +.SH SYNOPSIS +.br +.PP +\fC#include <utf8latin1.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBUTF8Latin1\fP (char rchar='?')" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "char \fBreplacementChar\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts UTF-8 encoded text to Latin-1. +.PP +Definition at line 29 of file utf8latin1.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/UTF8UTF16.3 b/doc/api-documentation/man/man3/UTF8UTF16.3 new file mode 100644 index 0000000..b884874 --- /dev/null +++ b/doc/api-documentation/man/man3/UTF8UTF16.3 @@ -0,0 +1,31 @@ +.TH "UTF8UTF16" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF8UTF16 \- This filter converts UTF-8 encoded text to UTF-16. +.SH SYNOPSIS +.br +.PP +\fC#include <utf8utf16.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBUTF8UTF16\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts UTF-8 encoded text to UTF-16. +.PP +Definition at line 29 of file utf8utf16.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/UnicodeRTF.3 b/doc/api-documentation/man/man3/UnicodeRTF.3 new file mode 100644 index 0000000..2dcf0b8 --- /dev/null +++ b/doc/api-documentation/man/man3/UnicodeRTF.3 @@ -0,0 +1,31 @@ +.TH "UnicodeRTF" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UnicodeRTF \- This filter converts UTF-8 text into RTF Unicode tags. +.SH SYNOPSIS +.br +.PP +\fC#include <unicodertf.h>\fP +.PP +Inherits SWFilter. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBUnicodeRTF\fP ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fP (char *text, int maxlen, const \fBSWKey\fP *key, const \fBSWModule\fP *=0)" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +This filter converts UTF-8 text into RTF Unicode tags. +.PP +Definition at line 30 of file unicodertf.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/VerseKey.3 b/doc/api-documentation/man/man3/VerseKey.3 new file mode 100644 index 0000000..e4face1 --- /dev/null +++ b/doc/api-documentation/man/man3/VerseKey.3 @@ -0,0 +1,650 @@ +.TH "VerseKey" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +VerseKey \- Class VerseKey The \fBSWKey\fP implementation used for verse based modules like Bibles or commentaries. +.SH SYNOPSIS +.br +.PP +\fC#include <versekey.h>\fP +.PP +Inherits \fBSWKey\fP. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBVerseKey\fP (const char *ikey=0)" +.br +.RI "\fIVerseKey Constructor - initializes Instance of VerseKey.\fP" +.ti -1c +.RI "\fBVerseKey\fP (const \fBSWKey\fP *ikey)" +.br +.RI "\fIVerseKey Constructor - initializes instance of VerseKey.\fP" +.ti -1c +.RI "\fBVerseKey\fP (const char *min, const char *max)" +.br +.RI "\fIVerseKey Constructor - initializes instance of VerseKey with boundariess - see also \fBLowerBound\fP and \fBUpperBound\fP.\fP" +.ti -1c +.RI "\fBVerseKey\fP (VerseKey const &k)" +.br +.RI "\fIVerseKey Copy Constructor - will create a new VerseKey based on an existing one.\fP" +.ti -1c +.RI "virtual \fB~VerseKey\fP ()" +.br +.RI "\fIVerseKey Destructor Cleans up an instance of VerseKey.\fP" +.ti -1c +.RI "VerseKey & \fBLowerBound\fP (const char *lb)" +.br +.RI "\fIsets the lower boundary for this VerseKey and returns the new boundary.\fP" +.ti -1c +.RI "VerseKey & \fBUpperBound\fP (const char *ub)" +.br +.RI "\fIsets the upper boundary for this VerseKey and returns the new boundary.\fP" +.ti -1c +.RI "VerseKey & \fBLowerBound\fP () const" +.br +.RI "\fIgets the lower boundary of this VerseKey.\fP" +.ti -1c +.RI "VerseKey & \fBUpperBound\fP () const" +.br +.RI "\fIgets the upper boundary of this VerseKey.\fP" +.ti -1c +.RI "void \fBClearBounds\fP ()" +.br +.RI "\fIclears the boundaries of this VerseKey.\fP" +.ti -1c +.RI "virtual \fBSWKey\fP * \fBclone\fP () const" +.br +.RI "\fICreates a new \fBSWKey\fP based on the current VerseKey see also the Copy Constructor.\fP" +.ti -1c +.RI "virtual const char * \fBgetText\fP () const" +.br +.RI "\fIrefreshes keytext before returning if cast to a (char *) is requested.\fP" +.ti -1c +.RI "virtual void \fBsetText\fP (const char *ikey)" +.br +.RI "\fIEquates this \fBSWKey\fP to a character string.\fP" +.ti -1c +.RI "virtual void \fBcopyFrom\fP (const \fBSWKey\fP &ikey)" +.br +.RI "\fIEquates this \fBSWKey\fP to another \fBSWKey\fP object.\fP" +.ti -1c +.RI "virtual void \fBcopyFrom\fP (const VerseKey &ikey)" +.br +.RI "\fIEquates this VerseKey to another VerseKey.\fP" +.ti -1c +.RI "virtual void \fBsetPosition\fP (SW_POSITION)" +.br +.RI "\fIPositions this key.\fP" +.ti -1c +.RI "virtual void \fBdecrement\fP (int step)" +.br +.RI "\fIDecrements key a number of verses.\fP" +.ti -1c +.RI "virtual void \fBincrement\fP (int step)" +.br +.RI "\fIIncrements key a number of verses.\fP" +.ti -1c +.RI "virtual char \fBTraversable\fP ()" +.br +.ti -1c +.RI "virtual char \fBTestament\fP () const" +.br +.RI "\fIGets testament.\fP" +.ti -1c +.RI "virtual char \fBBook\fP () const" +.br +.RI "\fIGets book.\fP" +.ti -1c +.RI "virtual int \fBChapter\fP () const" +.br +.RI "\fIGets chapter.\fP" +.ti -1c +.RI "virtual int \fBVerse\fP () const" +.br +.RI "\fIGets verse.\fP" +.ti -1c +.RI "virtual char \fBTestament\fP (char itestament)" +.br +.RI "\fISets/gets testament.\fP" +.ti -1c +.RI "virtual char \fBBook\fP (char ibook)" +.br +.RI "\fISets/gets book.\fP" +.ti -1c +.RI "virtual int \fBChapter\fP (int ichapter)" +.br +.RI "\fISets/gets chapter.\fP" +.ti -1c +.RI "virtual int \fBVerse\fP (int iverse)" +.br +.RI "\fISets/gets verse.\fP" +.ti -1c +.RI "virtual void \fBNormalize\fP (char autocheck=0)" +.br +.RI "\fIchecks limits and normalizes if necessary (e.g.\fP" +.ti -1c +.RI "virtual char \fBAutoNormalize\fP (char iautonorm=MAXPOS(char))" +.br +.RI "\fISets/gets flag that tells VerseKey to automatically normalize itself when modified.\fP" +.ti -1c +.RI "virtual char \fBHeadings\fP (char iheadings=MAXPOS(char))" +.br +.RI "\fISets/gets flag that tells VerseKey to include chapter/book/testament/module headings.\fP" +.ti -1c +.RI "virtual long \fBNewIndex\fP () const" +.br +.ti -1c +.RI "virtual long \fBIndex\fP () const" +.br +.RI "\fIGets index based upon current verse.\fP" +.ti -1c +.RI "virtual long \fBIndex\fP (long iindex)" +.br +.RI "\fISets index based upon current verse.\fP" +.ti -1c +.RI "virtual \fBListKey\fP \fBParseVerseList\fP (const char *buf, const char *defaultKey='Genesis 1:1', bool expandRange=false)" +.br +.ti -1c +.RI "virtual int \fBcompare\fP (const \fBSWKey\fP &ikey)" +.br +.RI "\fICompares another \fBSWKey\fP object.\fP" +.ti -1c +.RI "virtual int \fB_compare\fP (const VerseKey &ikey)" +.br +.RI "\fICompares another VerseKey object.\fP" +.ti -1c +.RI "virtual void \fBsetBookAbbrevs\fP (const struct abbrev *bookAbbrevs, unsigned int size=0)" +.br +.ti -1c +.RI "virtual void \fBsetBooks\fP (const char *iBMAX, struct sbook **ibooks)" +.br +.ti -1c +.RI "virtual void \fBsetLocale\fP (const char *name)" +.br +.ti -1c +.RI "virtual SWKEY_OPERATORS \fBSWKey\fP & \fBoperator=\fP (const VerseKey &ikey)" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "const char * \fBBMAX\fP" +.br +.ti -1c +.RI "sbook ** \fBbooks\fP" +.br +.in -1c +.SS "Static Public Attributes" + +.in +1c +.ti -1c +.RI "const char \fBbuiltin_BMAX\fP [2]" +.br +.ti -1c +.RI "sbook * \fBbuiltin_books\fP [2]" +.br +.ti -1c +.RI "const struct abbrev \fBbuiltin_abbrevs\fP []" +.br +.in -1c +.SS "Private Methods" + +.in +1c +.ti -1c +.RI "int \fBgetBookAbbrev\fP (const char *abbr)" +.br +.ti -1c +.RI "void \fBinitBounds\fP () const" +.br +.ti -1c +.RI "void \fBinitstatics\fP ()" +.br +.RI "\fIinitialize and allocate books array.\fP" +.ti -1c +.RI "void \fBinit\fP ()" +.br +.RI "\fIinitializes this \fBVerseKey\fP().\fP" +.ti -1c +.RI "void \fBfreshtext\fP () const" +.br +.RI "\fIRefresh keytext based on testament|book|chapter|verse default auto normalization to true default display headings option is false.\fP" +.ti -1c +.RI "virtual char \fBparse\fP ()" +.br +.RI "\fIParse a character array into testament|book|chapter|verse.\fP" +.ti -1c +.RI "int \fBfindindex\fP (long *array, int size, long value)" +.br +.RI "\fIBinary search to find the index closest, but less than the given value.\fP" +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "\fBListKey\fP \fBinternalListKey\fP" +.br +.ti -1c +.RI "const struct abbrev * \fBabbrevs\fP" +.br +.ti -1c +.RI "int \fBabbrevsCnt\fP" +.br +.ti -1c +.RI "char \fBtestament\fP" +.br +.RI "\fIThe Testament: 0 - Old; 1 - New.\fP" +.ti -1c +.RI "char \fBbook\fP" +.br +.ti -1c +.RI "int \fBchapter\fP" +.br +.ti -1c +.RI "int \fBverse\fP" +.br +.ti -1c +.RI "char \fBautonorm\fP" +.br +.RI "\fIflag for auto normalization.\fP" +.ti -1c +.RI "char \fBheadings\fP" +.br +.RI "\fIflag for headings on/off.\fP" +.ti -1c +.RI "VerseKey * \fBlowerBound\fP" +.br +.ti -1c +.RI "VerseKey * \fBupperBound\fP" +.br +.in -1c +.SS "Static Private Attributes" + +.in +1c +.ti -1c +.RI "\fBSWClass\fP \fBclassdef\fP" +.br +.ti -1c +.RI "long * \fBoffsets\fP [2][2]" +.br +.ti -1c +.RI "int \fBoffsize\fP [2][2]" +.br +.ti -1c +.RI "int \fBinstance\fP" +.br +.RI "\fInumber of instantiated VerseKey objects or derivitives.\fP" +.ti -1c +.RI "sbook \fBotbooks\fP []" +.br +.ti -1c +.RI "sbook \fBntbooks\fP []" +.br +.ti -1c +.RI "long \fBotbks\fP []" +.br +.ti -1c +.RI "long \fBotcps\fP []" +.br +.ti -1c +.RI "long \fBntbks\fP []" +.br +.ti -1c +.RI "long \fBntcps\fP []" +.br +.ti -1c +.RI "int \fBvm\fP []" +.br +.ti -1c +.RI "LocaleCache \fBlocaleCache\fP" +.br +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +Class VerseKey The \fBSWKey\fP implementation used for verse based modules like Bibles or commentaries. +.PP +Definition at line 67 of file versekey.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "VerseKey::VerseKey (const char * ikey = 0)" +.PP +VerseKey Constructor - initializes Instance of VerseKey. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +text key (will take various forms of 'BOOK CH:VS'. See \fBparse\fP for more detailed information) +.SS "VerseKey::VerseKey (const \fBSWKey\fP * ikey)" +.PP +VerseKey Constructor - initializes instance of VerseKey. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +base key (will take various forms of 'BOOK CH:VS'. See \fBparse\fP for more detailed information) +.SS "VerseKey::VerseKey (const char * min, const char * max)" +.PP +VerseKey Constructor - initializes instance of VerseKey with boundariess - see also \fBLowerBound\fP and \fBUpperBound\fP. +.PP +Parameters: +.in +1c +.TP +\fB\fImin\fP\fP +the lower boundary of the new VerseKey +.TP +\fB\fImax\fP\fP +the upper boundary of the new VerseKey +.SS "VerseKey::VerseKey (VerseKey const & k)" +.PP +VerseKey Copy Constructor - will create a new VerseKey based on an existing one. +.PP +Parameters: +.in +1c +.TP +\fB\fIk\fP\fP +the VerseKey to copy from +.SH "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual char VerseKey::AutoNormalize (char iautonorm = MAXPOS (char))\fC [virtual]\fP" +.PP +Sets/gets flag that tells VerseKey to automatically normalize itself when modified. +.PP +Parameters: +.in +1c +.TP +\fB\fIiautonorm\fP\fP +value which to set autonorm [MAXPOS(char)] - only get +.PP +\fBReturns: \fP +.in +1c +if unchanged -> value of autonorm, if changed -> previous value of autonorm +.SS "virtual char VerseKey::Book (char ibook)\fC [virtual]\fP" +.PP +Sets/gets book. +.PP +Parameters: +.in +1c +.TP +\fB\fIibook\fP\fP +value which to set book [MAXPOS(char)] - only get +.PP +\fBReturns: \fP +.in +1c +if unchanged -> value of book, if changed -> previous value of book +.SS "virtual char VerseKey::Book () const\fC [virtual]\fP" +.PP +Gets book. +.PP +\fBReturns: \fP +.in +1c +value of book +.SS "virtual int VerseKey::Chapter (int ichapter)\fC [virtual]\fP" +.PP +Sets/gets chapter. +.PP +Parameters: +.in +1c +.TP +\fB\fIichapter\fP\fP +value which to set chapter [MAXPOS(int)] - only get +.PP +\fBReturns: \fP +.in +1c +if unchanged -> value of chapter, if changed -> previous value of chapter +.SS "virtual int VerseKey::Chapter () const\fC [virtual]\fP" +.PP +Gets chapter. +.PP +\fBReturns: \fP +.in +1c +value of chapter +.SS "virtual char VerseKey::Headings (char iheadings = MAXPOS (char))\fC [virtual]\fP" +.PP +Sets/gets flag that tells VerseKey to include chapter/book/testament/module headings. +.PP +Parameters: +.in +1c +.TP +\fB\fIiheadings\fP\fP +value which to set headings [MAXPOS(char)] - only get +.PP +\fBReturns: \fP +.in +1c +if unchanged -> value of headings, if changed -> previous value of headings +.SS "virtual long VerseKey::Index (long index)\fC [virtual]\fP" +.PP +Sets index based upon current verse. +.PP +Parameters: +.in +1c +.TP +\fB\fIiindex\fP\fP +value to set index to +.PP +\fBReturns: \fP +.in +1c +offset +.PP +Reimplemented from \fBSWKey\fP. +.SS "virtual long VerseKey::Index () const\fC [virtual]\fP" +.PP +Gets index based upon current verse. +.PP +\fBReturns: \fP +.in +1c +offset +.PP +Reimplemented from \fBSWKey\fP. +.SS "VerseKey& VerseKey::LowerBound () const" +.PP +gets the lower boundary of this VerseKey. +.PP +\fBReturns: \fP +.in +1c +the lower boundary of this VerseKey +.SS "VerseKey& VerseKey::LowerBound (const char * lb)" +.PP +sets the lower boundary for this VerseKey and returns the new boundary. +.PP +Parameters: +.in +1c +.TP +\fB\fIlb\fP\fP +the new lower boundary for this VerseKey +.PP +\fBReturns: \fP +.in +1c +the lower boundary the key was set to +.SS "virtual void VerseKey::Normalize (char autocheck = 0)\fC [virtual]\fP" +.PP +checks limits and normalizes if necessary (e.g. +.PP +Matthew 29:47 = Mark 2:2). If last verse is exceeded, key is set to last Book CH:VS +.PP +\fBReturns: \fP +.in +1c +*this +.SS "virtual char VerseKey::Testament (char itestament)\fC [virtual]\fP" +.PP +Sets/gets testament. +.PP +Parameters: +.in +1c +.TP +\fB\fIitestament\fP\fP +value which to set testament [MAXPOS(char)] - only get +.PP +\fBReturns: \fP +.in +1c +if unchanged -> value of testament, if changed -> previous value of testament +.SS "virtual char VerseKey::Testament () const\fC [virtual]\fP" +.PP +Gets testament. +.PP +\fBReturns: \fP +.in +1c +value of testament +.SS "VerseKey& VerseKey::UpperBound () const" +.PP +gets the upper boundary of this VerseKey. +.PP +\fBReturns: \fP +.in +1c +the upper boundary of this VerseKey +.SS "VerseKey& VerseKey::UpperBound (const char * ub)" +.PP +sets the upper boundary for this VerseKey and returns the new boundary. +.PP +Parameters: +.in +1c +.TP +\fB\fIlb\fP\fP +the new upper boundary for this VerseKey +.PP +\fBReturns: \fP +.in +1c +the upper boundary the key was set to +.SS "virtual int VerseKey::Verse (int iverse)\fC [virtual]\fP" +.PP +Sets/gets verse. +.PP +Parameters: +.in +1c +.TP +\fB\fIiverse\fP\fP +value which to set verse [MAXPOS(int)] - only get +.PP +\fBReturns: \fP +.in +1c +if unchanged -> value of verse, if changed -> previous value of verse +.SS "virtual int VerseKey::Verse () const\fC [virtual]\fP" +.PP +Gets verse. +.PP +\fBReturns: \fP +.in +1c +value of verse +.SS "virtual int VerseKey::_compare (const VerseKey & ikey)\fC [virtual]\fP" +.PP +Compares another VerseKey object. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +key to compare with this one +.PP +\fBReturns: \fP +.in +1c +>0 if this VerseKey is greater than compare VerseKey, <0 if this VerseKey is smaller than compare VerseKey, 0 if the keys are the same +.SS "virtual int VerseKey::compare (const \fBSWKey\fP & ikey)\fC [virtual]\fP" +.PP +Compares another \fBSWKey\fP object. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +key to compare with this one +.PP +\fBReturns: \fP +.in +1c +>0 if this VerseKey is greater than compare \fBSWKey\fP, <0 if this VerseKey is smaller than compare \fBSWKey\fP, 0 if the keys are the same +.PP +Reimplemented from \fBSWKey\fP. +.SS "virtual void VerseKey::copyFrom (const \fBSWKey\fP & ikey)\fC [virtual]\fP" +.PP +Equates this \fBSWKey\fP to another \fBSWKey\fP object. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +other swkey object +.PP +Reimplemented from \fBSWKey\fP. +.SS "virtual void VerseKey::decrement (int step)\fC [virtual]\fP" +.PP +Decrements key a number of verses. +.PP +Parameters: +.in +1c +.TP +\fB\fIdecrement\fP\fP +Number of verses to jump backward +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Reimplemented from \fBSWKey\fP. +.SS "int VerseKey::findindex (long * array, int size, long value)\fC [private]\fP" +.PP +Binary search to find the index closest, but less than the given value. +.PP +Parameters: +.in +1c +.TP +\fB\fIarray\fP\fP +long * to array to search +.TP +\fB\fIsize\fP\fP +number of elements in the array +.TP +\fB\fIvalue\fP\fP +value to find +.PP +\fBReturns: \fP +.in +1c +the index into the array that is less than but closest to value +.SS "virtual void VerseKey::increment (int step)\fC [virtual]\fP" +.PP +Increments key a number of verses. +.PP +Parameters: +.in +1c +.TP +\fB\fIincrement\fP\fP +Number of verses to jump forward +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Reimplemented from \fBSWKey\fP. +.SS "virtual void VerseKey::setPosition (SW_POSITION)\fC [virtual]\fP" +.PP +Positions this key. +.PP +Parameters: +.in +1c +.TP +\fB\fIp\fP\fP +position +.PP +\fBReturns: \fP +.in +1c +*this +.PP +Reimplemented from \fBSWKey\fP. +.SS "virtual void VerseKey::setText (const char * ikey)\fC [inline, virtual]\fP" +.PP +Equates this \fBSWKey\fP to a character string. +.PP +Parameters: +.in +1c +.TP +\fB\fIikey\fP\fP +string to set this key to +.PP +Reimplemented from \fBSWKey\fP. +.PP +Definition at line 229 of file versekey.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/gbffootnotes.3 b/doc/api-documentation/man/man3/gbffootnotes.3 new file mode 100644 index 0000000..5cef362 --- /dev/null +++ b/doc/api-documentation/man/man3/gbffootnotes.3 @@ -0,0 +1,147 @@ +.TH "GBFFootnotes" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFFootnotes \- This Filter shows/hides footnotes in a GBF text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbffootnotes.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBGBFFootnotes\fR ()" +.br +.ti -1c +.RI "virtual \fB~GBFFootnotes\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionName\fR ()" +.br +.RI "\fIgets the name of the option of this filter.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionTip\fR ()" +.br +.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR" +.ti -1c +.RI "virtual void \fBsetOptionValue\fR (const char *ival)" +.br +.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionValue\fR ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fR ()" +.br +.RI "\fIreturns a list of the possible option values might be.\fR" +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "bool \fBoption\fR" +.br +.ti -1c +.RI "OptionsList \fBoptions\fR" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "const char \fBon\fR []" +.br +.ti -1c +.RI "const char \fBoff\fR []" +.br +.ti -1c +.RI "const char \fBoptName\fR []" +.br +.ti -1c +.RI "const char \fBoptTip\fR []" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +This Filter shows/hides footnotes in a GBF text. +.PP +Definition at line 30 of file gbffootnotes.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char GBFFootnotes::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. +.SS const char * GBFFootnotes::getOptionName ()\fC [inline, virtual]\fR +.PP +gets the name of the option of this filter. +.PP +\fBReturns: \fR +.in +1c +option name +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 42 of file gbffootnotes.h. +.SS const char * GBFFootnotes::getOptionTip ()\fC [inline, virtual]\fR +.PP +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +.PP +\fBReturns: \fR +.in +1c +option tip/explanation +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 46 of file gbffootnotes.h. +.SS OptionsList GBFFootnotes::getOptionValues ()\fC [inline, virtual]\fR +.PP +returns a list of the possible option values might be. +.PP +\fBReturns: \fR +.in +1c +list of option values +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 52 of file gbffootnotes.h. +.SS virtual void GBFFootnotes::setOptionValue (const char * ival)\fC [virtual]\fR +.PP +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIival\fR\fR +the new option valus +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/gbfheadings.3 b/doc/api-documentation/man/man3/gbfheadings.3 new file mode 100644 index 0000000..a504b9e --- /dev/null +++ b/doc/api-documentation/man/man3/gbfheadings.3 @@ -0,0 +1,147 @@ +.TH "GBFHeadings" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFHeadings \- This Filter shows/hides headings in a GBF text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfheadings.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBGBFHeadings\fR ()" +.br +.ti -1c +.RI "virtual \fB~GBFHeadings\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionName\fR ()" +.br +.RI "\fIgets the name of the option of this filter.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionTip\fR ()" +.br +.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR" +.ti -1c +.RI "virtual void \fBsetOptionValue\fR (const char *ival)" +.br +.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionValue\fR ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fR ()" +.br +.RI "\fIreturns a list of the possible option values might be.\fR" +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "bool \fBoption\fR" +.br +.ti -1c +.RI "OptionsList \fBoptions\fR" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "const char \fBon\fR []" +.br +.ti -1c +.RI "const char \fBoff\fR []" +.br +.ti -1c +.RI "const char \fBoptName\fR []" +.br +.ti -1c +.RI "const char \fBoptTip\fR []" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +This Filter shows/hides headings in a GBF text. +.PP +Definition at line 30 of file gbfheadings.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char GBFHeadings::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. +.SS const char * GBFHeadings::getOptionName ()\fC [inline, virtual]\fR +.PP +gets the name of the option of this filter. +.PP +\fBReturns: \fR +.in +1c +option name +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 42 of file gbfheadings.h. +.SS const char * GBFHeadings::getOptionTip ()\fC [inline, virtual]\fR +.PP +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +.PP +\fBReturns: \fR +.in +1c +option tip/explanation +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 46 of file gbfheadings.h. +.SS OptionsList GBFHeadings::getOptionValues ()\fC [inline, virtual]\fR +.PP +returns a list of the possible option values might be. +.PP +\fBReturns: \fR +.in +1c +list of option values +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 52 of file gbfheadings.h. +.SS virtual void GBFHeadings::setOptionValue (const char * ival)\fC [virtual]\fR +.PP +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIival\fR\fR +the new option valus +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/gbfhtml.3 b/doc/api-documentation/man/man3/gbfhtml.3 new file mode 100644 index 0000000..11b1e04 --- /dev/null +++ b/doc/api-documentation/man/man3/gbfhtml.3 @@ -0,0 +1,55 @@ +.TH "GBFHTML" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFHTML \- This filter converts GBF Text into HTML. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfhtml.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBGBFHTML\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +This filter converts GBF Text into HTML. +.PP +Definition at line 31 of file gbfhtml.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char GBFHTML::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/gbfhtmlhref.3 b/doc/api-documentation/man/man3/gbfhtmlhref.3 new file mode 100644 index 0000000..40d55b9 --- /dev/null +++ b/doc/api-documentation/man/man3/gbfhtmlhref.3 @@ -0,0 +1,35 @@ +.TH "GBFHTMLHREF" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFHTMLHREF \- this filter converts GBF text to HTML text with hrefs. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfhtmlhref.h>\fR +.PP +Inherits SWBasicFilter. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBGBFHTMLHREF\fR ()" +.br +.in -1c +.SS Protected Methods + +.in +1c +.ti -1c +.RI "virtual bool \fBhandleToken\fR (char **buf, const char *token, DualStringMap &userData)" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts GBF text to HTML text with hrefs. +.PP +Definition at line 26 of file gbfhtmlhref.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/gbfmorph.3 b/doc/api-documentation/man/man3/gbfmorph.3 new file mode 100644 index 0000000..3807b68 --- /dev/null +++ b/doc/api-documentation/man/man3/gbfmorph.3 @@ -0,0 +1,147 @@ +.TH "GBFMorph" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFMorph \- This Filter shows/hides morph tags in a GBF text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfmorph.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBGBFMorph\fR ()" +.br +.ti -1c +.RI "virtual \fB~GBFMorph\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionName\fR ()" +.br +.RI "\fIgets the name of the option of this filter.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionTip\fR ()" +.br +.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR" +.ti -1c +.RI "virtual void \fBsetOptionValue\fR (const char *ival)" +.br +.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionValue\fR ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fR ()" +.br +.RI "\fIreturns a list of the possible option values might be.\fR" +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "bool \fBoption\fR" +.br +.ti -1c +.RI "OptionsList \fBoptions\fR" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "const char \fBon\fR []" +.br +.ti -1c +.RI "const char \fBoff\fR []" +.br +.ti -1c +.RI "const char \fBoptName\fR []" +.br +.ti -1c +.RI "const char \fBoptTip\fR []" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +This Filter shows/hides morph tags in a GBF text. +.PP +Definition at line 29 of file gbfmorph.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char GBFMorph::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. +.SS const char * GBFMorph::getOptionName ()\fC [inline, virtual]\fR +.PP +gets the name of the option of this filter. +.PP +\fBReturns: \fR +.in +1c +option name +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 41 of file gbfmorph.h. +.SS const char * GBFMorph::getOptionTip ()\fC [inline, virtual]\fR +.PP +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +.PP +\fBReturns: \fR +.in +1c +option tip/explanation +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 45 of file gbfmorph.h. +.SS OptionsList GBFMorph::getOptionValues ()\fC [inline, virtual]\fR +.PP +returns a list of the possible option values might be. +.PP +\fBReturns: \fR +.in +1c +list of option values +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 51 of file gbfmorph.h. +.SS virtual void GBFMorph::setOptionValue (const char * ival)\fC [virtual]\fR +.PP +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIival\fR\fR +the new option valus +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/gbfplain.3 b/doc/api-documentation/man/man3/gbfplain.3 new file mode 100644 index 0000000..f7298b2 --- /dev/null +++ b/doc/api-documentation/man/man3/gbfplain.3 @@ -0,0 +1,55 @@ +.TH "GBFPlain" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFPlain \- This filter converts GBF text into plain text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfplain.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBGBFPlain\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +This filter converts GBF text into plain text. +.PP +Definition at line 30 of file gbfplain.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char GBFPlain::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/gbfrtf.3 b/doc/api-documentation/man/man3/gbfrtf.3 new file mode 100644 index 0000000..9f60e85 --- /dev/null +++ b/doc/api-documentation/man/man3/gbfrtf.3 @@ -0,0 +1,55 @@ +.TH "GBFRTF" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFRTF \- This filter converts GBF text into RTF text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfrtf.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBGBFRTF\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +This filter converts GBF text into RTF text. +.PP +Definition at line 30 of file gbfrtf.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char GBFRTF::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/gbfstrongs.3 b/doc/api-documentation/man/man3/gbfstrongs.3 new file mode 100644 index 0000000..24cc79e --- /dev/null +++ b/doc/api-documentation/man/man3/gbfstrongs.3 @@ -0,0 +1,147 @@ +.TH "GBFStrongs" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFStrongs \- This Filter shows/hides strong's numbers in a GBF text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfstrongs.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBGBFStrongs\fR ()" +.br +.ti -1c +.RI "virtual \fB~GBFStrongs\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionName\fR ()" +.br +.RI "\fIgets the name of the option of this filter.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionTip\fR ()" +.br +.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR" +.ti -1c +.RI "virtual void \fBsetOptionValue\fR (const char *ival)" +.br +.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionValue\fR ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fR ()" +.br +.RI "\fIreturns a list of the possible option values might be.\fR" +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "bool \fBoption\fR" +.br +.ti -1c +.RI "OptionsList \fBoptions\fR" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "const char \fBon\fR []" +.br +.ti -1c +.RI "const char \fBoff\fR []" +.br +.ti -1c +.RI "const char \fBoptName\fR []" +.br +.ti -1c +.RI "const char \fBoptTip\fR []" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +This Filter shows/hides strong's numbers in a GBF text. +.PP +Definition at line 30 of file gbfstrongs.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char GBFStrongs::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. +.SS const char * GBFStrongs::getOptionName ()\fC [inline, virtual]\fR +.PP +gets the name of the option of this filter. +.PP +\fBReturns: \fR +.in +1c +option name +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 42 of file gbfstrongs.h. +.SS const char * GBFStrongs::getOptionTip ()\fC [inline, virtual]\fR +.PP +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +.PP +\fBReturns: \fR +.in +1c +option tip/explanation +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 46 of file gbfstrongs.h. +.SS OptionsList GBFStrongs::getOptionValues ()\fC [inline, virtual]\fR +.PP +returns a list of the possible option values might be. +.PP +\fBReturns: \fR +.in +1c +list of option values +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 52 of file gbfstrongs.h. +.SS virtual void GBFStrongs::setOptionValue (const char * ival)\fC [virtual]\fR +.PP +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIival\fR\fR +the new option valus +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/gbfthml.3 b/doc/api-documentation/man/man3/gbfthml.3 new file mode 100644 index 0000000..c6861e1 --- /dev/null +++ b/doc/api-documentation/man/man3/gbfthml.3 @@ -0,0 +1,52 @@ +.TH "GBFThML" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +GBFThML \- this filter converts GBF text into ThML text. +.SH SYNOPSIS +.br +.PP +\fC#include <gbfthml.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBGBFThML\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen=-1)" +.br +.RI "\fIThis is the main filter function without the 3rd parameter.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts GBF text into ThML text. +.PP +Definition at line 27 of file gbfthml.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char GBFThML::ProcessText (char * text, int maxlen = -1)\fC [virtual]\fR +.PP +This is the main filter function without the 3rd parameter. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/latin1utf16.3 b/doc/api-documentation/man/man3/latin1utf16.3 new file mode 100644 index 0000000..083ea47 --- /dev/null +++ b/doc/api-documentation/man/man3/latin1utf16.3 @@ -0,0 +1,55 @@ +.TH "Latin1UTF16" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Latin1UTF16 \- This filter converts Latin-1 encoded text to UTF-8. +.SH SYNOPSIS +.br +.PP +\fC#include <latin1utf16.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBLatin1UTF16\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +This filter converts Latin-1 encoded text to UTF-8. +.PP +Definition at line 29 of file latin1utf16.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char Latin1UTF16::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/latin1utf8.3 b/doc/api-documentation/man/man3/latin1utf8.3 new file mode 100644 index 0000000..bb28d74 --- /dev/null +++ b/doc/api-documentation/man/man3/latin1utf8.3 @@ -0,0 +1,55 @@ +.TH "Latin1UTF8" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Latin1UTF8 \- This filter converts Latin-1 encoded text to UTF-8. +.SH SYNOPSIS +.br +.PP +\fC#include <latin1utf8.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBLatin1UTF8\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +This filter converts Latin-1 encoded text to UTF-8. +.PP +Definition at line 29 of file latin1utf8.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char Latin1UTF8::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/listkey.3 b/doc/api-documentation/man/man3/listkey.3 new file mode 100644 index 0000000..268654b --- /dev/null +++ b/doc/api-documentation/man/man3/listkey.3 @@ -0,0 +1,276 @@ +.TH "ListKey" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ListKey \- ListKey is the basis for all types of keys that have lists of specified indexes (e.g. +.SH SYNOPSIS +.br +.PP +\fC#include <listkey.h>\fR +.PP +Inherits \fBSWKey\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBListKey\fR (const char *ikey=0)" +.br +.RI "\fIinitializes instance of ListKey.\fR" +.ti -1c +.RI "\fBListKey\fR (ListKey const &k)" +.br +.ti -1c +.RI "virtual \fB~ListKey\fR ()" +.br +.RI "\fIcleans up instance of ListKey.\fR" +.ti -1c +.RI "virtual \fBSWKey\fR* \fBclone\fR () const" +.br +.RI "\fIReturns a copy of this \fBSWKey\fR object.\fR" +.ti -1c +.RI "virtual void \fBClearList\fR ()" +.br +.RI "\fIClears out elements of list.\fR" +.ti -1c +.RI "virtual int \fBCount\fR ()" +.br +.RI "\fIReturns number of elements in list.\fR" +.ti -1c +.RI "virtual void \fBRemove\fR ()" +.br +.RI "\fIRemoves current element from list.\fR" +.ti -1c +.RI "virtual char \fBSetToElement\fR (int ielement, SW_POSITION=TOP)" +.br +.RI "\fISets key to element number.\fR" +.ti -1c +.RI "virtual \fBSWKey\fR* \fBGetElement\fR (int pos=-1)" +.br +.RI "\fIGets a key element number.\fR" +.ti -1c +.RI "ListKey& \fBoperator<<\fR (const \fBSWKey\fR &ikey)" +.br +.RI "\fIAdds an element to the list.\fR" +.ti -1c +.RI "virtual void \fBadd\fR (const \fBSWKey\fR &ikey)" +.br +.ti -1c +.RI "virtual void \fBcopyFrom\fR (const ListKey &ikey)" +.br +.RI "\fIEquates this ListKey to another ListKey object.\fR" +.ti -1c +.RI "virtual void \fBcopyFrom\fR (const \fBSWKey\fR &ikey)" +.br +.RI "\fIEquates this \fBSWKey\fR to another \fBSWKey\fR object.\fR" +.ti -1c +.RI "virtual void \fBsetPosition\fR (SW_POSITION)" +.br +.RI "\fIPositions this key.\fR" +.ti -1c +.RI "virtual void \fBdecrement\fR (int step)" +.br +.RI "\fIDecrements a number of elements.\fR" +.ti -1c +.RI "virtual void \fBincrement\fR (int step)" +.br +.RI "\fIIncrements a number of elements.\fR" +.ti -1c +.RI "virtual char \fBTraversable\fR ()" +.br +.ti -1c +.RI "virtual long \fBIndex\fR () const" +.br +.RI "\fIUse this function to get te current position withing a module.\fR" +.ti -1c +.RI "virtual long \fBIndex\fR (long index)" +.br +.RI "\fIReturns the index for the new one given as as parameter.\fR" +.ti -1c +.RI "SWKEY_OPERATORS ListKey& \fBoperator=\fR (const ListKey &key)" +.br +.in -1c +.SS Protected Attributes + +.in +1c +.ti -1c +.RI "int \fBarraypos\fR" +.br +.ti -1c +.RI "int \fBarraymax\fR" +.br +.ti -1c +.RI "int \fBarraycnt\fR" +.br +.ti -1c +.RI "\fBSWKey\fR** \fBarray\fR" +.br +.in -1c +.SS Private Methods + +.in +1c +.ti -1c +.RI "void \fBinit\fR ()" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "\fBSWClass\fR \fBclassdef\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +ListKey is the basis for all types of keys that have lists of specified indexes (e.g. +.PP +a list of verses, place, etc.) +.PP +Definition at line 36 of file listkey.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS ListKey::ListKey (const char * ikey = 0) +.PP +initializes instance of ListKey. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +text key +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS int ListKey::Count ()\fC [virtual]\fR +.PP +Returns number of elements in list. +.PP +\fBReturns: \fR +.in +1c +number of elements in list +.SS \fBSWKey\fR * ListKey::GetElement (int pos = -1)\fC [virtual]\fR +.PP +Gets a key element number. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIpos\fR\fR +element number to get (or default current) +.PP +\fBReturns: \fR +.in +1c +Key or null on error +.SS long ListKey::Index (long index)\fC [inline, virtual]\fR +.PP +Returns the index for the new one given as as parameter. +.PP +The first parameter is the new index. +.PP +Reimplemented from \fBSWKey\fR. +.PP +Definition at line 112 of file listkey.h. +.SS long ListKey::Index () const\fC [inline, virtual]\fR +.PP +Use this function to get te current position withing a module. +.PP +Here's a small example how to use this function and \fBIndex\fR(long). This function uses the GerLut module and chooses a random verse from the Bible and returns it. +.PP +.nf + const char* randomVerse() { + VerseKey vk; + SWMgr mgr; + LocaleMgr::systemLocaleMgr.setDefaultLocaleName("de"); + + SWModule* module = mgr->Modules("GerLut"); + srand( time(0) ); + const double newIndex = (double(rand())/RAND_MAX)*(24108+8224); + vk.Index(newIndex); + module->SetKey(vk); + + char* text; + sprintf(text, "%s: %s",(const char*)vk ,module->StripText(&vk)); + return text; +.fi + +.PP +Reimplemented from \fBSWKey\fR. +.PP +Definition at line 106 of file listkey.h. +.SS char ListKey::SetToElement (int ielement, SW_POSITION = TOP)\fC [virtual]\fR +.PP +Sets key to element number. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIielement\fR\fR +element number to set to +.PP +\fBReturns: \fR +.in +1c +error status +.PP +Referenced by Index(). +.SS virtual \fBSWKey\fR* ListKey::clone () const\fC [virtual]\fR +.PP +Returns a copy of this \fBSWKey\fR object. +.PP +This is useful to get a 1:1 copy of an \fBSWKey\fR based object. +.PP +\fBReturns: \fR +.in +1c +\fBSWKey\fR +.PP +Reimplemented from \fBSWKey\fR. +.SS void ListKey::copyFrom (const \fBSWKey\fR & ikey)\fC [inline, virtual]\fR +.PP +Equates this \fBSWKey\fR to another \fBSWKey\fR object. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +other swkey object +.PP +Reimplemented from \fBSWKey\fR. +.PP +Definition at line 90 of file listkey.h. +.SS void ListKey::copyFrom (const ListKey & ikey)\fC [virtual]\fR +.PP +Equates this ListKey to another ListKey object. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +other ListKey object +.SS ListKey & ListKey::operator<< (const \fBSWKey\fR & ikey)\fC [inline]\fR +.PP +Adds an element to the list. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +the element to add +.PP +Definition at line 82 of file listkey.h. +.SS void ListKey::setPosition (SW_POSITION)\fC [virtual]\fR +.PP +Positions this key. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIp\fR\fR +position +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Reimplemented from \fBSWKey\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/localemgr.3 b/doc/api-documentation/man/man3/localemgr.3 new file mode 100644 index 0000000..90da5d7 --- /dev/null +++ b/doc/api-documentation/man/man3/localemgr.3 @@ -0,0 +1,161 @@ +.TH "LocaleMgr" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +LocaleMgr \- The LocaleMgr class handles all the different locales of Sword. +.SH SYNOPSIS +.br +.PP +\fC#include <localemgr.h>\fR +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBLocaleMgr\fR (const char *iConfigPath=0)" +.br +.RI "\fIDefault constructor of LocaleMgr You do normally not need this constructor, use \fBLocaleMgr::systemLocaleMgr\fR instead.\fR" +.ti -1c +.RI "virtual \fB~LocaleMgr\fR ()" +.br +.RI "\fIDefault destructor of LocaleMgr.\fR" +.ti -1c +.RI "virtual \fBSWLocale\fR* \fBgetLocale\fR (const char *name)" +.br +.RI "\fIGet the locale connected with the name "name".\fR" +.ti -1c +.RI "virtual list< string > \fBgetAvailableLocales\fR ()" +.br +.RI "\fIGet the list of available locales.\fR" +.ti -1c +.RI "virtual const char* \fBtranslate\fR (const char *name, const char *text)" +.br +.RI "\fIReturns translated text.\fR" +.ti -1c +.RI "virtual const char* \fBgetDefaultLocaleName\fR ()" +.br +.RI "\fIGet the default locale name.\fR" +.ti -1c +.RI "virtual void \fBsetDefaultLocaleName\fR (const char *name)" +.br +.RI "\fISet the new standard locale of Sword.\fR" +.in -1c +.SS Static Public Attributes + +.in +1c +.ti -1c +.RI "LocaleMgr \fBsystemLocaleMgr\fR" +.br +.RI "\fIThe LocaleMgr object used globally in the Sword world.\fR" +.in -1c +.SS Protected Methods + +.in +1c +.ti -1c +.RI "virtual void \fBloadConfigDir\fR (const char *ipath)" +.br +.in -1c +.SS Protected Attributes + +.in +1c +.ti -1c +.RI "LocaleMap \fBlocales\fR" +.br +.in -1c +.SS Private Methods + +.in +1c +.ti -1c +.RI "void \fBdeleteLocales\fR ()" +.br +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "char* \fBdefaultLocaleName\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +The LocaleMgr class handles all the different locales of Sword. +.PP +It provides functions to get a list of all available locales, to get the default locale name and to get it. The other functions are not interesting for frontend programmers. +.PP +To get the default locale name use +.PP +\fBSee also: \fR +.in +1c +\fBgetDefaultLocaleName\fR To set the default locale name use , \fBsetDefaultLocaleName\fR To get the locale for a language name use , \fBgetLocale\fR To get a list of availble locales use , \fBgetAvailableLocales\fR +.PP +Definition at line 49 of file localemgr.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS list< string > LocaleMgr::getAvailableLocales ()\fC [virtual]\fR +.PP +Get the list of available locales. +.PP +@ret Returns a list of strings, which contains the names of the available locales. +.SS const char * LocaleMgr::getDefaultLocaleName ()\fC [virtual]\fR +.PP +Get the default locale name. +.PP +To set it use +.PP +\fBSee also: \fR +.in +1c +\fBsetDefaultLocaleName\fR +.PP +@ret Returns the default locale name +.SS \fBSWLocale\fR * LocaleMgr::getLocale (const char * name)\fC [virtual]\fR +.PP +Get the locale connected with the name "name". +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIname\fR\fR +The name of the locale you want to have. For example use getLocale("de") to get the locale for the German language. +.PP +\fBReturns: \fR +.in +1c +Returns the locale object if the locale with the name given as parameter was found. If it wasn't found return NULL. +.SS void LocaleMgr::setDefaultLocaleName (const char * name)\fC [virtual]\fR +.PP +Set the new standard locale of Sword. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIname\fR\fR +The name of the new default locale +.SS const char * LocaleMgr::translate (const char * name, const char * text)\fC [virtual]\fR +.PP +Returns translated text. +.PP +This function uses both parameters to return the translated version of the given text. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIname\fR\fR +The name of the locale Sword should use +.PP +\fBan The text to translate into the language given by the first parameter.\fR +.in +1c +\fBReturns: \fR +.in +1c +Returns the translated text. +.SH MEMBER DATA DOCUMENTATION +.PP +.SS LocaleMgr LocaleMgr::systemLocaleMgr\fC [static]\fR +.PP +The LocaleMgr object used globally in the Sword world. +.PP +Do not create your own LocaleMgr, use this static object instead. +.PP +Definition at line 107 of file localemgr.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/plainfootnotes.3 b/doc/api-documentation/man/man3/plainfootnotes.3 new file mode 100644 index 0000000..ca9fbbb --- /dev/null +++ b/doc/api-documentation/man/man3/plainfootnotes.3 @@ -0,0 +1,151 @@ +.TH "PLAINFootnotes" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +PLAINFootnotes \- Shows or hides footnotes in plain text. +.SH SYNOPSIS +.br +.PP +\fC#include <plainfootnotes.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBPLAINFootnotes\fR ()" +.br +.ti -1c +.RI "virtual \fB~PLAINFootnotes\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen=-1, const \fBSWKey\fR *key=0)" +.br +.RI "\fIThis is the main filter function.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionName\fR ()" +.br +.RI "\fIgets the name of the option of this filter.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionTip\fR ()" +.br +.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR" +.ti -1c +.RI "virtual void \fBsetOptionValue\fR (const char *ival)" +.br +.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionValue\fR ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fR ()" +.br +.RI "\fIreturns a list of the possible option values might be.\fR" +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "bool \fBoption\fR" +.br +.ti -1c +.RI "OptionsList \fBoptions\fR" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "const char \fBon\fR []" +.br +.ti -1c +.RI "const char \fBoff\fR []" +.br +.ti -1c +.RI "const char \fBoptName\fR []" +.br +.ti -1c +.RI "const char \fBoptTip\fR []" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +Shows or hides footnotes in plain text. +.PP +\fBAuthor(s): \fR +.in +1c +The team of BibleTime +.PP +Definition at line 33 of file plainfootnotes.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char PLAINFootnotes::ProcessText (char * text, int maxlen = -1, const \fBSWKey\fR * key = 0)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. +.SS const char * PLAINFootnotes::getOptionName ()\fC [inline, virtual]\fR +.PP +gets the name of the option of this filter. +.PP +\fBReturns: \fR +.in +1c +option name +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 47 of file plainfootnotes.h. +.SS const char * PLAINFootnotes::getOptionTip ()\fC [inline, virtual]\fR +.PP +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +.PP +\fBReturns: \fR +.in +1c +option tip/explanation +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 51 of file plainfootnotes.h. +.SS OptionsList PLAINFootnotes::getOptionValues ()\fC [inline, virtual]\fR +.PP +returns a list of the possible option values might be. +.PP +\fBReturns: \fR +.in +1c +list of option values +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 57 of file plainfootnotes.h. +.SS virtual void PLAINFootnotes::setOptionValue (const char * ival)\fC [virtual]\fR +.PP +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIival\fR\fR +the new option valus +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/plainhtml.3 b/doc/api-documentation/man/man3/plainhtml.3 new file mode 100644 index 0000000..cda232e --- /dev/null +++ b/doc/api-documentation/man/man3/plainhtml.3 @@ -0,0 +1,55 @@ +.TH "PLAINHTML" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +PLAINHTML \- this filter converts plain text to HTML text. +.SH SYNOPSIS +.br +.PP +\fC#include <plainhtml.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBPLAINHTML\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts plain text to HTML text. +.PP +Definition at line 31 of file plainhtml.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char PLAINHTML::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/rtfhtml.3 b/doc/api-documentation/man/man3/rtfhtml.3 new file mode 100644 index 0000000..1b07175 --- /dev/null +++ b/doc/api-documentation/man/man3/rtfhtml.3 @@ -0,0 +1,55 @@ +.TH "RTFHTML" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +RTFHTML \- this filter converts RTF text into HTML text. +.SH SYNOPSIS +.br +.PP +\fC#include <rtfhtml.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBRTFHTML\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts RTF text into HTML text. +.PP +Definition at line 30 of file rtfhtml.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char RTFHTML::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/rwphtml.3 b/doc/api-documentation/man/man3/rwphtml.3 new file mode 100644 index 0000000..a943b94 --- /dev/null +++ b/doc/api-documentation/man/man3/rwphtml.3 @@ -0,0 +1,55 @@ +.TH "RWPHTML" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +RWPHTML \- this filter converts RWP text to HTML text. +.SH SYNOPSIS +.br +.PP +\fC#include <rwphtml.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBRWPHTML\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts RWP text to HTML text. +.PP +Definition at line 31 of file rwphtml.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char RWPHTML::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/rwprtf.3 b/doc/api-documentation/man/man3/rwprtf.3 new file mode 100644 index 0000000..96f80d7 --- /dev/null +++ b/doc/api-documentation/man/man3/rwprtf.3 @@ -0,0 +1,55 @@ +.TH "RWPRTF" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +RWPRTF \- this filter converts RWP text to RTF text. +.SH SYNOPSIS +.br +.PP +\fC#include <rwprtf.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBRWPRTF\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts RWP text to RTF text. +.PP +Definition at line 33 of file rwprtf.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char RWPRTF::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/scsuutf8.3 b/doc/api-documentation/man/man3/scsuutf8.3 new file mode 100644 index 0000000..282eb29 --- /dev/null +++ b/doc/api-documentation/man/man3/scsuutf8.3 @@ -0,0 +1,72 @@ +.TH "SCSUUTF8" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SCSUUTF8 \- This filter converts SCSU compressed (encoded) text to UTF-8. +.SH SYNOPSIS +.br +.PP +\fC#include <scsuutf8.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSCSUUTF8\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SS Private Methods + +.in +1c +.ti -1c +.RI "unsigned char* \fBUTF8Output\fR (unsigned long, unsigned char *text)" +.br +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "unsigned long \fBc\fR" +.br +.ti -1c +.RI "unsigned long \fBd\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +This filter converts SCSU compressed (encoded) text to UTF-8. +.PP +Definition at line 29 of file scsuutf8.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char SCSUUTF8::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/strkey.3 b/doc/api-documentation/man/man3/strkey.3 new file mode 100644 index 0000000..efe9fd8 --- /dev/null +++ b/doc/api-documentation/man/man3/strkey.3 @@ -0,0 +1,60 @@ +.TH "StrKey" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +StrKey \- a standard string key class (used for modules that index on single strings (eg. +.SH SYNOPSIS +.br +.PP +\fC#include <strkey.h>\fR +.PP +Inherits \fBSWKey\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBStrKey\fR (const char *ikey=0)" +.br +.RI "\fIinitializes instance of StrKey.\fR" +.ti -1c +.RI "virtual \fB~StrKey\fR ()" +.br +.RI "\fIcleans up instance of StrKey.\fR" +.in -1c +.SS Private Methods + +.in +1c +.ti -1c +.RI "void \fBinit\fR ()" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "\fBSWClass\fR \fBclassdef\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +a standard string key class (used for modules that index on single strings (eg. +.PP +cities, names, words, etc.) +.PP +Definition at line 35 of file strkey.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS StrKey::StrKey (const char * ikey = 0) +.PP +initializes instance of StrKey. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +text key (word, city, name, etc.) + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swclass.3 b/doc/api-documentation/man/man3/swclass.3 new file mode 100644 index 0000000..b779afe --- /dev/null +++ b/doc/api-documentation/man/man3/swclass.3 @@ -0,0 +1,36 @@ +.TH "SWClass" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWClass \- Class used for SWDYNAMIC_CAST to save the inheritance order. +.SH SYNOPSIS +.br +.PP +\fC#include <swobject.h>\fR +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWClass\fR (const char **descends)" +.br +.ti -1c +.RI "bool \fBisAssignableFrom\fR (const char *className) const" +.br +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "const char** \fBdescends\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +Class used for SWDYNAMIC_CAST to save the inheritance order. +.PP +Definition at line 18 of file swobject.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swcom.3 b/doc/api-documentation/man/man3/swcom.3 new file mode 100644 index 0000000..aa3a762 --- /dev/null +++ b/doc/api-documentation/man/man3/swcom.3 @@ -0,0 +1,68 @@ +.TH "SWCom" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWCom \- The basis for all commentary modules. +.SH SYNOPSIS +.br +.PP +\fC#include <swcom.h>\fR +.PP +Inherits \fBSWModule\fR. +.PP +Inherited by HREFCom, RawCom, RawFiles, and zCom. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWCom\fR (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fR *idisp=0, bool unicode=false)" +.br +.RI "\fIInitializes data for instance of SWCom.\fR" +.ti -1c +.RI "virtual \fB~SWCom\fR ()" +.br +.ti -1c +.RI "virtual \fBSWKey\fR* \fBCreateKey\fR ()" +.br +.RI "\fIAllocates a key of specific type for module.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +The basis for all commentary modules. +.PP +Definition at line 33 of file swcom.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS SWCom::SWCom (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fR * idisp = 0, bool unicode = false) +.PP +Initializes data for instance of SWCom. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIimodname\fR\fR +Internal name for module +.TP +\fB\fIimoddesc\fR\fR +Name to display to user for module +.TP +\fB\fIidisp\fR\fR +Display object to use for displaying +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS \fBSWKey\fR * SWCom::CreateKey ()\fC [inline, virtual]\fR +.PP +Allocates a key of specific type for module. +.PP +\fBReturns: \fR +.in +1c +pointer to allocated key +.PP +Reimplemented from \fBSWModule\fR. +.PP +Definition at line 44 of file swcom.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swconfig.3 b/doc/api-documentation/man/man3/swconfig.3 new file mode 100644 index 0000000..8750b79 --- /dev/null +++ b/doc/api-documentation/man/man3/swconfig.3 @@ -0,0 +1,100 @@ +.TH "SWConfig" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWConfig \- The class to read and save settings using a file on disk. +.SH SYNOPSIS +.br +.PP +\fC#include <swconfig.h>\fR +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWConfig\fR (const char *ifilename)" +.br +.RI "\fIConstructor of SWConfig.\fR" +.ti -1c +.RI "virtual \fB~SWConfig\fR ()" +.br +.ti -1c +.RI "virtual void \fBLoad\fR ()" +.br +.RI "\fILoad from disk Load the contzent from disk.\fR" +.ti -1c +.RI "virtual void \fBSave\fR ()" +.br +.RI "\fISave to disk Save the content of this config object to disk.\fR" +.ti -1c +.RI "virtual SWConfig& \fBoperator+=\fR (SWConfig &addFrom)" +.br +.RI "\fIMerges the values of addFrom.\fR" +.ti -1c +.RI "virtual ConfigEntMap& \fBoperator[]\fR (const char *section)" +.br +.RI "\fIGet a section This is an easy way to get and store config values.\fR" +.in -1c +.SS Public Attributes + +.in +1c +.ti -1c +.RI "string \fBfilename\fR" +.br +.RI "\fIThe filename used by this SWConfig object.\fR" +.ti -1c +.RI "SectionMap \fBSections\fR" +.br +.RI "\fIMap of available sections The map of available sections.\fR" +.in -1c +.SS Private Methods + +.in +1c +.ti -1c +.RI "char \fBgetline\fR (FILE *fp, string &line)" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +The class to read and save settings using a file on disk. +.PP +Definition at line 56 of file swconfig.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS SWConfig::SWConfig (const char * ifilename) +.PP +Constructor of SWConfig. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIifilename\fR\fR +The file, which should be used for this config. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS SWConfig & SWConfig::operator+= (SWConfig & addFrom)\fC [virtual]\fR +.PP +Merges the values of addFrom. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIThe\fR\fR +config which values should be merged to this config object. Already existing values will be overwritten. +.SS ConfigEntMap & SWConfig::operator[] (const char * section)\fC [virtual]\fR +.PP +Get a section This is an easy way to get and store config values. +.PP +The following will work: +.br + +.PP +.nf + SWConfig config("/home/user/.setttings"); + config["Colors"]["Background"] = "red"; +.fi + + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swdisplay.3 b/doc/api-documentation/man/man3/swdisplay.3 new file mode 100644 index 0000000..86b26b2 --- /dev/null +++ b/doc/api-documentation/man/man3/swdisplay.3 @@ -0,0 +1,49 @@ +.TH "SWDisplay" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWDisplay \- swdisp is the basis for all types of displays (e.g. +.SH SYNOPSIS +.br +.PP +\fC#include <swdisp.h>\fR +.PP +Inherited by TBDisp. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWDisplay\fR ()" +.br +.ti -1c +.RI "virtual char \fBDisplay\fR (\fBSWModule\fR &imodule)" +.br +.RI "\fIcasts a module to a character pointer and displays it to raw output (overriden for different display types and module types if necessary).\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +swdisp is the basis for all types of displays (e.g. +.PP +raw textout, curses, xwindow, etc.) +.PP +Definition at line 33 of file swdisp.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS char SWDisplay::Display (\fBSWModule\fR & imodule)\fC [virtual]\fR +.PP +casts a module to a character pointer and displays it to raw output (overriden for different display types and module types if necessary). +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIimodule\fR\fR +module to display +.PP +\fBReturns: \fR +.in +1c +error status + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swfilter.3 b/doc/api-documentation/man/man3/swfilter.3 new file mode 100644 index 0000000..76459cf --- /dev/null +++ b/doc/api-documentation/man/man3/swfilter.3 @@ -0,0 +1,150 @@ +.TH "SWFilter" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWFilter \- Base class for all filters in sword. +.SH SYNOPSIS +.br +.PP +\fC#include <swfilter.h>\fR +.PP +Inherited by CipherFilter, \fBGBFFootnotes\fR, \fBGBFHeadings\fR, \fBGBFHTML\fR, \fBGBFMorph\fR, \fBGBFPlain\fR, \fBGBFRTF\fR, \fBGBFStrongs\fR, \fBGBFThML\fR, \fBLatin1UTF16\fR, \fBLatin1UTF8\fR, \fBPLAINFootnotes\fR, \fBPLAINHTML\fR, \fBRTFHTML\fR, \fBRWPHTML\fR, \fBRWPRTF\fR, \fBSCSUUTF8\fR, SWBasicFilter, \fBThMLGBF\fR, \fBThMLOLB\fR, \fBThMLPlain\fR, \fBThMLRTF\fR, \fBUnicodeRTF\fR, \fBUTF16UTF8\fR, \fBUTF8Cantillation\fR, \fBUTF8GreekAccents\fR, \fBUTF8HebrewPoints\fR, and \fBUTF8UTF16\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "virtual \fB~SWFilter\fR ()" +.br +.ti -1c +.RI "virtual const char* \fBgetOptionName\fR ()" +.br +.RI "\fIgets the name of the option of this filter.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionTip\fR ()" +.br +.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR" +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fR ()" +.br +.RI "\fIreturns a list of the possible option values might be.\fR" +.ti -1c +.RI "virtual void \fBsetOptionValue\fR (const char *)" +.br +.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionValue\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *)" +.br +.RI "\fIThis is the main filter function.\fR" +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen=-1)" +.br +.RI "\fIThis is the main filter function without the 3rd parameter.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +Base class for all filters in sword. +.PP +Filters are used to filter/convert text between different formats like GBF, HTML, RTF ... +.PP +Definition at line 41 of file swfilter.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS char SWFilter::ProcessText (char * text, int maxlen = -1)\fC [inline, virtual]\fR +.PP +This is the main filter function without the 3rd parameter. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented in \fBGBFThML\fR, \fBThMLGBF\fR, \fBThMLOLB\fR, \fBThMLPlain\fR, and \fBThMLRTF\fR. +.PP +Definition at line 100 of file swfilter.h. +.SS char SWFilter::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [inline, virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented in \fBGBFFootnotes\fR, \fBGBFHeadings\fR, \fBGBFHTML\fR, \fBGBFMorph\fR, \fBGBFPlain\fR, \fBGBFRTF\fR, \fBGBFStrongs\fR, \fBLatin1UTF16\fR, \fBLatin1UTF8\fR, \fBPLAINFootnotes\fR, \fBPLAINHTML\fR, \fBRTFHTML\fR, \fBRWPHTML\fR, \fBRWPRTF\fR, \fBSCSUUTF8\fR, \fBUnicodeRTF\fR, \fBUTF16UTF8\fR, \fBUTF8Cantillation\fR, \fBUTF8GreekAccents\fR, \fBUTF8HebrewPoints\fR, and \fBUTF8UTF16\fR. +.PP +Definition at line 91 of file swfilter.h. +.PP +Referenced by ProcessText(). +.SS const char * SWFilter::getOptionName ()\fC [inline, virtual]\fR +.PP +gets the name of the option of this filter. +.PP +\fBReturns: \fR +.in +1c +option name +.PP +Reimplemented in \fBGBFFootnotes\fR, \fBGBFHeadings\fR, \fBGBFMorph\fR, \fBGBFStrongs\fR, \fBPLAINFootnotes\fR, \fBUTF8Cantillation\fR, \fBUTF8GreekAccents\fR, and \fBUTF8HebrewPoints\fR. +.PP +Definition at line 51 of file swfilter.h. +.SS const char * SWFilter::getOptionTip ()\fC [inline, virtual]\fR +.PP +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +.PP +\fBReturns: \fR +.in +1c +option tip/explanation +.PP +Reimplemented in \fBGBFFootnotes\fR, \fBGBFHeadings\fR, \fBGBFMorph\fR, \fBGBFStrongs\fR, \fBPLAINFootnotes\fR, \fBUTF8Cantillation\fR, \fBUTF8GreekAccents\fR, and \fBUTF8HebrewPoints\fR. +.PP +Definition at line 59 of file swfilter.h. +.SS OptionsList SWFilter::getOptionValues ()\fC [inline, virtual]\fR +.PP +returns a list of the possible option values might be. +.PP +\fBReturns: \fR +.in +1c +list of option values +.PP +Reimplemented in \fBGBFFootnotes\fR, \fBGBFHeadings\fR, \fBGBFMorph\fR, \fBGBFStrongs\fR, \fBPLAINFootnotes\fR, \fBUTF8Cantillation\fR, \fBUTF8GreekAccents\fR, and \fBUTF8HebrewPoints\fR. +.PP +Definition at line 67 of file swfilter.h. +.SS void SWFilter::setOptionValue (const char * ival)\fC [inline, virtual]\fR +.PP +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIival\fR\fR +the new option valus +.PP +Reimplemented in \fBGBFFootnotes\fR, \fBGBFHeadings\fR, \fBGBFMorph\fR, \fBGBFStrongs\fR, \fBPLAINFootnotes\fR, \fBUTF8Cantillation\fR, \fBUTF8GreekAccents\fR, and \fBUTF8HebrewPoints\fR. +.PP +Definition at line 78 of file swfilter.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swkey.3 b/doc/api-documentation/man/man3/swkey.3 new file mode 100644 index 0000000..e68aa88 --- /dev/null +++ b/doc/api-documentation/man/man3/swkey.3 @@ -0,0 +1,313 @@ +.TH "SWKey" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWKey \- SWKey is the basis for all types of keys for indexing into modules (e.g. +.SH SYNOPSIS +.br +.PP +\fC#include <swkey.h>\fR +.PP +Inherits \fBSWObject\fR. +.PP +Inherited by \fBListKey\fR, \fBStrKey\fR, and \fBVerseKey\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWKey\fR (const char *ikey=0)" +.br +.RI "\fIinitializes instance of SWKey.\fR" +.ti -1c +.RI "\fBSWKey\fR (SWKey const &k)" +.br +.RI "\fICopy Constructor.\fR" +.ti -1c +.RI "virtual \fB~SWKey\fR ()" +.br +.RI "\fIDestructor, cleans up this instance of SWKey.\fR" +.ti -1c +.RI "virtual SWKey* \fBclone\fR () const" +.br +.RI "\fIReturns a copy of this SWKey object.\fR" +.ti -1c +.RI "char \fBPersist\fR () const" +.br +.RI "\fIGets whether this object itself persists within a module that it was used to SetKey or just a copy.\fR" +.ti -1c +.RI "char \fBPersist\fR (char ikey)" +.br +.RI "\fISet/gets whether this object itself persists within a module that it was used to SetKey or just a copy.\fR" +.ti -1c +.RI "virtual char \fBError\fR ()" +.br +.RI "\fIGets and clears error status.\fR" +.ti -1c +.RI "virtual void \fBsetText\fR (const char *ikey)" +.br +.RI "\fIEquates this SWKey to a character string.\fR" +.ti -1c +.RI "virtual void \fBcopyFrom\fR (const SWKey &ikey)" +.br +.RI "\fIEquates this SWKey to another SWKey object.\fR" +.ti -1c +.RI "virtual const char* \fBgetText\fR () const" +.br +.RI "\fIreturns text key if (char *) cast is requested.\fR" +.ti -1c +.RI "virtual int \fBcompare\fR (const SWKey &ikey)" +.br +.RI "\fICompares another \fBVerseKey\fR object.\fR" +.ti -1c +.RI "virtual bool \fBequals\fR (const SWKey &ikey)" +.br +.RI "\fICompares another \fBVerseKey\fR object.\fR" +.ti -1c +.RI "virtual void \fBsetPosition\fR (SW_POSITION)" +.br +.ti -1c +.RI "virtual void \fBdecrement\fR (int steps=1)" +.br +.RI "\fIDecrements key a number of entries.\fR" +.ti -1c +.RI "virtual void \fBincrement\fR (int steps=1)" +.br +.RI "\fIIncrements key a number of entries.\fR" +.ti -1c +.RI "virtual char \fBTraversable\fR ()" +.br +.ti -1c +.RI "virtual long \fBIndex\fR () const" +.br +.RI "\fIUse this function to get te current position withing a module.\fR" +.ti -1c +.RI "virtual long \fBIndex\fR (long iindex)" +.br +.in -1c +.SS Protected Attributes + +.in +1c +.ti -1c +.RI "char* \fBkeytext\fR" +.br +.ti -1c +.RI "char \fBpersist\fR" +.br +.ti -1c +.RI "char \fBerror\fR" +.br +.in -1c +.SS Private Methods + +.in +1c +.ti -1c +.RI "void \fBinit\fR ()" +.br +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "long \fBindex\fR" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "\fBSWClass\fR \fBclassdef\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +SWKey is the basis for all types of keys for indexing into modules (e.g. +.PP +verse, word, place, etc.) +.PP +Definition at line 76 of file swkey.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS SWKey::SWKey (const char * ikey = 0) +.PP +initializes instance of SWKey. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +text key +.SS SWKey::SWKey (SWKey const & k) +.PP +Copy Constructor. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIThe\fR\fR +SWKey object to copy. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS char SWKey::Error ()\fC [virtual]\fR +.PP +Gets and clears error status. +.PP +\fBReturns: \fR +.in +1c +error status +.SS long SWKey::Index () const\fC [inline, virtual]\fR +.PP +Use this function to get te current position withing a module. +.PP +Here's a small example how to use this function and Index(long). This function uses the GerLut module and chooses a random verse from the Bible and returns it. +.PP +.nf + const char* randomVerse() { + VerseKey vk; + SWMgr mgr; + LocaleMgr::systemLocaleMgr.setDefaultLocaleName("de"); + + SWModule* module = mgr->Modules("GerLut"); + srand( time(0) ); + const double newIndex = (double(rand())/RAND_MAX)*(24108+8224); + vk.Index(newIndex); + module->SetKey(vk); + + char* text; + sprintf(text, "%s: %s",(const char*)vk ,module->StripText(&vk)); + return text; +.fi + +.PP +Reimplemented in \fBListKey\fR, and \fBVerseKey\fR. +.PP +Definition at line 204 of file swkey.h. +.PP +Referenced by ListKey::Index(). +.SS char SWKey::Persist (char ikey) +.PP +Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy. +.PP +(1 - persists in module; 0 - a copy is attempted +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIipersist\fR\fR +value which to set persist; [-1] - only get +.PP +\fBReturns: \fR +.in +1c +value of persist +.SS char SWKey::Persist () const +.PP +Gets whether this object itself persists within a module that it was used to SetKey or just a copy. +.PP +(1 - persists in module; 0 - a copy is attempted +.PP +\fBReturns: \fR +.in +1c +value of persist +.SS SWKey * SWKey::clone () const\fC [virtual]\fR +.PP +Returns a copy of this SWKey object. +.PP +This is useful to get a 1:1 copy of an SWKey based object. +.PP +\fBReturns: \fR +.in +1c +SWKey +.PP +Reimplemented in \fBListKey\fR, and \fBVerseKey\fR. +.SS int SWKey::compare (const SWKey & ikey)\fC [virtual]\fR +.PP +Compares another \fBVerseKey\fR object. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +key to compare with this one +.PP +\fBReturns: \fR +.in +1c +>0 if this key is greater than compare key; <0 if this key is smaller than compare key; 0 if the keys are the same +.PP +Reimplemented in \fBVerseKey\fR. +.PP +Referenced by equals(). +.SS void SWKey::copyFrom (const SWKey & ikey)\fC [virtual]\fR +.PP +Equates this SWKey to another SWKey object. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +other swkey object +.PP +Reimplemented in \fBListKey\fR, and \fBVerseKey\fR. +.PP +Referenced by ListKey::copyFrom(). +.SS void SWKey::decrement (int step = 1)\fC [virtual]\fR +.PP +Decrements key a number of entries. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIsteps\fR\fR +Number of entries to jump backward +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Reimplemented in \fBListKey\fR, and \fBVerseKey\fR. +.SS bool SWKey::equals (const SWKey & ikey)\fC [inline, virtual]\fR +.PP +Compares another \fBVerseKey\fR object. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +key to compare with this one +.PP +\fBReturns: \fR +.in +1c +true if the keys are the same +.PP +Definition at line 163 of file swkey.h. +.SS void SWKey::increment (int step = 1)\fC [virtual]\fR +.PP +Increments key a number of entries. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIincrement\fR\fR +Number of entries to jump forward +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Reimplemented in \fBListKey\fR, and \fBVerseKey\fR. +.SS void SWKey::setText (const char * ikey)\fC [virtual]\fR +.PP +Equates this SWKey to a character string. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +string to set this key to +.PP +Reimplemented in \fBVerseKey\fR. +.PP +Referenced by VerseKey::setText(). + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swld.3 b/doc/api-documentation/man/man3/swld.3 new file mode 100644 index 0000000..f3322e6 --- /dev/null +++ b/doc/api-documentation/man/man3/swld.3 @@ -0,0 +1,94 @@ +.TH "SWLD" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWLD \- the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). +.SH SYNOPSIS +.br +.PP +\fC#include <swld.h>\fR +.PP +Inherits \fBSWModule\fR. +.PP +Inherited by RawLD, and RawLD4. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWLD\fR (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fR *idisp=0, bool unicode=false)" +.br +.RI "\fIInitializes data for instance of SWLD.\fR" +.ti -1c +.RI "virtual \fB~SWLD\fR ()" +.br +.ti -1c +.RI "virtual \fBSWKey\fR* \fBCreateKey\fR ()" +.br +.RI "\fIAllocates a key of specific type for module.\fR" +.ti -1c +.RI "virtual const char* \fBKeyText\fR (const char *ikeytext)" +.br +.RI "\fISets/gets module KeyText, getting from saved text if key is persistent.\fR" +.in -1c +.SS Protected Attributes + +.in +1c +.ti -1c +.RI "char* \fBentkeytxt\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). +.PP +Definition at line 34 of file swld.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS SWLD::SWLD (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fR * idisp = 0, bool unicode = false) +.PP +Initializes data for instance of SWLD. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIimodname\fR\fR +Internal name for module +.TP +\fB\fIimoddesc\fR\fR +Name to display to user for module +.TP +\fB\fIidisp\fR\fR +Display object to use for displaying +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS \fBSWKey\fR * SWLD::CreateKey ()\fC [inline, virtual]\fR +.PP +Allocates a key of specific type for module. +.PP +\fBReturns: \fR +.in +1c +pointer to allocated key +.PP +Reimplemented from \fBSWModule\fR. +.PP +Definition at line 47 of file swld.h. +.SS const char * SWLD::KeyText (const char * ikeytext)\fC [virtual]\fR +.PP +Sets/gets module KeyText, getting from saved text if key is persistent. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikeytext\fR\fR +value which to set keytext; [0] - only get +.PP +\fBReturns: \fR +.in +1c +pointer to keytext +.PP +Reimplemented from \fBSWModule\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swlocale.3 b/doc/api-documentation/man/man3/swlocale.3 new file mode 100644 index 0000000..6d65150 --- /dev/null +++ b/doc/api-documentation/man/man3/swlocale.3 @@ -0,0 +1,93 @@ +.TH "SWLocale" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWLocale \- SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language. +.SH SYNOPSIS +.br +.PP +\fC#include <swlocale.h>\fR +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWLocale\fR (const char *ifilename)" +.br +.ti -1c +.RI "virtual \fB~SWLocale\fR ()" +.br +.ti -1c +.RI "virtual const char* \fBgetName\fR ()" +.br +.RI "\fIThis function is used to get the name of the languages which this object is handling.\fR" +.ti -1c +.RI "virtual const char* \fBgetDescription\fR ()" +.br +.ti -1c +.RI "virtual const char* \fBtranslate\fR (const char *text)" +.br +.ti -1c +.RI "virtual SWLocale& \fBoperator+=\fR (SWLocale &addFrom)" +.br +.ti -1c +.RI "virtual const struct abbrev* \fBgetBookAbbrevs\fR ()" +.br +.ti -1c +.RI "virtual void \fBgetBooks\fR (char **iBMAX, struct sbook ***ibooks)" +.br +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "LookupMap \fBlookupTable\fR" +.br +.ti -1c +.RI "\fBSWConfig\fR* \fBlocaleSource\fR" +.br +.ti -1c +.RI "char* \fBname\fR" +.br +.ti -1c +.RI "char* \fBdescription\fR" +.br +.ti -1c +.RI "struct abbrev* \fBbookAbbrevs\fR" +.br +.ti -1c +.RI "char* \fBBMAX\fR" +.br +.ti -1c +.RI "struct sbook** \fBbooks\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language. +.PP +Every language supported by Sword has one SWLocale object, get the name of the Language using +.PP +\fBSee also: \fR +.in +1c +getname of this class. Another functions useful for frontend developers is , \fBgetDescription\fR. +.PP +Definition at line 44 of file swlocale.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS const char * SWLocale::getDescription ()\fC [virtual]\fR +.PP +\fBReturns: \fR +.in +1c +The description. A possible example is "German". +.SS const char * SWLocale::getName ()\fC [virtual]\fR +.PP +This function is used to get the name of the languages which this object is handling. +.PP +\fBReturns: \fR +.in +1c +The name of the managed language. A possible example is "de". + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swmgr.3 b/doc/api-documentation/man/man3/swmgr.3 new file mode 100644 index 0000000..e18a57f --- /dev/null +++ b/doc/api-documentation/man/man3/swmgr.3 @@ -0,0 +1,378 @@ +.TH "SWMgr" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWMgr \- The main class of Sword to handle all other things. +.SH SYNOPSIS +.br +.PP +\fC#include <swmgr.h>\fR +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWMgr\fR (\fBSWConfig\fR *iconfig=0, \fBSWConfig\fR *isysconfig=0, bool autoload=true)" +.br +.RI "\fIConstructor of SWMgr.\fR" +.ti -1c +.RI "\fBSWMgr\fR (const char *iConfigPath, bool autoload=true)" +.br +.ti -1c +.RI "virtual \fB~SWMgr\fR ()" +.br +.RI "\fIThe destructor of SWMgr.\fR" +.ti -1c +.RI "virtual void \fBInstallScan\fR (const char *dir)" +.br +.RI "\fIInstalls a scan for modules in the directory givan as parameter.\fR" +.ti -1c +.RI "virtual void \fBLoad\fR ()" +.br +.RI "\fILoad the modules.\fR" +.ti -1c +.RI "virtual void \fBsetGlobalOption\fR (const char *option, const char *value)" +.br +.RI "\fISet a global option Set a global option using the parameters.\fR" +.ti -1c +.RI "virtual const char* \fBgetGlobalOption\fR (const char *option)" +.br +.RI "\fIGives the value of the given option.\fR" +.ti -1c +.RI "virtual const char* \fBgetGlobalOptionTip\fR (const char *option)" +.br +.RI "\fIGives a description for the given option.\fR" +.ti -1c +.RI "virtual OptionsList \fBgetGlobalOptions\fR ()" +.br +.RI "\fIA list of all availble options with the currently set values.\fR" +.ti -1c +.RI "virtual OptionsList \fBgetGlobalOptionValues\fR (const char *option)" +.br +.ti -1c +.RI "virtual char \fBsetCipherKey\fR (const char *modName, const char *key)" +.br +.RI "\fISets the cipher key for the given module.\fR" +.ti -1c +.RI "const float \fBVersion\fR () const" +.br +.RI "\fIGet the Sword version.\fR" +.in -1c +.SS Public Attributes + +.in +1c +.ti -1c +.RI "\fBSWConfig\fR* \fBconfig\fR" +.br +.RI "\fIThe global config object.\fR" +.ti -1c +.RI "\fBSWConfig\fR* \fBsysconfig\fR" +.br +.ti -1c +.RI "ModMap \fBModules\fR" +.br +.RI "\fIA map of all modules This map contains the list of installed modules we use.\fR" +.ti -1c +.RI "char* \fBprefixPath\fR" +.br +.RI "\fIThe path to your Sword directory.\fR" +.ti -1c +.RI "char* \fBconfigPath\fR" +.br +.in -1c +.SS Static Public Methods + +.in +1c +.ti -1c +.RI "void \fBfindConfig\fR (char *configType, char **\fBprefixPath\fR, char **configPath)" +.br +.in -1c +.SS Static Public Attributes + +.in +1c +.ti -1c +.RI "bool \fBdebug\fR" +.br +.RI "\fIEnable / Disable debug output Set this static bool to true to get more verbose debug messages from SWMgr.\fR" +.in -1c +.SS Protected Methods + +.in +1c +.ti -1c +.RI "void \fBCreateMods\fR ()" +.br +.ti -1c +.RI "\fBSWModule\fR* \fBCreateMod\fR (string name, string driver, ConfigEntMap §ion)" +.br +.ti -1c +.RI "void \fBDeleteMods\fR ()" +.br +.ti -1c +.RI "virtual void \fBinit\fR ()" +.br +.ti -1c +.RI "virtual char \fBAddModToConfig\fR (int conffd, const char *fname)" +.br +.ti -1c +.RI "virtual void \fBloadConfigDir\fR (const char *ipath)" +.br +.ti -1c +.RI "virtual void \fBAddGlobalOptions\fR (\fBSWModule\fR *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end)" +.br +.ti -1c +.RI "virtual void \fBAddLocalOptions\fR (\fBSWModule\fR *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end)" +.br +.ti -1c +.RI "virtual void \fBAddRenderFilters\fR (\fBSWModule\fR *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the render filters which are defined in "section" to the \fBSWModule\fR object "module".\fR" +.ti -1c +.RI "virtual void \fBAddStripFilters\fR (\fBSWModule\fR *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the strip filters which are defined in "section" to the \fBSWModule\fR object "module".\fR" +.ti -1c +.RI "virtual void \fBAddRawFilters\fR (\fBSWModule\fR *module, ConfigEntMap §ion)" +.br +.RI "\fIAdds the raw filters which are defined in "section" to the \fBSWModule\fR object "module".\fR" +.in -1c +.SS Protected Attributes + +.in +1c +.ti -1c +.RI "\fBSWConfig\fR* \fBmyconfig\fR" +.br +.ti -1c +.RI "\fBSWConfig\fR* \fBmysysconfig\fR" +.br +.ti -1c +.RI "char \fBconfigType\fR" +.br +.ti -1c +.RI "FilterMap \fBoptionFilters\fR" +.br +.ti -1c +.RI "FilterMap \fBcipherFilters\fR" +.br +.ti -1c +.RI "\fBSWFilter\fR* \fBgbfplain\fR" +.br +.ti -1c +.RI "\fBSWFilter\fR* \fBthmlplain\fR" +.br +.ti -1c +.RI "FilterList \fBcleanupFilters\fR" +.br +.ti -1c +.RI "OptionsList \fBoptions\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +The main class of Sword to handle all other things. +.PP +SWmgr manages the installed modules, the filters and global options like footnotes or strong numbers. The class SWMgr is the most important class of Sword. It is used to manage the installed modules. It also manages the filters (Render-, Strip- and Rawfilters). +.PP +\fBSee also: \fR +.in +1c +\fBAddRawFilters\fR(), \fBAddRenderFilters\fR(), \fBAddStripFilters\fR() +.PP +\fBVersion: \fR +.in +1c +\fBId: \fR +.in +1c + swmgr.h,v 1.27 2001/10/05 20:37:00 mgruner Exp +.PP +Definition at line 63 of file swmgr.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS SWMgr::SWMgr (\fBSWConfig\fR * iconfig = 0, \fBSWConfig\fR * isysconfig = 0, bool autoload = true) +.PP +Constructor of SWMgr. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIiconfig\fR\fR +.TP +\fB\fIisysconfig\fR\fR +.TP +\fB\fIautoload\fR\fR +If this bool is true the constructor starts loading the installed modules. If you reimplemented SWMgr you can set autoload=false to load the modules with your own reimplemented function. +.SS SWMgr::~SWMgr ()\fC [virtual]\fR +.PP +The destructor of SWMgr. +.PP +This destrutcot cleans up the modules and deletes the created object. Destroy the SWMgr at last in your application. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS void SWMgr::AddRawFilters (\fBSWModule\fR * module, ConfigEntMap & section)\fC [protected, virtual]\fR +.PP +Adds the raw filters which are defined in "section" to the \fBSWModule\fR object "module". +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fImodule\fR\fR +To this module the raw filter(s) are added +.TP +\fB\fIsection\fR\fR +We use this section to get a list of filters we should apply to the module +.SS void SWMgr::AddRenderFilters (\fBSWModule\fR * module, ConfigEntMap & section)\fC [protected, virtual]\fR +.PP +Adds the render filters which are defined in "section" to the \fBSWModule\fR object "module". +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fImodule\fR\fR +To this module the render filter(s) are added +.TP +\fB\fIsection\fR\fR +We use this section to get a list of filters we should apply to the module +.SS void SWMgr::AddStripFilters (\fBSWModule\fR * module, ConfigEntMap & section)\fC [protected, virtual]\fR +.PP +Adds the strip filters which are defined in "section" to the \fBSWModule\fR object "module". +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fImodule\fR\fR +To this module the strip filter(s) are added +.TP +\fB\fIsection\fR\fR +We use this section to get a list of filters we should apply to the module +.SS void SWMgr::InstallScan (const char * dir)\fC [virtual]\fR +.PP +Installs a scan for modules in the directory givan as parameter. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIdir\fR\fR +The directory where new modules should be searched. +.SS void SWMgr::Load ()\fC [virtual]\fR +.PP +Load the modules. +.PP +Reimplement this function to use your own Load function, for example to use your own filters. +.SS const float SWMgr::Version () const\fC [inline]\fR +.PP +Get the Sword version. +.PP +Function to get the used version of Sword. This is required, because the modules have now a MinimumVersion tag, so it should be possible to get the currently used version. +.PP +\fBReturns: \fR +.in +1c +The version of the Sword library as a float (e.g. 1.52). +.PP +Definition at line 239 of file swmgr.h. +.SS const char * SWMgr::getGlobalOption (const char * option)\fC [virtual]\fR +.PP +Gives the value of the given option. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIThe\fR\fR +option, which should be used to return the value of it +.PP +\fBReturns: \fR +.in +1c +The value of the given option +.SS const char * SWMgr::getGlobalOptionTip (const char * option)\fC [virtual]\fR +.PP +Gives a description for the given option. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIoption\fR\fR +The option, which should be used +.PP +\fBReturns: \fR +.in +1c +A description of the given option +.PP +\fBSee also: \fR +.in +1c +\fBsetGlobalOption\fR, \fBgetGlobalOption\fR, \fBgetGlobalOptions\fR +.SS OptionsList SWMgr::getGlobalOptions ()\fC [virtual]\fR +.PP +A list of all availble options with the currently set values. +.PP +\fBReturns: \fR +.in +1c +This function returns a list of global options. +.SS char SWMgr::setCipherKey (const char * modName, const char * key)\fC [virtual]\fR +.PP +Sets the cipher key for the given module. +.PP +This function updates the key at runtime, but it does not write to the config file. To write the new unlock key to the config file use code like this: +.PP +.nf + SectionMap::iterator section; + ConfigEntMap::iterator entry; + DIR *dir = opendir(configPath); + struct dirent *ent; + char* modFile; + if (dir) { // find and update .conf file + rewinddir(dir); + while ((ent = readdir(dir))) + { + if ((strcmp(ent->d_name, ".")) && (strcmp(ent->d_name, ".."))) + { + modFile = m_backend->configPath; + modFile += "/"; + modFile += ent->d_name; + SWConfig *myConfig = new SWConfig( modFile ); + section = myConfig->Sections.find( m_module->Name() ); + if ( section != myConfig->Sections.end() ) + { + entry = section->second.find("CipherKey"); + if (entry != section->second.end()) + { + entry->second = unlockKey;//set cipher key + myConfig->Save();//save config file + } + } + delete myConfig; + } + } + } + closedir(dir); +.fi +\fBParameters: \fR +.in +1c +.TP +\fB\fImodName\fR\fR +For this module we change the unlockKey +.PP +\fBan key This is the new unlck key we use for te module.\fR +.in +1c +.SS void SWMgr::setGlobalOption (const char * option, const char * value)\fC [virtual]\fR +.PP +Set a global option Set a global option using the parameters. +.PP +A global option could be for example footnotes. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIoption\fR\fR +The name of the option, for which you want to change the value. Well known and often used values are "Footnotes" or "Strongs" +.TP +\fB\fIvalue\fR\fR +The value. Common values are "On" and "Off" +.SH MEMBER DATA DOCUMENTATION +.PP +.SS \fBSWConfig\fR * SWMgr::config +.PP +The global config object. +.PP +This is the global config object. It contains all items of all modules, so lookups should use this config object. If you want to save a cipher key or other things to the module config file, do NOT use this object, because it would corrupt your configs after config->Save(). +.PP +Definition at line 122 of file swmgr.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swmodule.3 b/doc/api-documentation/man/man3/swmodule.3 new file mode 100644 index 0000000..e8ab14e --- /dev/null +++ b/doc/api-documentation/man/man3/swmodule.3 @@ -0,0 +1,856 @@ +.TH "SWModule" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWModule \- The class SWModule is the base class for all modules used in Sword. +.SH SYNOPSIS +.br +.PP +\fC#include <swmodule.h>\fR +.PP +Inherited by \fBSWCom\fR, \fBSWLD\fR, and \fBSWText\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWModule\fR (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fR *idisp=0, char *imodtype=0, bool unicode=false)" +.br +.RI "\fIInitializes data for instance of SWModule.\fR" +.ti -1c +.RI "virtual \fB~SWModule\fR ()" +.br +.RI "\fICleans up instance of SWModule.\fR" +.ti -1c +.RI "virtual char \fBError\fR ()" +.br +.RI "\fIGets and clears error status.\fR" +.ti -1c +.RI "virtual const bool \fBisUnicode\fR () const" +.br +.ti -1c +.RI "virtual const int \fBgetEntrySize\fR () const" +.br +.ti -1c +.RI "virtual char \fBSetKey\fR (const \fBSWKey\fR *ikey)" +.br +.RI "\fISets a key to this module for position to a particular record or set of records.\fR" +.ti -1c +.RI "virtual char \fBSetKey\fR (const \fBSWKey\fR &ikey)" +.br +.RI "\fISets the key of this module.\fR" +.ti -1c +.RI "virtual \fBSWKey\fR& \fBKey\fR () const" +.br +.RI "\fIGets the current module key.\fR" +.ti -1c +.RI "virtual char \fBKey\fR (const \fBSWKey\fR &ikey)" +.br +.RI "\fISets the current key of the module to ikey, and returns the keytext.\fR" +.ti -1c +.RI "virtual const char* \fBKeyText\fR (const char *imodtype=0)" +.br +.RI "\fISets/gets module KeyText.\fR" +.ti -1c +.RI "virtual char \fBDisplay\fR ()" +.br +.RI "\fICalls this modules display object and passes itself.\fR" +.ti -1c +.RI "virtual \fBSWDisplay\fR* \fBDisp\fR (\fBSWDisplay\fR *idisp=0)" +.br +.RI "\fISets/gets display driver.\fR" +.ti -1c +.RI "virtual char* \fBName\fR (const char *imodname=0)" +.br +.RI "\fISets/gets module name.\fR" +.ti -1c +.RI "virtual char* \fBDescription\fR (const char *imoddesc=0)" +.br +.RI "\fISets/gets module description.\fR" +.ti -1c +.RI "virtual char* \fBType\fR (const char *imodtype=0)" +.br +.RI "\fISets/gets module type.\fR" +.ti -1c +.RI "virtual \fBListKey\fR& \fBSearch\fR (const char *istr, int searchType=0, int flags=0, \fBSWKey\fR *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0)" +.br +.RI "\fISearches a module for a string.\fR" +.ti -1c +.RI "virtual char \fBcreateSearchFramework\fR ()" +.br +.ti -1c +.RI "virtual bool \fBhasSearchFramework\fR ()" +.br +.ti -1c +.RI "virtual bool \fBisSearchOptimallySupported\fR (const char *istr, int searchType, int flags, \fBSWKey\fR *scope)" +.br +.ti -1c +.RI "virtual \fBSWKey\fR* \fBCreateKey\fR ()" +.br +.RI "\fIAllocates a key of specific type for module.\fR" +.ti -1c +.RI "virtual \fBoperator char *\fR ()" +.br +.RI "\fIRenders and returns the current module text.\fR" +.ti -1c +.RI "virtual char* \fBgetRawEntry\fR ()=0" +.br +.RI "\fIThis function is reimplemented by the different kinds of module objects.\fR" +.ti -1c +.RI "virtual \fBoperator SWKey &\fR ()" +.br +.ti -1c +.RI "virtual \fBoperator SWKey *\fR ()" +.br +.ti -1c +.RI "virtual bool \fBisWritable\fR ()" +.br +.RI "\fIIs the module writable? :).\fR" +.ti -1c +.RI "virtual SWModule& \fBoperator<<\fR (const char *)" +.br +.RI "\fIModify the current module entry text only if module \fBisWritable\fR.\fR" +.ti -1c +.RI "virtual SWModule& \fBoperator<<\fR (const \fBSWKey\fR *)" +.br +.RI "\fILink the current module entry to another module entry only if module \fBisWritable\fR.\fR" +.ti -1c +.RI "virtual void \fBdeleteEntry\fR ()" +.br +.RI "\fIDelete current module entry - only if module \fBisWritable\fR.\fR" +.ti -1c +.RI "virtual SWModule& \fBoperator-=\fR (int decrement)" +.br +.RI "\fIDecrements module key a number of entries.\fR" +.ti -1c +.RI "virtual SWModule& \fBoperator+=\fR (int increment)" +.br +.RI "\fIIncrements module key a number of entries.\fR" +.ti -1c +.RI "virtual SWModule& \fBoperator++\fR (int)" +.br +.RI "\fIIncrements module key by 1 entry.\fR" +.ti -1c +.RI "virtual SWModule& \fBoperator--\fR (int)" +.br +.RI "\fIDecrements module key by 1 entry.\fR" +.ti -1c +.RI "virtual SWModule& \fBoperator=\fR (SW_POSITION p)" +.br +.RI "\fIPositions this modules to an entry.\fR" +.ti -1c +.RI "virtual SWModule& \fBAddRenderFilter\fR (\fBSWFilter\fR *newfilter)" +.br +.RI "\fIAdds a RenderFilter to this module's.\fR" +.ti -1c +.RI "virtual SWModule& \fBRemoveRenderFilter\fR (\fBSWFilter\fR *oldfilter)" +.br +.RI "\fIRemoves a RenderFilter to this module's.\fR" +.ti -1c +.RI "virtual void \fBrenderFilter\fR (char *buf, long size, \fBSWKey\fR *\fBkey\fR)" +.br +.RI "\fIRenderFilter a text buffer.\fR" +.ti -1c +.RI "virtual SWModule& \fBAddStripFilter\fR (\fBSWFilter\fR *newfilter)" +.br +.RI "\fIAdds a StripFilter to this module's stripfilters queue.\fR" +.ti -1c +.RI "virtual void \fBstripFilter\fR (char *buf, long size, \fBSWKey\fR *\fBkey\fR)" +.br +.RI "\fIStripFilter a text buffer.\fR" +.ti -1c +.RI "virtual SWModule& \fBAddRawFilter\fR (\fBSWFilter\fR *newfilter)" +.br +.RI "\fIAdds a RawFilter to this module's rawfilters queue.\fR" +.ti -1c +.RI "virtual void \fBfilterBuffer\fR (FilterList *filters, char *buf, long size, \fBSWKey\fR *\fBkey\fR)" +.br +.RI "\fIFilterBuffer a text buffer.\fR" +.ti -1c +.RI "virtual void \fBrawFilter\fR (char *buf, long size, \fBSWKey\fR *\fBkey\fR)" +.br +.RI "\fIRawFilter a text buffer.\fR" +.ti -1c +.RI "virtual SWModule& \fBAddOptionFilter\fR (\fBSWFilter\fR *newfilter)" +.br +.RI "\fIAdds an OptionFilter to this module's optionfilters queue.\fR" +.ti -1c +.RI "virtual void \fBoptionFilter\fR (char *buf, long size, \fBSWKey\fR *\fBkey\fR)" +.br +.RI "\fIOptionFilter a text buffer.\fR" +.ti -1c +.RI "virtual const char* \fBStripText\fR (char *buf=0, int len=-1)" +.br +.RI "\fIcalls all StripFilters on buffer or current text.\fR" +.ti -1c +.RI "virtual const char* \fBRenderText\fR (char *buf=0, int len=-1)" +.br +.RI "\fIcalls all RenderFilters on buffer or current text.\fR" +.ti -1c +.RI "virtual const char* \fBStripText\fR (\fBSWKey\fR *tmpKey)" +.br +.RI "\fIcalls all StripFilters on current text.\fR" +.ti -1c +.RI "virtual const char* \fBRenderText\fR (\fBSWKey\fR *tmpKey)" +.br +.RI "\fIcalls all RenderFilters on current text.\fR" +.in -1c +.SS Public Attributes + +.in +1c +.ti -1c +.RI "bool \fBterminateSearch\fR" +.br +.RI "\fISet this bool to false to terminate the search which is executed by this module (\fBSearch\fR).\fR" +.in -1c +.SS Static Public Methods + +.in +1c +.ti -1c +.RI "void \fBnullPercent\fR (char percent, void *userData)" +.br +.RI "\fIThis is the default callback function for searching.\fR" +.ti -1c +.RI "char \fBcreateModule\fR (const char *)" +.br +.RI "\fICreates a new module.\fR" +.in -1c +.SS Protected Attributes + +.in +1c +.ti -1c +.RI "char \fBerror\fR" +.br +.ti -1c +.RI "\fBSWKey\fR* \fBkey\fR" +.br +.RI "\fIthe current key.\fR" +.ti -1c +.RI "\fBListKey\fR \fBlistkey\fR" +.br +.ti -1c +.RI "char* \fBmodname\fR" +.br +.ti -1c +.RI "char* \fBmoddesc\fR" +.br +.ti -1c +.RI "char* \fBmodtype\fR" +.br +.ti -1c +.RI "\fBSWDisplay\fR* \fBdisp\fR" +.br +.RI "\fIthis module's display object.\fR" +.ti -1c +.RI "char* \fBentrybuf\fR" +.br +.ti -1c +.RI "FilterList* \fBstripFilters\fR" +.br +.RI "\fIexecuted to remove all markup (for searches).\fR" +.ti -1c +.RI "FilterList* \fBrawFilters\fR" +.br +.RI "\fIexecuted immediately upon fileread.\fR" +.ti -1c +.RI "FilterList* \fBrenderFilters\fR" +.br +.RI "\fIexecuted to format for display.\fR" +.ti -1c +.RI "FilterList* \fBoptionFilters\fR" +.br +.RI "\fIexecuted to change markup to user prefs.\fR" +.ti -1c +.RI "bool \fBrender\fR" +.br +.ti -1c +.RI "bool \fBunicode\fR" +.br +.ti -1c +.RI "int \fBentrySize\fR" +.br +.in -1c +.SS Static Protected Attributes + +.in +1c +.ti -1c +.RI "\fBSWDisplay\fR \fBrawdisp\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +The class SWModule is the base class for all modules used in Sword. +.PP +Definition at line 47 of file swmodule.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS SWModule::SWModule (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fR * idisp = 0, char * imodtype = 0, bool unicode = false) +.PP +Initializes data for instance of SWModule. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIimodname\fR\fR +Internal name for module; see also \fBName\fR +.TP +\fB\fIimoddesc\fR\fR +Name to display to user for module; see also \fBDescription\fR +.TP +\fB\fIidisp\fR\fR +Display object to use for displaying see also \fBDisp\fR +.TP +\fB\fIimodtype\fR\fR +Type of Module (All modules will be displayed with others of same type under their modtype heading) see also \fBType\fR +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS SWModule & SWModule::AddOptionFilter (\fBSWFilter\fR * newfilter)\fC [inline, virtual]\fR +.PP +Adds an OptionFilter to this module's optionfilters queue. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fInewfilter\fR\fR +the filter to add +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 443 of file swmodule.h. +.SS SWModule & SWModule::AddRawFilter (\fBSWFilter\fR * newfilter)\fC [inline, virtual]\fR +.PP +Adds a RawFilter to this module's rawfilters queue. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fInewfilter\fR\fR +the filter to add +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 410 of file swmodule.h. +.SS SWModule & SWModule::AddRenderFilter (\fBSWFilter\fR * newfilter)\fC [inline, virtual]\fR +.PP +Adds a RenderFilter to this module's. +.PP +\fBSee also: \fR +.in +1c +renderfilters queue +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fInewfilter\fR\fR +the filter to add +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 363 of file swmodule.h. +.SS SWModule & SWModule::AddStripFilter (\fBSWFilter\fR * newfilter)\fC [inline, virtual]\fR +.PP +Adds a StripFilter to this module's stripfilters queue. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fInewfilter\fR\fR +the filter to add +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 391 of file swmodule.h. +.SS \fBSWKey\fR * SWModule::CreateKey ()\fC [virtual]\fR +.PP +Allocates a key of specific type for module. +.PP +\fBReturns: \fR +.in +1c +pointer to allocated key +.PP +Reimplemented in \fBSWCom\fR, \fBSWLD\fR, and \fBSWText\fR. +.SS char * SWModule::Description (const char * imoddesc = 0)\fC [virtual]\fR +.PP +Sets/gets module description. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIimoddesc\fR\fR +value which to set moddesc; [0] - only get +.PP +\fBReturns: \fR +.in +1c +pointer to moddesc +.SS \fBSWDisplay\fR * SWModule::Disp (\fBSWDisplay\fR * idisp = 0)\fC [virtual]\fR +.PP +Sets/gets display driver. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIidisp\fR\fR +value which to set disp; [0] - only get +.PP +\fBReturns: \fR +.in +1c +pointer to disp +.SS char SWModule::Display ()\fC [virtual]\fR +.PP +Calls this modules display object and passes itself. +.PP +\fBReturns: \fR +.in +1c +error status +.SS char SWModule::Error ()\fC [virtual]\fR +.PP +Gets and clears error status. +.PP +\fBReturns: \fR +.in +1c +error status +.SS char SWModule::Key (const \fBSWKey\fR & ikey)\fC [inline, virtual]\fR +.PP +Sets the current key of the module to ikey, and returns the keytext. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +new current key for the module +.PP +\fBReturns: \fR +.in +1c +the keytext of the current module key +.PP +Definition at line 161 of file swmodule.h. +.SS \fBSWKey\fR & SWModule::Key () const\fC [inline, virtual]\fR +.PP +Gets the current module key. +.PP +\fBReturns: \fR +.in +1c +the current key of this module +.PP +Definition at line 151 of file swmodule.h. +.SS const char * SWModule::KeyText (const char * ikeytext = 0)\fC [virtual]\fR +.PP +Sets/gets module KeyText. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikeytext\fR\fR +value which to set keytext; [0] - only get +.PP +\fBReturns: \fR +.in +1c +pointer to keytext +.PP +Reimplemented in \fBSWLD\fR. +.SS char * SWModule::Name (const char * imodname = 0)\fC [virtual]\fR +.PP +Sets/gets module name. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIimodname\fR\fR +value which to set modname; [0] - only get +.PP +\fBReturns: \fR +.in +1c +pointer to modname +.SS SWModule & SWModule::RemoveRenderFilter (\fBSWFilter\fR * oldfilter)\fC [inline, virtual]\fR +.PP +Removes a RenderFilter to this module's. +.PP +\fBSee also: \fR +.in +1c +renderfilters queue +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIoldfilter\fR\fR +the filter to remove +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 372 of file swmodule.h. +.SS const char * SWModule::RenderText (\fBSWKey\fR * tmpKey)\fC [virtual]\fR +.PP +calls all RenderFilters on current text. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItmpKey\fR\fR +key to use to grab text +.PP +\fBReturns: \fR +.in +1c +this module's text at specified key location massaged by Render filters +.SS const char * SWModule::RenderText (char * buf = 0, int len = -1)\fC [virtual]\fR +.PP +calls all RenderFilters on buffer or current text. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIbuf\fR\fR +buffer to Render instead of current module position; if buf is NULL, the current text will be used +.TP +\fB\fIlen\fR\fR +max len of buf OR current text -- will be applied anyway +.PP +\fBReturns: \fR +.in +1c +this module's text at specified key location massaged by Render filters +.SS \fBListKey\fR & SWModule::Search (const char * istr, int searchType = 0, int flags = 0, \fBSWKey\fR * scope = 0, bool * justCheckIfSupported = 0, void(* percent)(char, void *) = &nullPercent, void * percentUserData = 0)\fC [virtual]\fR +.PP +Searches a module for a string. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIistr\fR\fR +string for which to search +.TP +\fB\fIsearchType\fR\fR +type of search to perform >=0 ->regex; 1->phrase; 2->multiword; +.TP +\fB\fIflags\fR\fR +options flags for search +.TP +\fB\fIjustCheckIfSupported\fR\fR +if set, don't search, only tell if this function supports requested search. +.PP +\fBReturns: \fR +.in +1c +listkey set to verses that contain istr +.SS char SWModule::SetKey (const \fBSWKey\fR & ikey)\fC [virtual]\fR +.PP +Sets the key of this module. +.PP +Similair to +.PP +\fBSee also: \fR +.in +1c +\fBSetKey\fR(const SWKey*) . +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +The \fBSWKey\fR which should be used as new key. +.PP +\fBReturns: \fR +.in +1c +Error status +.SS char SWModule::SetKey (const \fBSWKey\fR * ikey)\fC [virtual]\fR +.PP +Sets a key to this module for position to a particular record or set of records. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +key with which to set this module +.PP +\fBReturns: \fR +.in +1c +error status +.PP +Referenced by Key(). +.SS const char * SWModule::StripText (\fBSWKey\fR * tmpKey)\fC [virtual]\fR +.PP +calls all StripFilters on current text. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItmpKey\fR\fR +key to use to grab text +.PP +\fBReturns: \fR +.in +1c +this module's text at specified key location massaged by Strip filters +.SS const char * SWModule::StripText (char * buf = 0, int len = -1)\fC [virtual]\fR +.PP +calls all StripFilters on buffer or current text. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIbuf\fR\fR +buf to massage instead of current module position; if buf is NULL, the current text will be used +.TP +\fB\fIlen\fR\fR +max len of buf OR current text -- will be applied anyway +.PP +\fBReturns: \fR +.in +1c +this module's text at specified key location massaged by Strip filters +.SS char * SWModule::Type (const char * imodtype = 0)\fC [virtual]\fR +.PP +Sets/gets module type. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIimodtype\fR\fR +value which to set modtype; [0] - only get +.PP +\fBReturns: \fR +.in +1c +pointer to modtype +.SS char SWModule::createModule (const char * path)\fC [inline, static]\fR +.PP +Creates a new module. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIpath\fR\fR +The first parameter is path of the new module +.PP +\fBReturns: \fR +.in +1c +error +.PP +Definition at line 296 of file swmodule.h. +.SS void SWModule::filterBuffer (FilterList * filters, char * buf, long size, \fBSWKey\fR * key)\fC [inline, virtual]\fR +.PP +FilterBuffer a text buffer. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIfilters\fR\fR +the FilterList of filters to iterate +.TP +\fB\fIbuf\fR\fR +the buffer to filter +.TP +\fB\fIsize\fR\fR +the allocated size of the buffer +.TP +\fB\fIkey\fR\fR +key location from where this buffer was extracted +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 422 of file swmodule.h. +.PP +Referenced by optionFilter(), rawFilter(), renderFilter(), and stripFilter(). +.SS const int SWModule::getEntrySize () const\fC [inline, virtual]\fR +.PP +\fBReturns: \fR +.in +1c +The size of the current entry. +.PP +Definition at line 130 of file swmodule.h. +.SS char * SWModule::getRawEntry ()\fC [pure virtual]\fR +.PP +This function is reimplemented by the different kinds of module objects. +.PP +\fBReturns: \fR +.in +1c +the raw module text of the current entry +.SS const bool SWModule::isUnicode () const\fC [inline, virtual]\fR +.PP +\fBReturns: \fR +.in +1c +True if this module is encoded in Unicode, otherwise return false. +.PP +Definition at line 126 of file swmodule.h. +.SS bool SWModule::isWritable ()\fC [inline, virtual]\fR +.PP +Is the module writable? :). +.PP +\fBReturns: \fR +.in +1c +yes or no +.PP +Definition at line 288 of file swmodule.h. +.SS void SWModule::nullPercent (char percent, void * userData)\fC [static]\fR +.PP +This is the default callback function for searching. +.PP +This function is a placeholder and does nothing. You can define your own function for search progress evaluation, and pass it over to \fBSearch\fR. +.SS SWModule::operator char * ()\fC [virtual]\fR +.PP +Renders and returns the current module text. +.PP +\fBReturns: \fR +.in +1c +the rendered current module text +.SS SWModule & SWModule::operator+= (int increment)\fC [virtual]\fR +.PP +Increments module key a number of entries. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIincrement\fR\fR +Number of entries to jump forward +.PP +\fBReturns: \fR +.in +1c +*this +.SS SWModule & SWModule::operator-= (int decrement)\fC [virtual]\fR +.PP +Decrements module key a number of entries. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIdecrement\fR\fR +Number of entries to jump backward +.PP +\fBReturns: \fR +.in +1c +*this +.SS SWModule & SWModule::operator<< (const \fBSWKey\fR * linkKey)\fC [inline, virtual]\fR +.PP +Link the current module entry to another module entry only if module \fBisWritable\fR. +.PP +.TP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 312 of file swmodule.h. +.SS SWModule & SWModule::operator<< (const char * inbuf)\fC [inline, virtual]\fR +.PP +Modify the current module entry text only if module \fBisWritable\fR. +.PP +.TP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 304 of file swmodule.h. +.SS SWModule & SWModule::operator= (SW_POSITION pos)\fC [virtual]\fR +.PP +Positions this modules to an entry. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIp\fR\fR +position (e.g. TOP, BOTTOM) +.PP +\fBReturns: \fR +.in +1c +*this +.SS void SWModule::optionFilter (char * buf, long size, \fBSWKey\fR * key)\fC [inline, virtual]\fR +.PP +OptionFilter a text buffer. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIbuf\fR\fR +the buffer to filter +.TP +\fB\fIsize\fR\fR +the allocated size of the buffer +.TP +\fB\fIkey\fR\fR +key location from where this buffer was extracted +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 454 of file swmodule.h. +.SS void SWModule::rawFilter (char * buf, long size, \fBSWKey\fR * key)\fC [inline, virtual]\fR +.PP +RawFilter a text buffer. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIbuf\fR\fR +the buffer to filter +.TP +\fB\fIsize\fR\fR +the allocated size of the buffer +.TP +\fB\fIkey\fR\fR +key location from where this buffer was extracted +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 435 of file swmodule.h. +.SS void SWModule::renderFilter (char * buf, long size, \fBSWKey\fR * key)\fC [inline, virtual]\fR +.PP +RenderFilter a text buffer. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIbuf\fR\fR +the buffer to filter +.TP +\fB\fIsize\fR\fR +the allocated size of the buffer +.TP +\fB\fIkey\fR\fR +key location from where this buffer was extracted +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 383 of file swmodule.h. +.SS void SWModule::stripFilter (char * buf, long size, \fBSWKey\fR * key)\fC [inline, virtual]\fR +.PP +StripFilter a text buffer. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIbuf\fR\fR +the buffer to filter +.TP +\fB\fIsize\fR\fR +the allocated size of the buffer +.TP +\fB\fIkey\fR\fR +key location from where this buffer was extracted +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Definition at line 402 of file swmodule.h. +.SH MEMBER DATA DOCUMENTATION +.PP +.SS bool SWModule::terminateSearch +.PP +Set this bool to false to terminate the search which is executed by this module (\fBSearch\fR). +.PP +This is useful for threaded applications to terminate the search in another thread. +.PP +Definition at line 97 of file swmodule.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swobject.3 b/doc/api-documentation/man/man3/swobject.3 new file mode 100644 index 0000000..ec2f43a --- /dev/null +++ b/doc/api-documentation/man/man3/swobject.3 @@ -0,0 +1,49 @@ +.TH "SWObject" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWObject \- Base class for major Sword classes. +.SH SYNOPSIS +.br +.PP +\fC#include <swobject.h>\fR +.PP +Inherited by \fBSWKey\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "const \fBSWClass\fR* \fBgetClass\fR () const" +.br +.RI "\fIUse this to get the class definition and inheritance order.\fR" +.in -1c +.SS Protected Attributes + +.in +1c +.ti -1c +.RI "\fBSWClass\fR* \fBmyclass\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +Base class for major Sword classes. +.PP +SWObject is the base class for major Sword classes like \fBSWKey\fR. It is used because dynamic_cast is not available on all plattforms supported by Sword. Use SWDYNAMIC_CAST(classname, object) instead of dynamic_cast<classname>(object). +.PP +Definition at line 41 of file swobject.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS const \fBSWClass\fR * SWObject::getClass () const\fC [inline]\fR +.PP +Use this to get the class definition and inheritance order. +.PP +\fBReturns: \fR +.in +1c +The class definition of this object +.PP +Definition at line 49 of file swobject.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/swtext.3 b/doc/api-documentation/man/man3/swtext.3 new file mode 100644 index 0000000..ad69c4f --- /dev/null +++ b/doc/api-documentation/man/man3/swtext.3 @@ -0,0 +1,55 @@ +.TH "SWText" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWText \- The basis for all text modules. +.SH SYNOPSIS +.br +.PP +\fC#include <swtext.h>\fR +.PP +Inherits \fBSWModule\fR. +.PP +Inherited by EchoMod, RawGBF, RawText, and zText. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWText\fR (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fR *idisp=0, bool unicode=false)" +.br +.RI "\fIInitializes data for instance of SWText.\fR" +.ti -1c +.RI "virtual \fB~SWText\fR ()" +.br +.ti -1c +.RI "virtual \fBSWKey\fR* \fBCreateKey\fR ()" +.br +.RI "\fICreate the correct key (\fBVerseKey\fR) for use with SWText.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +The basis for all text modules. +.PP +Definition at line 34 of file swtext.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS SWText::SWText (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fR * idisp = 0, bool unicode = false) +.PP +Initializes data for instance of SWText. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIimodname\fR\fR +Internal name for module +.TP +\fB\fIimoddesc\fR\fR +Name to display to user for module +.TP +\fB\fIidisp\fR\fR +Display object to use for displaying + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/thmlgbf.3 b/doc/api-documentation/man/man3/thmlgbf.3 new file mode 100644 index 0000000..9adf799 --- /dev/null +++ b/doc/api-documentation/man/man3/thmlgbf.3 @@ -0,0 +1,52 @@ +.TH "ThMLGBF" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLGBF \- this filter converts ThML text to GBF text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlgbf.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBThMLGBF\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen=-1)" +.br +.RI "\fIThis is the main filter function without the 3rd parameter.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts ThML text to GBF text. +.PP +Definition at line 30 of file thmlgbf.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char ThMLGBF::ProcessText (char * text, int maxlen = -1)\fC [virtual]\fR +.PP +This is the main filter function without the 3rd parameter. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/thmlhtml.3 b/doc/api-documentation/man/man3/thmlhtml.3 new file mode 100644 index 0000000..e05d572 --- /dev/null +++ b/doc/api-documentation/man/man3/thmlhtml.3 @@ -0,0 +1,35 @@ +.TH "ThMLHTML" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLHTML \- this filter converts ThML text to HTML text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlhtml.h>\fR +.PP +Inherits SWBasicFilter. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBThMLHTML\fR ()" +.br +.in -1c +.SS Protected Methods + +.in +1c +.ti -1c +.RI "virtual bool \fBhandleToken\fR (char **buf, const char *token, DualStringMap &userData)" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts ThML text to HTML text. +.PP +Definition at line 28 of file thmlhtml.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/thmlhtmlhref.3 b/doc/api-documentation/man/man3/thmlhtmlhref.3 new file mode 100644 index 0000000..c2948fb --- /dev/null +++ b/doc/api-documentation/man/man3/thmlhtmlhref.3 @@ -0,0 +1,35 @@ +.TH "ThMLHTMLHREF" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLHTMLHREF \- this filter converts ThML text to HTML text with hrefs. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlhtmlhref.h>\fR +.PP +Inherits SWBasicFilter. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBThMLHTMLHREF\fR ()" +.br +.in -1c +.SS Protected Methods + +.in +1c +.ti -1c +.RI "virtual bool \fBhandleToken\fR (char **buf, const char *token, DualStringMap &userData)" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts ThML text to HTML text with hrefs. +.PP +Definition at line 26 of file thmlhtmlhref.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/thmlolb.3 b/doc/api-documentation/man/man3/thmlolb.3 new file mode 100644 index 0000000..f3a349c --- /dev/null +++ b/doc/api-documentation/man/man3/thmlolb.3 @@ -0,0 +1,52 @@ +.TH "ThMLOLB" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLOLB \- this filter converts ThML text to OLB text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlolb.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBThMLOLB\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen=-1)" +.br +.RI "\fIThis is the main filter function without the 3rd parameter.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts ThML text to OLB text. +.PP +Definition at line 30 of file thmlolb.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char ThMLOLB::ProcessText (char * text, int maxlen = -1)\fC [virtual]\fR +.PP +This is the main filter function without the 3rd parameter. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/thmlplain.3 b/doc/api-documentation/man/man3/thmlplain.3 new file mode 100644 index 0000000..b6e05a7 --- /dev/null +++ b/doc/api-documentation/man/man3/thmlplain.3 @@ -0,0 +1,52 @@ +.TH "ThMLPlain" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLPlain \- this filter converts ThML text to plain text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlplain.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBThMLPlain\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen=-1)" +.br +.RI "\fIThis is the main filter function without the 3rd parameter.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts ThML text to plain text. +.PP +Definition at line 30 of file thmlplain.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char ThMLPlain::ProcessText (char * text, int maxlen = -1)\fC [virtual]\fR +.PP +This is the main filter function without the 3rd parameter. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/thmlrtf.3 b/doc/api-documentation/man/man3/thmlrtf.3 new file mode 100644 index 0000000..ae1907b --- /dev/null +++ b/doc/api-documentation/man/man3/thmlrtf.3 @@ -0,0 +1,52 @@ +.TH "ThMLRTF" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ThMLRTF \- this filter converts ThML text to RTF text. +.SH SYNOPSIS +.br +.PP +\fC#include <thmlrtf.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBThMLRTF\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen=-1)" +.br +.RI "\fIThis is the main filter function without the 3rd parameter.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +this filter converts ThML text to RTF text. +.PP +Definition at line 30 of file thmlrtf.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char ThMLRTF::ProcessText (char * text, int maxlen = -1)\fC [virtual]\fR +.PP +This is the main filter function without the 3rd parameter. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/unicodertf.3 b/doc/api-documentation/man/man3/unicodertf.3 new file mode 100644 index 0000000..9f58e75 --- /dev/null +++ b/doc/api-documentation/man/man3/unicodertf.3 @@ -0,0 +1,55 @@ +.TH "UnicodeRTF" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UnicodeRTF \- This filter converts UTF-8 text into RTF Unicode tags. +.SH SYNOPSIS +.br +.PP +\fC#include <unicodertf.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBUnicodeRTF\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +This filter converts UTF-8 text into RTF Unicode tags. +.PP +Definition at line 30 of file unicodertf.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char UnicodeRTF::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/utf16utf8.3 b/doc/api-documentation/man/man3/utf16utf8.3 new file mode 100644 index 0000000..61049c9 --- /dev/null +++ b/doc/api-documentation/man/man3/utf16utf8.3 @@ -0,0 +1,55 @@ +.TH "UTF16UTF8" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF16UTF8 \- This filter converts UTF-16 encoded text to UTF-8. +.SH SYNOPSIS +.br +.PP +\fC#include <utf16utf8.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBUTF16UTF8\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +This filter converts UTF-16 encoded text to UTF-8. +.PP +Definition at line 29 of file utf16utf8.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char UTF16UTF8::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/utf8cantillation.3 b/doc/api-documentation/man/man3/utf8cantillation.3 new file mode 100644 index 0000000..3375f68 --- /dev/null +++ b/doc/api-documentation/man/man3/utf8cantillation.3 @@ -0,0 +1,147 @@ +.TH "UTF8Cantillation" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF8Cantillation \- This Filter shows/hides Hebrew cantillation marks in UTF8 text. +.SH SYNOPSIS +.br +.PP +\fC#include <utf8cantillation.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBUTF8Cantillation\fR ()" +.br +.ti -1c +.RI "virtual \fB~UTF8Cantillation\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionName\fR ()" +.br +.RI "\fIgets the name of the option of this filter.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionTip\fR ()" +.br +.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR" +.ti -1c +.RI "virtual void \fBsetOptionValue\fR (const char *ival)" +.br +.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionValue\fR ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fR ()" +.br +.RI "\fIreturns a list of the possible option values might be.\fR" +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "bool \fBoption\fR" +.br +.ti -1c +.RI "OptionsList \fBoptions\fR" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "const char \fBon\fR []" +.br +.ti -1c +.RI "const char \fBoff\fR []" +.br +.ti -1c +.RI "const char \fBoptName\fR []" +.br +.ti -1c +.RI "const char \fBoptTip\fR []" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +This Filter shows/hides Hebrew cantillation marks in UTF8 text. +.PP +Definition at line 29 of file utf8cantillation.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char UTF8Cantillation::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. +.SS const char * UTF8Cantillation::getOptionName ()\fC [inline, virtual]\fR +.PP +gets the name of the option of this filter. +.PP +\fBReturns: \fR +.in +1c +option name +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 41 of file utf8cantillation.h. +.SS const char * UTF8Cantillation::getOptionTip ()\fC [inline, virtual]\fR +.PP +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +.PP +\fBReturns: \fR +.in +1c +option tip/explanation +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 45 of file utf8cantillation.h. +.SS OptionsList UTF8Cantillation::getOptionValues ()\fC [inline, virtual]\fR +.PP +returns a list of the possible option values might be. +.PP +\fBReturns: \fR +.in +1c +list of option values +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 51 of file utf8cantillation.h. +.SS virtual void UTF8Cantillation::setOptionValue (const char * ival)\fC [virtual]\fR +.PP +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIival\fR\fR +the new option valus +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/utf8greekaccents.3 b/doc/api-documentation/man/man3/utf8greekaccents.3 new file mode 100644 index 0000000..4ee9662 --- /dev/null +++ b/doc/api-documentation/man/man3/utf8greekaccents.3 @@ -0,0 +1,147 @@ +.TH "UTF8GreekAccents" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF8GreekAccents \- This Filter shows/hides Greek Accents marks in UTF8 text. +.SH SYNOPSIS +.br +.PP +\fC#include <utf8greekaccents.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBUTF8GreekAccents\fR ()" +.br +.ti -1c +.RI "virtual \fB~UTF8GreekAccents\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionName\fR ()" +.br +.RI "\fIgets the name of the option of this filter.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionTip\fR ()" +.br +.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR" +.ti -1c +.RI "virtual void \fBsetOptionValue\fR (const char *ival)" +.br +.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionValue\fR ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fR ()" +.br +.RI "\fIreturns a list of the possible option values might be.\fR" +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "bool \fBoption\fR" +.br +.ti -1c +.RI "OptionsList \fBoptions\fR" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "const char \fBon\fR []" +.br +.ti -1c +.RI "const char \fBoff\fR []" +.br +.ti -1c +.RI "const char \fBoptName\fR []" +.br +.ti -1c +.RI "const char \fBoptTip\fR []" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +This Filter shows/hides Greek Accents marks in UTF8 text. +.PP +Definition at line 29 of file utf8greekaccents.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char UTF8GreekAccents::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. +.SS const char * UTF8GreekAccents::getOptionName ()\fC [inline, virtual]\fR +.PP +gets the name of the option of this filter. +.PP +\fBReturns: \fR +.in +1c +option name +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 41 of file utf8greekaccents.h. +.SS const char * UTF8GreekAccents::getOptionTip ()\fC [inline, virtual]\fR +.PP +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +.PP +\fBReturns: \fR +.in +1c +option tip/explanation +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 45 of file utf8greekaccents.h. +.SS OptionsList UTF8GreekAccents::getOptionValues ()\fC [inline, virtual]\fR +.PP +returns a list of the possible option values might be. +.PP +\fBReturns: \fR +.in +1c +list of option values +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 51 of file utf8greekaccents.h. +.SS virtual void UTF8GreekAccents::setOptionValue (const char * ival)\fC [virtual]\fR +.PP +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIival\fR\fR +the new option valus +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/utf8hebrewpoints.3 b/doc/api-documentation/man/man3/utf8hebrewpoints.3 new file mode 100644 index 0000000..c68d615 --- /dev/null +++ b/doc/api-documentation/man/man3/utf8hebrewpoints.3 @@ -0,0 +1,147 @@ +.TH "UTF8HebrewPoints" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF8HebrewPoints \- This Filter shows/hides Hebrew vowel points in UTF8 text. +.SH SYNOPSIS +.br +.PP +\fC#include <utf8hebrewpoints.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBUTF8HebrewPoints\fR ()" +.br +.ti -1c +.RI "virtual \fB~UTF8HebrewPoints\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionName\fR ()" +.br +.RI "\fIgets the name of the option of this filter.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionTip\fR ()" +.br +.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR" +.ti -1c +.RI "virtual void \fBsetOptionValue\fR (const char *ival)" +.br +.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR" +.ti -1c +.RI "virtual const char* \fBgetOptionValue\fR ()" +.br +.ti -1c +.RI "virtual OptionsList \fBgetOptionValues\fR ()" +.br +.RI "\fIreturns a list of the possible option values might be.\fR" +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "bool \fBoption\fR" +.br +.ti -1c +.RI "OptionsList \fBoptions\fR" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "const char \fBon\fR []" +.br +.ti -1c +.RI "const char \fBoff\fR []" +.br +.ti -1c +.RI "const char \fBoptName\fR []" +.br +.ti -1c +.RI "const char \fBoptTip\fR []" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +This Filter shows/hides Hebrew vowel points in UTF8 text. +.PP +Definition at line 29 of file utf8hebrewpoints.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char UTF8HebrewPoints::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. +.SS const char * UTF8HebrewPoints::getOptionName ()\fC [inline, virtual]\fR +.PP +gets the name of the option of this filter. +.PP +\fBReturns: \fR +.in +1c +option name +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 41 of file utf8hebrewpoints.h. +.SS const char * UTF8HebrewPoints::getOptionTip ()\fC [inline, virtual]\fR +.PP +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +.PP +\fBReturns: \fR +.in +1c +option tip/explanation +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 45 of file utf8hebrewpoints.h. +.SS OptionsList UTF8HebrewPoints::getOptionValues ()\fC [inline, virtual]\fR +.PP +returns a list of the possible option values might be. +.PP +\fBReturns: \fR +.in +1c +list of option values +.PP +Reimplemented from \fBSWFilter\fR. +.PP +Definition at line 51 of file utf8hebrewpoints.h. +.SS virtual void UTF8HebrewPoints::setOptionValue (const char * ival)\fC [virtual]\fR +.PP +sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIival\fR\fR +the new option valus +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/utf8utf16.3 b/doc/api-documentation/man/man3/utf8utf16.3 new file mode 100644 index 0000000..7c10d02 --- /dev/null +++ b/doc/api-documentation/man/man3/utf8utf16.3 @@ -0,0 +1,55 @@ +.TH "UTF8UTF16" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +UTF8UTF16 \- This filter converts UTF-8 encoded text to UTF-16. +.SH SYNOPSIS +.br +.PP +\fC#include <utf8utf16.h>\fR +.PP +Inherits \fBSWFilter\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBUTF8UTF16\fR ()" +.br +.ti -1c +.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)" +.br +.RI "\fIThis is the main filter function.\fR" +.in -1c +.SH DETAILED DESCRIPTION +.PP +This filter converts UTF-8 encoded text to UTF-16. +.PP +Definition at line 29 of file utf8utf16.h. +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS virtual char UTF8UTF16::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR +.PP +This is the main filter function. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fItext\fR\fR +the text to be filtered/converted +.TP +\fB\fImaxlen\fR\fR +maximal length of text to be processed +.TP +\fB\fIkey\fR\fR +sorry I don't know +.PP +\fBReturns: \fR +.in +1c +0 +.PP +Reimplemented from \fBSWFilter\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file diff --git a/doc/api-documentation/man/man3/versekey.3 b/doc/api-documentation/man/man3/versekey.3 new file mode 100644 index 0000000..bc77131 --- /dev/null +++ b/doc/api-documentation/man/man3/versekey.3 @@ -0,0 +1,650 @@ +.TH "VerseKey" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +VerseKey \- Class VerseKey The \fBSWKey\fR implementation used for verse based modules like Bibles or commentaries. +.SH SYNOPSIS +.br +.PP +\fC#include <versekey.h>\fR +.PP +Inherits \fBSWKey\fR. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBVerseKey\fR (const char *ikey=0)" +.br +.RI "\fIVerseKey Constructor - initializes Instance of VerseKey.\fR" +.ti -1c +.RI "\fBVerseKey\fR (const \fBSWKey\fR *ikey)" +.br +.RI "\fIVerseKey Constructor - initializes instance of VerseKey.\fR" +.ti -1c +.RI "\fBVerseKey\fR (const char *min, const char *max)" +.br +.RI "\fIVerseKey Constructor - initializes instance of VerseKey with boundariess - see also \fBLowerBound\fR and \fBUpperBound\fR.\fR" +.ti -1c +.RI "\fBVerseKey\fR (VerseKey const &k)" +.br +.RI "\fIVerseKey Copy Constructor - will create a new VerseKey based on an existing one.\fR" +.ti -1c +.RI "virtual \fB~VerseKey\fR ()" +.br +.RI "\fIVerseKey Destructor Cleans up an instance of VerseKey.\fR" +.ti -1c +.RI "VerseKey& \fBLowerBound\fR (const char *lb)" +.br +.RI "\fIsets the lower boundary for this VerseKey and returns the new boundary.\fR" +.ti -1c +.RI "VerseKey& \fBUpperBound\fR (const char *ub)" +.br +.RI "\fIsets the upper boundary for this VerseKey and returns the new boundary.\fR" +.ti -1c +.RI "VerseKey& \fBLowerBound\fR () const" +.br +.RI "\fIgets the lower boundary of this VerseKey.\fR" +.ti -1c +.RI "VerseKey& \fBUpperBound\fR () const" +.br +.RI "\fIgets the upper boundary of this VerseKey.\fR" +.ti -1c +.RI "void \fBClearBounds\fR ()" +.br +.RI "\fIclears the boundaries of this VerseKey.\fR" +.ti -1c +.RI "virtual \fBSWKey\fR* \fBclone\fR () const" +.br +.RI "\fICreates a new \fBSWKey\fR based on the current VerseKey see also the Copy Constructor.\fR" +.ti -1c +.RI "virtual const char* \fBgetText\fR () const" +.br +.RI "\fIrefreshes keytext before returning if cast to a (char *) is requested.\fR" +.ti -1c +.RI "virtual void \fBsetText\fR (const char *ikey)" +.br +.RI "\fIEquates this \fBSWKey\fR to a character string.\fR" +.ti -1c +.RI "virtual void \fBcopyFrom\fR (const \fBSWKey\fR &ikey)" +.br +.RI "\fIEquates this \fBSWKey\fR to another \fBSWKey\fR object.\fR" +.ti -1c +.RI "virtual void \fBcopyFrom\fR (const VerseKey &ikey)" +.br +.RI "\fIEquates this VerseKey to another VerseKey.\fR" +.ti -1c +.RI "virtual void \fBsetPosition\fR (SW_POSITION)" +.br +.RI "\fIPositions this key.\fR" +.ti -1c +.RI "virtual void \fBdecrement\fR (int step)" +.br +.RI "\fIDecrements key a number of verses.\fR" +.ti -1c +.RI "virtual void \fBincrement\fR (int step)" +.br +.RI "\fIIncrements key a number of verses.\fR" +.ti -1c +.RI "virtual char \fBTraversable\fR ()" +.br +.ti -1c +.RI "virtual char \fBTestament\fR () const" +.br +.RI "\fIGets testament.\fR" +.ti -1c +.RI "virtual char \fBBook\fR () const" +.br +.RI "\fIGets book.\fR" +.ti -1c +.RI "virtual int \fBChapter\fR () const" +.br +.RI "\fIGets chapter.\fR" +.ti -1c +.RI "virtual int \fBVerse\fR () const" +.br +.RI "\fIGets verse.\fR" +.ti -1c +.RI "virtual char \fBTestament\fR (char itestament)" +.br +.RI "\fISets/gets testament.\fR" +.ti -1c +.RI "virtual char \fBBook\fR (char ibook)" +.br +.RI "\fISets/gets book.\fR" +.ti -1c +.RI "virtual int \fBChapter\fR (int ichapter)" +.br +.RI "\fISets/gets chapter.\fR" +.ti -1c +.RI "virtual int \fBVerse\fR (int iverse)" +.br +.RI "\fISets/gets verse.\fR" +.ti -1c +.RI "virtual void \fBNormalize\fR (char autocheck=0)" +.br +.RI "\fIchecks limits and normalizes if necessary (e.g.\fR" +.ti -1c +.RI "virtual char \fBAutoNormalize\fR (char iautonorm=MAXPOS(char))" +.br +.RI "\fISets/gets flag that tells VerseKey to automatically normalize itself when modified.\fR" +.ti -1c +.RI "virtual char \fBHeadings\fR (char iheadings=MAXPOS(char))" +.br +.RI "\fISets/gets flag that tells VerseKey to include chapter/book/testament/module headings.\fR" +.ti -1c +.RI "virtual long \fBNewIndex\fR () const" +.br +.ti -1c +.RI "virtual long \fBIndex\fR () const" +.br +.RI "\fIGets index based upon current verse.\fR" +.ti -1c +.RI "virtual long \fBIndex\fR (long iindex)" +.br +.RI "\fISets index based upon current verse.\fR" +.ti -1c +.RI "virtual \fBListKey\fR \fBParseVerseList\fR (const char *buf, const char *defaultKey="Genesis 1:1", bool expandRange=false)" +.br +.ti -1c +.RI "virtual int \fBcompare\fR (const \fBSWKey\fR &ikey)" +.br +.RI "\fICompares another \fBSWKey\fR object.\fR" +.ti -1c +.RI "virtual int \fB_compare\fR (const VerseKey &ikey)" +.br +.RI "\fICompares another VerseKey object.\fR" +.ti -1c +.RI "virtual void \fBsetBookAbbrevs\fR (const struct abbrev *bookAbbrevs, unsigned int size=0)" +.br +.ti -1c +.RI "virtual void \fBsetBooks\fR (const char *iBMAX, struct sbook **ibooks)" +.br +.ti -1c +.RI "virtual void \fBsetLocale\fR (const char *name)" +.br +.ti -1c +.RI "virtual SWKEY_OPERATORS \fBSWKey\fR& \fBoperator=\fR (const VerseKey &ikey)" +.br +.in -1c +.SS Public Attributes + +.in +1c +.ti -1c +.RI "const char* \fBBMAX\fR" +.br +.ti -1c +.RI "struct sbook** \fBbooks\fR" +.br +.in -1c +.SS Static Public Attributes + +.in +1c +.ti -1c +.RI "const char \fBbuiltin_BMAX\fR [2]" +.br +.ti -1c +.RI "struct sbook* \fBbuiltin_books\fR [2]" +.br +.ti -1c +.RI "const struct abbrev \fBbuiltin_abbrevs\fR []" +.br +.in -1c +.SS Private Methods + +.in +1c +.ti -1c +.RI "int \fBgetBookAbbrev\fR (char *abbr)" +.br +.ti -1c +.RI "void \fBinitBounds\fR () const" +.br +.ti -1c +.RI "void \fBinitstatics\fR ()" +.br +.RI "\fIinitialize and allocate books array.\fR" +.ti -1c +.RI "void \fBinit\fR ()" +.br +.RI "\fIinitializes this \fBVerseKey\fR().\fR" +.ti -1c +.RI "void \fBfreshtext\fR () const" +.br +.RI "\fIRefresh keytext based on testament|book|chapter|verse default auto normalization to true default display headings option is false.\fR" +.ti -1c +.RI "virtual char \fBparse\fR ()" +.br +.RI "\fIParse a character array into testament|book|chapter|verse.\fR" +.ti -1c +.RI "int \fBfindindex\fR (long *array, int size, long value)" +.br +.RI "\fIBinary search to find the index closest, but less than the given value.\fR" +.in -1c +.SS Private Attributes + +.in +1c +.ti -1c +.RI "\fBListKey\fR \fBinternalListKey\fR" +.br +.ti -1c +.RI "const struct abbrev* \fBabbrevs\fR" +.br +.ti -1c +.RI "int \fBabbrevsCnt\fR" +.br +.ti -1c +.RI "char \fBtestament\fR" +.br +.RI "\fIThe Testament: 0 - Old; 1 - New.\fR" +.ti -1c +.RI "char \fBbook\fR" +.br +.ti -1c +.RI "int \fBchapter\fR" +.br +.ti -1c +.RI "int \fBverse\fR" +.br +.ti -1c +.RI "char \fBautonorm\fR" +.br +.RI "\fIflag for auto normalization.\fR" +.ti -1c +.RI "char \fBheadings\fR" +.br +.RI "\fIflag for headings on/off.\fR" +.ti -1c +.RI "VerseKey* \fBlowerBound\fR" +.br +.ti -1c +.RI "VerseKey * \fBupperBound\fR" +.br +.in -1c +.SS Static Private Attributes + +.in +1c +.ti -1c +.RI "\fBSWClass\fR \fBclassdef\fR" +.br +.ti -1c +.RI "long* \fBoffsets\fR [2][2]" +.br +.ti -1c +.RI "int \fBoffsize\fR [2][2]" +.br +.ti -1c +.RI "int \fBinstance\fR" +.br +.RI "\fInumber of instantiated VerseKey objects or derivitives.\fR" +.ti -1c +.RI "struct sbook \fBotbooks\fR []" +.br +.ti -1c +.RI "struct sbook \fBntbooks\fR []" +.br +.ti -1c +.RI "long \fBotbks\fR []" +.br +.ti -1c +.RI "long \fBotcps\fR []" +.br +.ti -1c +.RI "long \fBntbks\fR []" +.br +.ti -1c +.RI "long \fBntcps\fR []" +.br +.ti -1c +.RI "int \fBvm\fR []" +.br +.ti -1c +.RI "LocaleCache \fBlocaleCache\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +Class VerseKey The \fBSWKey\fR implementation used for verse based modules like Bibles or commentaries. +.PP +Definition at line 66 of file versekey.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS VerseKey::VerseKey (const char * ikey = 0) +.PP +VerseKey Constructor - initializes Instance of VerseKey. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +text key (will take various forms of 'BOOK CH:VS'. See \fBparse\fR for more detailed information) +.SS VerseKey::VerseKey (const \fBSWKey\fR * ikey) +.PP +VerseKey Constructor - initializes instance of VerseKey. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +base key (will take various forms of 'BOOK CH:VS'. See \fBparse\fR for more detailed information) +.SS VerseKey::VerseKey (const char * min, const char * max) +.PP +VerseKey Constructor - initializes instance of VerseKey with boundariess - see also \fBLowerBound\fR and \fBUpperBound\fR. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fImin\fR\fR +the lower boundary of the new VerseKey +.TP +\fB\fImax\fR\fR +the upper boundary of the new VerseKey +.SS VerseKey::VerseKey (VerseKey const & k) +.PP +VerseKey Copy Constructor - will create a new VerseKey based on an existing one. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIk\fR\fR +the VerseKey to copy from +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS char VerseKey::AutoNormalize (char iautonorm = MAXPOS (char))\fC [virtual]\fR +.PP +Sets/gets flag that tells VerseKey to automatically normalize itself when modified. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIiautonorm\fR\fR +value which to set autonorm [MAXPOS(char)] - only get +.PP +\fBReturns: \fR +.in +1c +if unchanged -> value of autonorm, if changed -> previous value of autonorm +.SS char VerseKey::Book (char ibook)\fC [virtual]\fR +.PP +Sets/gets book. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIibook\fR\fR +value which to set book [MAXPOS(char)] - only get +.PP +\fBReturns: \fR +.in +1c +if unchanged -> value of book, if changed -> previous value of book +.SS char VerseKey::Book () const\fC [virtual]\fR +.PP +Gets book. +.PP +\fBReturns: \fR +.in +1c +value of book +.SS int VerseKey::Chapter (int ichapter)\fC [virtual]\fR +.PP +Sets/gets chapter. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIichapter\fR\fR +value which to set chapter [MAXPOS(int)] - only get +.PP +\fBReturns: \fR +.in +1c +if unchanged -> value of chapter, if changed -> previous value of chapter +.SS int VerseKey::Chapter () const\fC [virtual]\fR +.PP +Gets chapter. +.PP +\fBReturns: \fR +.in +1c +value of chapter +.SS char VerseKey::Headings (char iheadings = MAXPOS (char))\fC [virtual]\fR +.PP +Sets/gets flag that tells VerseKey to include chapter/book/testament/module headings. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIiheadings\fR\fR +value which to set headings [MAXPOS(char)] - only get +.PP +\fBReturns: \fR +.in +1c +if unchanged -> value of headings, if changed -> previous value of headings +.SS long VerseKey::Index (long index)\fC [virtual]\fR +.PP +Sets index based upon current verse. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIiindex\fR\fR +value to set index to +.PP +\fBReturns: \fR +.in +1c +offset +.PP +Reimplemented from \fBSWKey\fR. +.SS long VerseKey::Index () const\fC [virtual]\fR +.PP +Gets index based upon current verse. +.PP +\fBReturns: \fR +.in +1c +offset +.PP +Reimplemented from \fBSWKey\fR. +.SS VerseKey & VerseKey::LowerBound () const +.PP +gets the lower boundary of this VerseKey. +.PP +\fBReturns: \fR +.in +1c +the lower boundary of this VerseKey +.SS VerseKey & VerseKey::LowerBound (const char * lb) +.PP +sets the lower boundary for this VerseKey and returns the new boundary. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIlb\fR\fR +the new lower boundary for this VerseKey +.PP +\fBReturns: \fR +.in +1c +the lower boundary the key was set to +.SS void VerseKey::Normalize (char autocheck = 0)\fC [virtual]\fR +.PP +checks limits and normalizes if necessary (e.g. +.PP +Matthew 29:47 = Mark 2:2). If last verse is exceeded, key is set to last Book CH:VS +.PP +\fBReturns: \fR +.in +1c +*this +.SS char VerseKey::Testament (char itestament)\fC [virtual]\fR +.PP +Sets/gets testament. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIitestament\fR\fR +value which to set testament [MAXPOS(char)] - only get +.PP +\fBReturns: \fR +.in +1c +if unchanged -> value of testament, if changed -> previous value of testament +.SS char VerseKey::Testament () const\fC [virtual]\fR +.PP +Gets testament. +.PP +\fBReturns: \fR +.in +1c +value of testament +.SS VerseKey & VerseKey::UpperBound () const +.PP +gets the upper boundary of this VerseKey. +.PP +\fBReturns: \fR +.in +1c +the upper boundary of this VerseKey +.SS VerseKey & VerseKey::UpperBound (const char * ub) +.PP +sets the upper boundary for this VerseKey and returns the new boundary. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIlb\fR\fR +the new upper boundary for this VerseKey +.PP +\fBReturns: \fR +.in +1c +the upper boundary the key was set to +.SS int VerseKey::Verse (int iverse)\fC [virtual]\fR +.PP +Sets/gets verse. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIiverse\fR\fR +value which to set verse [MAXPOS(int)] - only get +.PP +\fBReturns: \fR +.in +1c +if unchanged -> value of verse, if changed -> previous value of verse +.SS int VerseKey::Verse () const\fC [virtual]\fR +.PP +Gets verse. +.PP +\fBReturns: \fR +.in +1c +value of verse +.SS int VerseKey::_compare (const VerseKey & ikey)\fC [virtual]\fR +.PP +Compares another VerseKey object. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +key to compare with this one +.PP +\fBReturns: \fR +.in +1c +>0 if this VerseKey is greater than compare VerseKey, <0 if this VerseKey is smaller than compare VerseKey, 0 if the keys are the same +.SS int VerseKey::compare (const \fBSWKey\fR & ikey)\fC [virtual]\fR +.PP +Compares another \fBSWKey\fR object. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +key to compare with this one +.PP +\fBReturns: \fR +.in +1c +>0 if this VerseKey is greater than compare \fBSWKey\fR, <0 if this VerseKey is smaller than compare \fBSWKey\fR, 0 if the keys are the same +.PP +Reimplemented from \fBSWKey\fR. +.SS virtual void VerseKey::copyFrom (const \fBSWKey\fR & ikey)\fC [virtual]\fR +.PP +Equates this \fBSWKey\fR to another \fBSWKey\fR object. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +other swkey object +.PP +Reimplemented from \fBSWKey\fR. +.SS void VerseKey::decrement (int step)\fC [virtual]\fR +.PP +Decrements key a number of verses. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIdecrement\fR\fR +Number of verses to jump backward +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Reimplemented from \fBSWKey\fR. +.SS int VerseKey::findindex (long * array, int size, long value)\fC [private]\fR +.PP +Binary search to find the index closest, but less than the given value. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIarray\fR\fR +long * to array to search +.TP +\fB\fIsize\fR\fR +number of elements in the array +.TP +\fB\fIvalue\fR\fR +value to find +.PP +\fBReturns: \fR +.in +1c +the index into the array that is less than but closest to value +.SS void VerseKey::increment (int step)\fC [virtual]\fR +.PP +Increments key a number of verses. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIincrement\fR\fR +Number of verses to jump forward +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Reimplemented from \fBSWKey\fR. +.SS void VerseKey::setPosition (SW_POSITION)\fC [virtual]\fR +.PP +Positions this key. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIp\fR\fR +position +.PP +\fBReturns: \fR +.in +1c +*this +.PP +Reimplemented from \fBSWKey\fR. +.SS void VerseKey::setText (const char * ikey)\fC [inline, virtual]\fR +.PP +Equates this \fBSWKey\fR to a character string. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikey\fR\fR +string to set this key to +.PP +Reimplemented from \fBSWKey\fR. +.PP +Definition at line 228 of file versekey.h. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file |