diff options
Diffstat (limited to 'doc/api-documentation/html')
571 files changed, 48942 insertions, 0 deletions
diff --git a/doc/api-documentation/html/Greek2Greek.h-source.html b/doc/api-documentation/html/Greek2Greek.h-source.html new file mode 100644 index 0000000..e31c6a7 --- /dev/null +++ b/doc/api-documentation/html/Greek2Greek.h-source.html @@ -0,0 +1,129 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>Greek2Greek.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Greek2Greek.h</h1><div class="fragment"><pre>00001 <font class="comment">//*****************************************************************************</font> +00002 <font class="comment">// Author : William Dicks ***</font> +00003 <font class="comment">// Date Created: 10 February 1998 ***</font> +00004 <font class="comment">// Purpose : Interface for Greek to b-Greek conversion and vice versa ***</font> +00005 <font class="comment">// File Name : Greek2Greek.h ***</font> +00006 <font class="comment">// ***</font> +00007 <font class="comment">// Author info : ---------------------------------------------------------- ***</font> +00008 <font class="comment">// Address : 23 Tieroogpark ***</font> +00009 <font class="comment">// : Hoewe Str ***</font> +00010 <font class="comment">// : Elarduspark X3 ***</font> +00011 <font class="comment">// : 0181 ***</font> +00012 <font class="comment">// : South Africa ***</font> +00013 <font class="comment">// Home Tel: +27 (0)12 345 3166 ***</font> +00014 <font class="comment">// Cell No : +27 (0)82 577 4424 ***</font> +00015 <font class="comment">// e-mail : wd@isis.co.za ***</font> +00016 <font class="comment">// Church WWW : http://www.hatfield.co.za ***</font> +00017 <font class="comment">//*****************************************************************************</font> +00018 <font class="comment">/* +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> * $Id: Greek2Greek.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00021 <font class="comment"> * +</font>00022 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00023 <font class="comment"> * CrossWire Bible Society +</font>00024 <font class="comment"> * P. O. Box 2528 +</font>00025 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00026 <font class="comment"> * +</font>00027 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00028 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00029 <font class="comment"> * Free Software Foundation version 2. +</font>00030 <font class="comment"> * +</font>00031 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00032 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00033 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00034 <font class="comment"> * General Public License for more details. +</font>00035 <font class="comment"> * +</font>00036 <font class="comment"> */</font> +00037 +00038 <font class="preprocessor">#ifndef __GREEK2GREEK +</font>00039 <font class="preprocessor"></font><font class="preprocessor">#define __GREEK2GREEK +</font>00040 <font class="preprocessor"></font> +00041 <font class="comment">//*****************************************************************************</font> +00042 <font class="comment">// Used to convert a string created by using the Greek font supplied with the</font> +00043 <font class="comment">// Sword Project to a string that conforms to the b-Greek discussion list </font> +00044 <font class="comment">// method of transliteration.</font> +00045 <font class="comment">//*****************************************************************************</font> +00046 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Greek2bGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, +00047 <font class="keywordtype">int</font> nMaxResultBuflen); +00048 +00049 <font class="comment">//*****************************************************************************</font> +00050 <font class="comment">// Used to convert a string created by using the b-Greek method of </font> +00051 <font class="comment">// transliteration to a string that can be converted to a Greek-font readable </font> +00052 <font class="comment">// string.</font> +00053 <font class="comment">//*****************************************************************************</font> +00054 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> bGreek2Greek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, +00055 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, <font class="keywordtype">int</font> nMaxResultBuflen); +00056 +00057 <font class="comment">//*****************************************************************************</font> +00058 <font class="comment">// Parse a Greek font created string and return the b-Greek equivalent</font> +00059 <font class="comment">//*****************************************************************************</font> +00060 <font class="keywordtype">int</font> ParseGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, +00061 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, <font class="keywordtype">int</font> nMaxResultBuflen); +00062 +00063 <font class="comment">//*****************************************************************************</font> +00064 <font class="comment">// Parse a b-Greek string and return the Greek font equivalent</font> +00065 <font class="comment">//*****************************************************************************</font> +00066 <font class="keywordtype">int</font> ParsebGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, +00067 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, <font class="keywordtype">int</font> nMaxResultBuflen); +00068 +00069 <font class="comment">//*****************************************************************************</font> +00070 <font class="comment">// Convert a unsigned character to a GREEK font unsigned character</font> +00071 <font class="comment">//*****************************************************************************</font> +00072 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> char2Font (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> letter, <font class="comment">// bGreek letter to convert to Font letter</font> +00073 <font class="keywordtype">bool</font> finalSigma, <font class="comment">// Is it a final SIGMA</font> +00074 <font class="keywordtype">bool</font> iota, <font class="comment">// TRUE = IOTA subscript; FALSE = No IOTA</font> +00075 <font class="keywordtype">bool</font> breathing, <font class="comment">// TRUE = add breathing; FALSE = no breathing</font> +00076 <font class="keywordtype">bool</font> rough); <font class="comment">// TRUE = rough breathing; False = smooth</font> +00077 +00078 <font class="comment">//*****************************************************************************</font> +00079 <font class="comment">// Convert a GREEK font unsigned character to a unsigned character</font> +00080 <font class="comment">//*****************************************************************************</font> +00081 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Font2char (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> letter, <font class="comment">// bGreek letter to convert to Font letter</font> +00082 <font class="keywordtype">bool</font> & iota, <font class="comment">// TRUE = IOTA subscript; FALSE = No IOTA</font> +00083 <font class="keywordtype">bool</font> & breathing, <font class="comment">// TRUE = add breathing; FALSE = no breathing</font> +00084 <font class="keywordtype">bool</font> & rough); <font class="comment">// TRUE = rough breathing; False = smooth</font> +00085 +00086 +00087 <font class="comment">//*****************************************************************************</font> +00088 <font class="comment">// Identify and return a bGreek letter from a special font char</font> +00089 <font class="comment">//*****************************************************************************</font> +00090 <font class="keywordtype">bool</font> getSpecialChar (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Font, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> &letter); +00091 +00092 <font class="comment">//*****************************************************************************</font> +00093 <font class="comment">// true if the font character is a special character; false it isn't</font> +00094 <font class="comment">//*****************************************************************************</font> +00095 <font class="keywordtype">bool</font> SpecialGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Font); +00096 +00097 <font class="comment">//*****************************************************************************</font> +00098 <font class="comment">// Return Greek font puntuation from bGreek punstuation</font> +00099 <font class="comment">//*****************************************************************************</font> +00100 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> getGreekPunct (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> bGreek); +00101 +00102 <font class="comment">//*****************************************************************************</font> +00103 <font class="comment">// Return bGreek puntuation from Greek font punstuation</font> +00104 <font class="comment">//*****************************************************************************</font> +00105 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> getbGreekPunct (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Greek); +00106 +00107 <font class="comment">//*****************************************************************************</font> +00108 <font class="comment">// Is the character punctuation or a space: true it is, false it isn't</font> +00109 <font class="comment">//*****************************************************************************</font> +00110 <font class="keywordtype">bool</font> isPunctSpace (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> c); +00111 +00112 +00113 +00114 <font class="preprocessor">#endif // __GREEK2GREEK +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/GreekChars.h-source.html b/doc/api-documentation/html/GreekChars.h-source.html new file mode 100644 index 0000000..1358858 --- /dev/null +++ b/doc/api-documentation/html/GreekChars.h-source.html @@ -0,0 +1,164 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>GreekChars.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GreekChars.h</h1><div class="fragment"><pre>00001 <font class="comment">//*****************************************************************************</font> +00002 <font class="comment">// Author : William Dicks ***</font> +00003 <font class="comment">// Date Created: 10 February 1998 ***</font> +00004 <font class="comment">// Purpose : Enumeration for Greek to b-Greek conversion and vice ***</font> +00005 <font class="comment">// : versa. ***</font> +00006 <font class="comment">// File Name : GreekChars.h ***</font> +00007 <font class="comment">// ***</font> +00008 <font class="comment">// Author info : ---------------------------------------------------------- ***</font> +00009 <font class="comment">// Address : 23 Tieroogpark ***</font> +00010 <font class="comment">// : Hoewe Str ***</font> +00011 <font class="comment">// : Elarduspark X3 ***</font> +00012 <font class="comment">// : 0181 ***</font> +00013 <font class="comment">// : South Africa ***</font> +00014 <font class="comment">// Home Tel: +27 (0)12 345 3166 ***</font> +00015 <font class="comment">// Cell No : +27 (0)82 577 4424 ***</font> +00016 <font class="comment">// e-mail : wd@isis.co.za ***</font> +00017 <font class="comment">// Church WWW : http://www.hatfield.co.za ***</font> +00018 <font class="comment">//*****************************************************************************</font> +00019 <font class="comment">/* +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> * $Id: GreekChars.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00022 <font class="comment"> * +</font>00023 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00024 <font class="comment"> * CrossWire Bible Society +</font>00025 <font class="comment"> * P. O. Box 2528 +</font>00026 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00027 <font class="comment"> * +</font>00028 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00029 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00030 <font class="comment"> * Free Software Foundation version 2. +</font>00031 <font class="comment"> * +</font>00032 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00033 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00034 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00035 <font class="comment"> * General Public License for more details. +</font>00036 <font class="comment"> * +</font>00037 <font class="comment"> */</font> +00038 +00039 <font class="preprocessor">#ifndef __GREEKCHARS_H +</font>00040 <font class="preprocessor"></font><font class="preprocessor">#define __GREEKCHARS_H +</font>00041 <font class="preprocessor"></font> +00042 <font class="comment">// This enum represents the values of the characters used for the </font> +00043 <font class="comment">// transliteration as used on the b-greek discussion list.</font> +00044 +00045 <font class="keyword">enum</font> bGreekChars +00046 { +00047 ALPHA = 65, <font class="comment">// A</font> +00048 BETA, <font class="comment">// B</font> +00049 CHI, <font class="comment">// C</font> +00050 DELTA, <font class="comment">// D</font> +00051 EPSILON, <font class="comment">// E</font> +00052 PHI, <font class="comment">// F</font> +00053 GAMMA, <font class="comment">// G</font> +00054 ETA, <font class="comment">// H</font> +00055 IOTA, <font class="comment">// I</font> +00056 <font class="comment">// No J</font> +00057 KAPPA = 75, <font class="comment">// K</font> +00058 LAMBDA, <font class="comment">// L</font> +00059 MU, <font class="comment">// M</font> +00060 NU, <font class="comment">// N</font> +00061 OMICRON, <font class="comment">// O</font> +00062 PI, <font class="comment">// P</font> +00063 THETA, <font class="comment">// Q</font> +00064 RHO, <font class="comment">// R</font> +00065 SIGMA, <font class="comment">// S</font> +00066 TAU, <font class="comment">// T</font> +00067 UPSILON, <font class="comment">// U</font> +00068 <font class="comment">// No V</font> +00069 OMEGA = <font class="charliteral">'W'</font>, <font class="comment">// W</font> +00070 XI, <font class="comment">// X</font> +00071 PSI, <font class="comment">// Y</font> +00072 ZETA, <font class="comment">// Z</font> +00073 ROUGH = 104, <font class="comment">// h</font> +00074 IOTA_SUB <font class="comment">// i</font> +00075 }; +00076 +00077 <font class="comment">// This enum represents the values of the characters ib the Greek.ttf font,</font> +00078 <font class="comment">// and the comments on the right are the corresponding bGreek equivalents.</font> +00079 +00080 <font class="keyword">enum</font> GreekFontChars +00081 { +00082 gALPHA = <font class="charliteral">'a'</font>, <font class="comment">// A</font> +00083 gBETA, <font class="comment">// B</font> +00084 gCHI, <font class="comment">// C</font> +00085 gDELTA, <font class="comment">// D</font> +00086 gEPSILON, <font class="comment">// E</font> +00087 gPHI, <font class="comment">// F</font> +00088 gGAMMA, <font class="comment">// G</font> +00089 gETA, <font class="comment">// H</font> +00090 gIOTA, <font class="comment">// I</font> +00091 gSIGMA_END, <font class="comment">// j</font> +00092 gKAPPA, <font class="comment">// K</font> +00093 gLAMBDA, <font class="comment">// L</font> +00094 gMU, <font class="comment">// M</font> +00095 gNU, <font class="comment">// N</font> +00096 gOMICRON, <font class="comment">// O</font> +00097 gPI, <font class="comment">// P</font> +00098 gTHETA, <font class="comment">// Q</font> +00099 gRHO, <font class="comment">// R</font> +00100 gSIGMA, <font class="comment">// S</font> +00101 gTAU, <font class="comment">// T</font> +00102 gUPSILON, <font class="comment">// U</font> +00103 <font class="comment">// No V</font> +00104 gOMEGA = <font class="charliteral">'w'</font>, <font class="comment">// W</font> +00105 gXI, <font class="comment">// X</font> +00106 gPSI, <font class="comment">// Y</font> +00107 gZETA, <font class="comment">// Z</font> +00108 gROUGH_ALPHA = 161, <font class="comment">// hA</font> +00109 gROUGH_EPSILON = 152, <font class="comment">// hE</font> +00110 gROUGH_ETA = 185, <font class="comment">// hH</font> +00111 gROUGH_IOTA = 131, <font class="comment">// hH</font> +00112 gROUGH_OMICRON = 208, <font class="comment">// hH</font> +00113 gROUGH_RHO = 183, <font class="comment">// hR</font> +00114 gROUGH_UPSILON = 216, <font class="comment">// hU</font> +00115 gROUGH_OMEGA = 230, <font class="comment">// hW</font> +00116 gIOTA_ALPHA = <font class="charliteral">'v'</font>, <font class="comment">// Ai</font> +00117 gIOTA_ETA = <font class="charliteral">'V'</font>, <font class="comment">// Ei</font> +00118 gIOTA_OMEGA = <font class="charliteral">'J'</font>, <font class="comment">// Wi</font> +00119 gNON_ROUGH_ALPHA = 162, <font class="comment">// hA</font> +00120 gNON_ROUGH_EPSILON = 153, <font class="comment">// hE</font> +00121 gNON_ROUGH_ETA = 186, <font class="comment">// hH</font> +00122 gNON_ROUGH_IOTA = 132, <font class="comment">// hH</font> +00123 gNON_ROUGH_OMICRON = 209, <font class="comment">// hH</font> +00124 gNON_ROUGH_RHO = 184, <font class="comment">// hR</font> +00125 gNON_ROUGH_UPSILON = 217, <font class="comment">// hU</font> +00126 gNON_ROUGH_OMEGA = 231 <font class="comment">// hW</font> +00127 }; +00128 +00129 <font class="comment">// English puntuation as used on bGreek</font> +00130 +00131 <font class="keyword">enum</font> bGreekPunct +00132 { +00133 COMMA = <font class="charliteral">','</font>, +00134 STOP = <font class="charliteral">'.'</font>, +00135 SEMI_COLON = <font class="charliteral">';'</font>, +00136 QUESTION = <font class="charliteral">'?'</font> +00137 }; +00138 +00139 <font class="comment">// English puntuation as used in the Greek font</font> +00140 +00141 <font class="keyword">enum</font> GreekPunct +00142 { +00143 gCOMMA = <font class="charliteral">','</font>, +00144 gSTOP = <font class="charliteral">'.'</font>, +00145 gSEMI_COLON = <font class="charliteral">':'</font>, +00146 gQUESTION = <font class="charliteral">';'</font> +00147 }; +00148 +00149 <font class="preprocessor">#endif // __GREEKCHARS_H +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/_greek2_greek_8h-source.html b/doc/api-documentation/html/_greek2_greek_8h-source.html new file mode 100644 index 0000000..f0974c2 --- /dev/null +++ b/doc/api-documentation/html/_greek2_greek_8h-source.html @@ -0,0 +1,129 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Greek2Greek.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Greek2Greek.h</h1><div class="fragment"><pre>00001 <font class="comment">//*****************************************************************************</font> +00002 <font class="comment">// Author : William Dicks ***</font> +00003 <font class="comment">// Date Created: 10 February 1998 ***</font> +00004 <font class="comment">// Purpose : Interface for Greek to b-Greek conversion and vice versa ***</font> +00005 <font class="comment">// File Name : Greek2Greek.h ***</font> +00006 <font class="comment">// ***</font> +00007 <font class="comment">// Author info : ---------------------------------------------------------- ***</font> +00008 <font class="comment">// Address : 23 Tieroogpark ***</font> +00009 <font class="comment">// : Hoewe Str ***</font> +00010 <font class="comment">// : Elarduspark X3 ***</font> +00011 <font class="comment">// : 0181 ***</font> +00012 <font class="comment">// : South Africa ***</font> +00013 <font class="comment">// Home Tel: +27 (0)12 345 3166 ***</font> +00014 <font class="comment">// Cell No : +27 (0)82 577 4424 ***</font> +00015 <font class="comment">// e-mail : wd@isis.co.za ***</font> +00016 <font class="comment">// Church WWW : http://www.hatfield.co.za ***</font> +00017 <font class="comment">//*****************************************************************************</font> +00018 <font class="comment">/*</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> * $Id: _greek2_greek_8h-source.html,v 1.4 2002/01/22 14:20:26 jansorg Exp $</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00023 <font class="comment"> * CrossWire Bible Society</font> +00024 <font class="comment"> * P. O. Box 2528</font> +00025 <font class="comment"> * Tempe, AZ 85280-2528</font> +00026 <font class="comment"> *</font> +00027 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00028 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00029 <font class="comment"> * Free Software Foundation version 2.</font> +00030 <font class="comment"> *</font> +00031 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00032 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00033 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00034 <font class="comment"> * General Public License for more details.</font> +00035 <font class="comment"> *</font> +00036 <font class="comment"> */</font> +00037 +00038 <font class="preprocessor">#ifndef __GREEK2GREEK</font> +00039 <font class="preprocessor"></font><font class="preprocessor">#define __GREEK2GREEK</font> +00040 <font class="preprocessor"></font> +00041 <font class="comment">//*****************************************************************************</font> +00042 <font class="comment">// Used to convert a string created by using the Greek font supplied with the</font> +00043 <font class="comment">// Sword Project to a string that conforms to the b-Greek discussion list </font> +00044 <font class="comment">// method of transliteration.</font> +00045 <font class="comment">//*****************************************************************************</font> +00046 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Greek2bGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, +00047 <font class="keywordtype">int</font> nMaxResultBuflen); +00048 +00049 <font class="comment">//*****************************************************************************</font> +00050 <font class="comment">// Used to convert a string created by using the b-Greek method of </font> +00051 <font class="comment">// transliteration to a string that can be converted to a Greek-font readable </font> +00052 <font class="comment">// string.</font> +00053 <font class="comment">//*****************************************************************************</font> +00054 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> bGreek2Greek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, +00055 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, <font class="keywordtype">int</font> nMaxResultBuflen); +00056 +00057 <font class="comment">//*****************************************************************************</font> +00058 <font class="comment">// Parse a Greek font created string and return the b-Greek equivalent</font> +00059 <font class="comment">//*****************************************************************************</font> +00060 <font class="keywordtype">int</font> ParseGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, +00061 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, <font class="keywordtype">int</font> nMaxResultBuflen); +00062 +00063 <font class="comment">//*****************************************************************************</font> +00064 <font class="comment">// Parse a b-Greek string and return the Greek font equivalent</font> +00065 <font class="comment">//*****************************************************************************</font> +00066 <font class="keywordtype">int</font> ParsebGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, +00067 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, <font class="keywordtype">int</font> nMaxResultBuflen); +00068 +00069 <font class="comment">//*****************************************************************************</font> +00070 <font class="comment">// Convert a unsigned character to a GREEK font unsigned character</font> +00071 <font class="comment">//*****************************************************************************</font> +00072 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> char2Font (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> letter, <font class="comment">// bGreek letter to convert to Font letter</font> +00073 <font class="keywordtype">bool</font> finalSigma, <font class="comment">// Is it a final SIGMA</font> +00074 <font class="keywordtype">bool</font> iota, <font class="comment">// TRUE = IOTA subscript; FALSE = No IOTA</font> +00075 <font class="keywordtype">bool</font> breathing, <font class="comment">// TRUE = add breathing; FALSE = no breathing</font> +00076 <font class="keywordtype">bool</font> rough); <font class="comment">// TRUE = rough breathing; False = smooth</font> +00077 +00078 <font class="comment">//*****************************************************************************</font> +00079 <font class="comment">// Convert a GREEK font unsigned character to a unsigned character</font> +00080 <font class="comment">//*****************************************************************************</font> +00081 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Font2char (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> letter, <font class="comment">// bGreek letter to convert to Font letter</font> +00082 <font class="keywordtype">bool</font> & iota, <font class="comment">// TRUE = IOTA subscript; FALSE = No IOTA</font> +00083 <font class="keywordtype">bool</font> & breathing, <font class="comment">// TRUE = add breathing; FALSE = no breathing</font> +00084 <font class="keywordtype">bool</font> & rough); <font class="comment">// TRUE = rough breathing; False = smooth</font> +00085 +00086 +00087 <font class="comment">//*****************************************************************************</font> +00088 <font class="comment">// Identify and return a bGreek letter from a special font char</font> +00089 <font class="comment">//*****************************************************************************</font> +00090 <font class="keywordtype">bool</font> getSpecialChar (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Font, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> &letter); +00091 +00092 <font class="comment">//*****************************************************************************</font> +00093 <font class="comment">// true if the font character is a special character; false it isn't</font> +00094 <font class="comment">//*****************************************************************************</font> +00095 <font class="keywordtype">bool</font> SpecialGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Font); +00096 +00097 <font class="comment">//*****************************************************************************</font> +00098 <font class="comment">// Return Greek font puntuation from bGreek punstuation</font> +00099 <font class="comment">//*****************************************************************************</font> +00100 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> getGreekPunct (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> bGreek); +00101 +00102 <font class="comment">//*****************************************************************************</font> +00103 <font class="comment">// Return bGreek puntuation from Greek font punstuation</font> +00104 <font class="comment">//*****************************************************************************</font> +00105 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> getbGreekPunct (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Greek); +00106 +00107 <font class="comment">//*****************************************************************************</font> +00108 <font class="comment">// Is the character punctuation or a space: true it is, false it isn't</font> +00109 <font class="comment">//*****************************************************************************</font> +00110 <font class="keywordtype">bool</font> isPunctSpace (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> c); +00111 +00112 +00113 +00114 <font class="preprocessor">#endif // __GREEK2GREEK</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/_greek_chars_8h-source.html b/doc/api-documentation/html/_greek_chars_8h-source.html new file mode 100644 index 0000000..4f7759c --- /dev/null +++ b/doc/api-documentation/html/_greek_chars_8h-source.html @@ -0,0 +1,164 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GreekChars.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GreekChars.h</h1><div class="fragment"><pre>00001 <font class="comment">//*****************************************************************************</font> +00002 <font class="comment">// Author : William Dicks ***</font> +00003 <font class="comment">// Date Created: 10 February 1998 ***</font> +00004 <font class="comment">// Purpose : Enumeration for Greek to b-Greek conversion and vice ***</font> +00005 <font class="comment">// : versa. ***</font> +00006 <font class="comment">// File Name : GreekChars.h ***</font> +00007 <font class="comment">// ***</font> +00008 <font class="comment">// Author info : ---------------------------------------------------------- ***</font> +00009 <font class="comment">// Address : 23 Tieroogpark ***</font> +00010 <font class="comment">// : Hoewe Str ***</font> +00011 <font class="comment">// : Elarduspark X3 ***</font> +00012 <font class="comment">// : 0181 ***</font> +00013 <font class="comment">// : South Africa ***</font> +00014 <font class="comment">// Home Tel: +27 (0)12 345 3166 ***</font> +00015 <font class="comment">// Cell No : +27 (0)82 577 4424 ***</font> +00016 <font class="comment">// e-mail : wd@isis.co.za ***</font> +00017 <font class="comment">// Church WWW : http://www.hatfield.co.za ***</font> +00018 <font class="comment">//*****************************************************************************</font> +00019 <font class="comment">/*</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> * $Id: _greek_chars_8h-source.html,v 1.4 2002/01/22 14:20:26 jansorg Exp $</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00024 <font class="comment"> * CrossWire Bible Society</font> +00025 <font class="comment"> * P. O. Box 2528</font> +00026 <font class="comment"> * Tempe, AZ 85280-2528</font> +00027 <font class="comment"> *</font> +00028 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00029 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00030 <font class="comment"> * Free Software Foundation version 2.</font> +00031 <font class="comment"> *</font> +00032 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00033 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00034 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00035 <font class="comment"> * General Public License for more details.</font> +00036 <font class="comment"> *</font> +00037 <font class="comment"> */</font> +00038 +00039 <font class="preprocessor">#ifndef __GREEKCHARS_H</font> +00040 <font class="preprocessor"></font><font class="preprocessor">#define __GREEKCHARS_H</font> +00041 <font class="preprocessor"></font> +00042 <font class="comment">// This enum represents the values of the characters used for the </font> +00043 <font class="comment">// transliteration as used on the b-greek discussion list.</font> +00044 +00045 <font class="keyword">enum</font> bGreekChars +00046 { +00047 ALPHA = 65, <font class="comment">// A</font> +00048 BETA, <font class="comment">// B</font> +00049 CHI, <font class="comment">// C</font> +00050 DELTA, <font class="comment">// D</font> +00051 EPSILON, <font class="comment">// E</font> +00052 PHI, <font class="comment">// F</font> +00053 GAMMA, <font class="comment">// G</font> +00054 ETA, <font class="comment">// H</font> +00055 IOTA, <font class="comment">// I</font> +00056 <font class="comment">// No J</font> +00057 KAPPA = 75, <font class="comment">// K</font> +00058 LAMBDA, <font class="comment">// L</font> +00059 MU, <font class="comment">// M</font> +00060 NU, <font class="comment">// N</font> +00061 OMICRON, <font class="comment">// O</font> +00062 PI, <font class="comment">// P</font> +00063 THETA, <font class="comment">// Q</font> +00064 RHO, <font class="comment">// R</font> +00065 SIGMA, <font class="comment">// S</font> +00066 TAU, <font class="comment">// T</font> +00067 UPSILON, <font class="comment">// U</font> +00068 <font class="comment">// No V</font> +00069 OMEGA = <font class="charliteral">'W'</font>, <font class="comment">// W</font> +00070 XI, <font class="comment">// X</font> +00071 PSI, <font class="comment">// Y</font> +00072 ZETA, <font class="comment">// Z</font> +00073 ROUGH = 104, <font class="comment">// h</font> +00074 IOTA_SUB <font class="comment">// i</font> +00075 }; +00076 +00077 <font class="comment">// This enum represents the values of the characters ib the Greek.ttf font,</font> +00078 <font class="comment">// and the comments on the right are the corresponding bGreek equivalents.</font> +00079 +00080 <font class="keyword">enum</font> GreekFontChars +00081 { +00082 gALPHA = <font class="charliteral">'a'</font>, <font class="comment">// A</font> +00083 gBETA, <font class="comment">// B</font> +00084 gCHI, <font class="comment">// C</font> +00085 gDELTA, <font class="comment">// D</font> +00086 gEPSILON, <font class="comment">// E</font> +00087 gPHI, <font class="comment">// F</font> +00088 gGAMMA, <font class="comment">// G</font> +00089 gETA, <font class="comment">// H</font> +00090 gIOTA, <font class="comment">// I</font> +00091 gSIGMA_END, <font class="comment">// j</font> +00092 gKAPPA, <font class="comment">// K</font> +00093 gLAMBDA, <font class="comment">// L</font> +00094 gMU, <font class="comment">// M</font> +00095 gNU, <font class="comment">// N</font> +00096 gOMICRON, <font class="comment">// O</font> +00097 gPI, <font class="comment">// P</font> +00098 gTHETA, <font class="comment">// Q</font> +00099 gRHO, <font class="comment">// R</font> +00100 gSIGMA, <font class="comment">// S</font> +00101 gTAU, <font class="comment">// T</font> +00102 gUPSILON, <font class="comment">// U</font> +00103 <font class="comment">// No V</font> +00104 gOMEGA = <font class="charliteral">'w'</font>, <font class="comment">// W</font> +00105 gXI, <font class="comment">// X</font> +00106 gPSI, <font class="comment">// Y</font> +00107 gZETA, <font class="comment">// Z</font> +00108 gROUGH_ALPHA = 161, <font class="comment">// hA</font> +00109 gROUGH_EPSILON = 152, <font class="comment">// hE</font> +00110 gROUGH_ETA = 185, <font class="comment">// hH</font> +00111 gROUGH_IOTA = 131, <font class="comment">// hH</font> +00112 gROUGH_OMICRON = 208, <font class="comment">// hH</font> +00113 gROUGH_RHO = 183, <font class="comment">// hR</font> +00114 gROUGH_UPSILON = 216, <font class="comment">// hU</font> +00115 gROUGH_OMEGA = 230, <font class="comment">// hW</font> +00116 gIOTA_ALPHA = <font class="charliteral">'v'</font>, <font class="comment">// Ai</font> +00117 gIOTA_ETA = <font class="charliteral">'V'</font>, <font class="comment">// Ei</font> +00118 gIOTA_OMEGA = <font class="charliteral">'J'</font>, <font class="comment">// Wi</font> +00119 gNON_ROUGH_ALPHA = 162, <font class="comment">// hA</font> +00120 gNON_ROUGH_EPSILON = 153, <font class="comment">// hE</font> +00121 gNON_ROUGH_ETA = 186, <font class="comment">// hH</font> +00122 gNON_ROUGH_IOTA = 132, <font class="comment">// hH</font> +00123 gNON_ROUGH_OMICRON = 209, <font class="comment">// hH</font> +00124 gNON_ROUGH_RHO = 184, <font class="comment">// hR</font> +00125 gNON_ROUGH_UPSILON = 217, <font class="comment">// hU</font> +00126 gNON_ROUGH_OMEGA = 231 <font class="comment">// hW</font> +00127 }; +00128 +00129 <font class="comment">// English puntuation as used on bGreek</font> +00130 +00131 <font class="keyword">enum</font> bGreekPunct +00132 { +00133 COMMA = <font class="charliteral">','</font>, +00134 STOP = <font class="charliteral">'.'</font>, +00135 SEMI_COLON = <font class="charliteral">';'</font>, +00136 QUESTION = <font class="charliteral">'?'</font> +00137 }; +00138 +00139 <font class="comment">// English puntuation as used in the Greek font</font> +00140 +00141 <font class="keyword">enum</font> GreekPunct +00142 { +00143 gCOMMA = <font class="charliteral">','</font>, +00144 gSTOP = <font class="charliteral">'.'</font>, +00145 gSEMI_COLON = <font class="charliteral">':'</font>, +00146 gQUESTION = <font class="charliteral">';'</font> +00147 }; +00148 +00149 <font class="preprocessor">#endif // __GREEKCHARS_H</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/annotated.html b/doc/api-documentation/html/annotated.html new file mode 100644 index 0000000..0520cac --- /dev/null +++ b/doc/api-documentation/html/annotated.html @@ -0,0 +1,74 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Annotated Index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>The Sword Project Compound List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<ul> +<li><a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a> (This class is like a normal <a class="el" href="class_s_w_mgr.html">SWMgr</a>, but you can additonally specify which encoding you want to use) +<li><a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a> (This Filter shows/hides footnotes in a GBF text) +<li><a class="el" href="class_g_b_f_headings.html">GBFHeadings</a> (This Filter shows/hides headings in a GBF text) +<li><a class="el" href="class_g_b_f_h_t_m_l.html">GBFHTML</a> (This filter converts GBF Text into HTML) +<li><a class="el" href="class_g_b_f_h_t_m_l_h_r_e_f.html">GBFHTMLHREF</a> (This filter converts GBF text to HTML text with hrefs) +<li><a class="el" href="class_g_b_f_morph.html">GBFMorph</a> (This Filter shows/hides morph tags in a GBF text) +<li><a class="el" href="class_g_b_f_plain.html">GBFPlain</a> (This filter converts GBF text into plain text) +<li><a class="el" href="class_g_b_f_r_t_f.html">GBFRTF</a> (This filter converts GBF text into RTF text) +<li><a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a> (This Filter shows/hides strong's numbers in a GBF text) +<li><a class="el" href="class_g_b_f_th_m_l.html">GBFThML</a> (This filter converts GBF text into ThML text) +<li><a class="el" href="class_hebrew_m_c_i_m.html">HebrewMCIM</a> (Title: Keyboard mapping for Michigan-Claremont Hebrew input Description: Copyright: Copyright (c) 2001 CrossWire Bible Society under the terms of the GNU GPL Company:) +<li><a class="el" href="class_latin1_u_t_f16.html">Latin1UTF16</a> (This filter converts Latin-1 encoded text to UTF-8) +<li><a class="el" href="class_latin1_u_t_f8.html">Latin1UTF8</a> (This filter converts Latin-1 encoded text to UTF-8) +<li><a class="el" href="class_list_key.html">ListKey</a> (ListKey is the basis for all types of keys that have lists of specified indexes (e.g) +<li><a class="el" href="class_locale_mgr.html">LocaleMgr</a> (Handles all the different locales of Sword) +<li><a class="el" href="class_markup_filter_mgr.html">MarkupFilterMgr</a> (This class is like a normal SWEncodingMgr, but you can additonally specify which markup you want to use) +<li><a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a> (Shows or hides footnotes in plain text) +<li><a class="el" href="class_p_l_a_i_n_h_t_m_l.html">PLAINHTML</a> (This filter converts plain text to HTML text) +<li><a class="el" href="class_r_t_f_h_t_m_l.html">RTFHTML</a> (This filter converts RTF text into HTML text) +<li><a class="el" href="class_r_w_p_h_t_m_l.html">RWPHTML</a> (This filter converts RWP text to HTML text) +<li><a class="el" href="class_r_w_p_r_t_f.html">RWPRTF</a> (This filter converts RWP text to RTF text) +<li><a class="el" href="class_s_c_s_u_u_t_f8.html">SCSUUTF8</a> (This filter converts SCSU compressed (encoded) text to UTF-8) +<li><a class="el" href="class_str_key.html">StrKey</a> (A standard string key class (used for modules that index on single strings (eg) +<li><a class="el" href="class_s_w_class.html">SWClass</a> (Class used for SWDYNAMIC_CAST to save the inheritance order) +<li><a class="el" href="class_s_w_com.html">SWCom</a> (The basis for all commentary modules) +<li><a class="el" href="class_s_w_config.html">SWConfig</a> (The class to read and save settings using a file on disk) +<li><a class="el" href="class_s_w_display.html">SWDisplay</a> (Swdisp is the basis for all types of displays (e.g) +<li><a class="el" href="class_s_w_input_method.html">SWInputMethod</a> (Title: Description: Copyright: Copyright (c) 2001 CrossWire Bible Society under the terms of the GNU GPL Company:) +<li><a class="el" href="class_s_w_key.html">SWKey</a> (SWKey is the basis for all types of keys for indexing into modules (e.g) +<li><a class="el" href="class_s_w_l_d.html">SWLD</a> (The basis for all types of Lexicon and Dictionary modules (hence the 'LD')) +<li><a class="el" href="class_s_w_locale.html">SWLocale</a> (SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language) +<li><a class="el" href="class_s_w_mgr.html">SWMgr</a> (SWMgr is the main class of the Sword library) +<li><a class="el" href="class_s_w_module.html">SWModule</a> (The class SWModule is the base class for all modules used in Sword) +<li><a class="el" href="class_s_w_object.html">SWObject</a> (Base class for major Sword classes) +<li><a class="el" href="class_s_w_text.html">SWText</a> (The basis for all text modules) +<li><a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a> (This Filter shows/hides footnotes in a ThML text) +<li><a class="el" href="class_th_m_l_g_b_f.html">ThMLGBF</a> (This filter converts ThML text to GBF text) +<li><a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a> (This Filter shows/hides headings in a ThML text) +<li><a class="el" href="class_th_m_l_h_t_m_l.html">ThMLHTML</a> (This filter converts ThML text to HTML text) +<li><a class="el" href="class_th_m_l_h_t_m_l_h_r_e_f.html">ThMLHTMLHREF</a> (This filter converts ThML text to HTML text with hrefs) +<li><a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a> (This Filter shows/hides lemmas in a ThML text) +<li><a class="el" href="class_th_m_l_morph.html">ThMLMorph</a> (This Filter shows/hides morph tags in a ThML text) +<li><a class="el" href="class_th_m_l_o_l_b.html">ThMLOLB</a> (This filter converts ThML text to OLB text) +<li><a class="el" href="class_th_m_l_plain.html">ThMLPlain</a> (This filter converts ThML text to plain text) +<li><a class="el" href="class_th_m_l_r_t_f.html">ThMLRTF</a> (This filter converts ThML text to RTF text) +<li><a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a> (This Filter shows/hides scripture references in a ThML text) +<li><a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a> (This Filter shows/hides strong's numbers in a ThML text) +<li><a class="el" href="class_th_m_l_variants.html">ThMLVariants</a> (This Filter shows/hides textual variants) +<li><a class="el" href="class_unicode_r_t_f.html">UnicodeRTF</a> (This filter converts UTF-8 text into RTF Unicode tags) +<li><a class="el" href="class_u_t_f16_u_t_f8.html">UTF16UTF8</a> (This filter converts UTF-16 encoded text to UTF-8) +<li><a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a> (This Filter shows/hides Hebrew cantillation marks in UTF8 text) +<li><a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a> (This Filter shows/hides Greek Accents marks in UTF8 text) +<li><a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a> (This Filter shows/hides Hebrew vowel points in UTF8 text) +<li><a class="el" href="class_u_t_f8_h_t_m_l.html">UTF8HTML</a> (This filter converts UTF-8 text into HTML escape sequences) +<li><a class="el" href="class_u_t_f8_latin1.html">UTF8Latin1</a> (This filter converts UTF-8 encoded text to Latin-1) +<li><a class="el" href="class_u_t_f8_u_t_f16.html">UTF8UTF16</a> (This filter converts UTF-8 encoded text to UTF-16) +<li><a class="el" href="class_verse_key.html">VerseKey</a> (Class VerseKey The <a class="el" href="class_s_w_key.html">SWKey</a> implementation used for verse based modules like Bibles or commentaries) +</ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/cipherfil.h-source.html b/doc/api-documentation/html/cipherfil.h-source.html new file mode 100644 index 0000000..b2f9b26 --- /dev/null +++ b/doc/api-documentation/html/cipherfil.h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>cipherfil.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:24 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>cipherfil.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * $Id: cipherfil.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef CIPHERFIL_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define CIPHERFIL_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 <font class="preprocessor">#include <swcipher.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT CipherFilter:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00030 { +00031 SWCipher *cipher; +00032 <font class="keyword">public</font>: +00033 CipherFilter (<font class="keyword">const</font> <font class="keywordtype">char</font> *key); +00034 <font class="keyword">virtual</font> ~ CipherFilter (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00036 <font class="keyword">virtual</font> SWCipher *getCipher (); +00037 }; +00038 +00039 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:24 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/cipherfil_8h-source.html b/doc/api-documentation/html/cipherfil_8h-source.html new file mode 100644 index 0000000..27e0d01 --- /dev/null +++ b/doc/api-documentation/html/cipherfil_8h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>cipherfil.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>cipherfil.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: cipherfil_8h-source.html,v 1.4 2002/01/22 14:20:26 jansorg Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef CIPHERFIL_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define CIPHERFIL_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 <font class="preprocessor">#include <swcipher.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT CipherFilter:<font class="keyword">public</font> SWFilter +00030 { +00031 SWCipher *cipher; +00032 <font class="keyword">public</font>: +00033 CipherFilter (<font class="keyword">const</font> <font class="keywordtype">char</font> *key); +00034 <font class="keyword">virtual</font> ~ CipherFilter (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00036 <font class="keyword">virtual</font> SWCipher *getCipher (); +00037 }; +00038 +00039 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/cipherfil_h-source.html b/doc/api-documentation/html/cipherfil_h-source.html new file mode 100644 index 0000000..79ff5f8 --- /dev/null +++ b/doc/api-documentation/html/cipherfil_h-source.html @@ -0,0 +1,55 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>cipherfil.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>cipherfil.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: cipherfil_h-source.html,v 1.4 2001/10/05 20:45:20 mgruner Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef CIPHERFIL_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define CIPHERFIL_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 <font class="preprocessor">#include <swcipher.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT CipherFilter:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00030 { +00031 SWCipher *cipher; +00032 <font class="keyword">public</font>: +00033 CipherFilter (<font class="keyword">const</font> <font class="keywordtype">char</font> *key); +00034 <font class="keyword">virtual</font> ~ CipherFilter (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00036 <font class="keyword">virtual</font> SWCipher *getCipher (); +00037 }; +00038 +00039 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_encoding_filter_mgr-members.html b/doc/api-documentation/html/class_encoding_filter_mgr-members.html new file mode 100644 index 0000000..8327c94 --- /dev/null +++ b/doc/api-documentation/html/class_encoding_filter_mgr-members.html @@ -0,0 +1,22 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>EncodingFilterMgr Member List</h1>This is the complete list of members for <a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a>, including all inherited members.<ul> +<li><a class="el" href="class_encoding_filter_mgr.html#a4">AddEncodingFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [virtual]</code><li><b>AddGlobalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><b>AddLocalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><a class="el" href="class_encoding_filter_mgr.html#a3">AddRawFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [virtual]</code><li><b>AddRenderFilters</b>(SWModule *module, ConfigEntMap &section) (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><b>AddStripFilters</b>(SWModule *module, ConfigEntMap &section) (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><b>encoding</b> (defined in <a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a>)<code> [protected]</code><li><a class="el" href="class_encoding_filter_mgr.html#a2">Encoding</a>(char enc) +<li><a class="el" href="class_encoding_filter_mgr.html#a0">EncodingFilterMgr</a>(char encoding=ENC_UTF8) +<li><b>getParentMgr</b>() (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><b>latin1utf8</b> (defined in <a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a>)<code> [protected]</code><li><b>scsuutf8</b> (defined in <a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a>)<code> [protected]</code><li><b>setParentMgr</b>(SWMgr *parentMgr) (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><b>SWFilterMgr</b>() (defined in <b>SWFilterMgr</b>)<li><b>targetenc</b> (defined in <a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a>)<code> [protected]</code><li><a class="el" href="class_encoding_filter_mgr.html#a1">~EncodingFilterMgr</a>() +<li><b>~SWFilterMgr</b>() (defined in <b>SWFilterMgr</b>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_encoding_filter_mgr.gif b/doc/api-documentation/html/class_encoding_filter_mgr.gif Binary files differnew file mode 100644 index 0000000..483a30b --- /dev/null +++ b/doc/api-documentation/html/class_encoding_filter_mgr.gif diff --git a/doc/api-documentation/html/class_encoding_filter_mgr.html b/doc/api-documentation/html/class_encoding_filter_mgr.html new file mode 100644 index 0000000..de11149 --- /dev/null +++ b/doc/api-documentation/html/class_encoding_filter_mgr.html @@ -0,0 +1,258 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>EncodingFilterMgr class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>EncodingFilterMgr Class Reference</h1>This class is like a normal <a class="el" href="class_s_w_mgr.html">SWMgr</a>, but you can additonally specify which encoding you want to use. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="encfiltmgr_8h-source.html">encfiltmgr.h</a>></code> +<p> +<p>Inheritance diagram for EncodingFilterMgr:: +<p><center><img src="class_encoding_filter_mgr.gif" usemap="#EncodingFilterMgr_map" border="0"></center> +<map name="EncodingFilterMgr_map"> +<area href="class_markup_filter_mgr.html" alt="MarkupFilterMgr" shape="rect" coords="0,56,117,80"> +</map> +<a href="class_encoding_filter_mgr-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_encoding_filter_mgr.html#a0">EncodingFilterMgr</a> (char encoding=ENC_UTF8)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor of SWEncodingMgr.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="EncodingFilterMgr::~EncodingFilterMgr"></a> + </td><td valign=bottom><a class="el" href="class_encoding_filter_mgr.html#a1">~EncodingFilterMgr</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>The destructor of SWEncodingMgr.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="class_encoding_filter_mgr.html#a2">Encoding</a> (char enc)</td></tr> +<tr><td> </td><td><font size=-1><em>Markup sets/gets the encoding after initialization.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_encoding_filter_mgr.html#a3">AddRawFilters</a> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the raw filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module".</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_encoding_filter_mgr.html#a4">AddEncodingFilters</a> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the encoding filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module".</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="EncodingFilterMgr::latin1utf8"></a> +SWFilter * </td><td valign=bottom><b>latin1utf8</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="EncodingFilterMgr::scsuutf8"></a> +SWFilter * </td><td valign=bottom><b>scsuutf8</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="EncodingFilterMgr::targetenc"></a> +SWFilter * </td><td valign=bottom><b>targetenc</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n3" doxytag="EncodingFilterMgr::encoding"></a> +char </td><td valign=bottom><b>encoding</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class is like a normal <a class="el" href="class_s_w_mgr.html">SWMgr</a>, but you can additonally specify which encoding you want to use. +<p> + +<p> +Definition at line <a class="el" href="encfiltmgr_8h-source.html#l00033">33</a> of file <a class="el" href="encfiltmgr_8h-source.html">encfiltmgr.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="EncodingFilterMgr::EncodingFilterMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +EncodingFilterMgr::EncodingFilterMgr + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>encoding</em> = ENC_UTF8 </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor of SWEncodingMgr. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iconfig +</em> </td><td> +</td></tr> +<tr><td valign=top><em>isysconfig +</em> </td><td> +</td></tr> +<tr><td valign=top><em>autoload +</em> </td><td> +If this bool is true the constructor starts loading the installed modules. If you reimplemented <a class="el" href="class_s_w_mgr.html">SWMgr</a> you can set autoload=false to load the modules with your own reimplemented function. </td></tr> +<tr><td valign=top><em>encoding +</em> </td><td> +The desired encoding. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="EncodingFilterMgr::AddEncodingFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void EncodingFilterMgr::AddEncodingFilters + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> * </td> + <td class="mdname"> <em>module</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">ConfigEntMap & </td> + <td class="mdname"> <em>section</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the encoding filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module +</em> </td><td> +To this module the encoding filter(s) are added </td></tr> +<tr><td valign=top><em>section +</em> </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a3" doxytag="EncodingFilterMgr::AddRawFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void EncodingFilterMgr::AddRawFilters + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> * </td> + <td class="mdname"> <em>module</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">ConfigEntMap & </td> + <td class="mdname"> <em>section</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the raw filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module +</em> </td><td> +To this module the raw filter(s) are added </td></tr> +<tr><td valign=top><em>section +</em> </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a2" doxytag="EncodingFilterMgr::Encoding"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +char EncodingFilterMgr::Encoding + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>enc</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Markup sets/gets the encoding after initialization. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>m +</em> </td><td> +The new encoding or ENC_UNKNOWN if you just want to get the current markup. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +The current (possibly changed) encoding format. </dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="encfiltmgr_8h-source.html">encfiltmgr.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_footnotes-members.html b/doc/api-documentation/html/class_g_b_f_footnotes-members.html new file mode 100644 index 0000000..e7ad21e --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_footnotes-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFFootnotes Member List</h1>This is the complete list of members for <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>, including all inherited members.<ul> +<li><b>GBFFootnotes</b>() (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<li><b>getOptionName</b>() (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [virtual]</code><li><b>~GBFFootnotes</b>() (defined in <a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_footnotes.gif b/doc/api-documentation/html/class_g_b_f_footnotes.gif Binary files differnew file mode 100644 index 0000000..b196f70 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_footnotes.gif diff --git a/doc/api-documentation/html/class_g_b_f_footnotes.html b/doc/api-documentation/html/class_g_b_f_footnotes.html new file mode 100644 index 0000000..d5025a8 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_footnotes.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFFootnotes class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFFootnotes Class Reference</h1>This Filter shows/hides footnotes in a GBF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbffootnotes_8h-source.html">gbffootnotes.h</a>></code> +<p> +<a href="class_g_b_f_footnotes-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFFootnotes::GBFFootnotes"></a> + </td><td valign=bottom><b>GBFFootnotes</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFFootnotes::~GBFFootnotes"></a> +virtual </td><td valign=bottom><b>~GBFFootnotes</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="GBFFootnotes::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="GBFFootnotes::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="GBFFootnotes::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="GBFFootnotes::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="GBFFootnotes::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="GBFFootnotes::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="GBFFootnotes::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="GBFFootnotes::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="GBFFootnotes::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="GBFFootnotes::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="GBFFootnotes::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="GBFFootnotes::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides footnotes in a GBF text. +<p> + +<p> +Definition at line <a class="el" href="gbffootnotes_8h-source.html#l00030">30</a> of file <a class="el" href="gbffootnotes_8h-source.html">gbffootnotes.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbffootnotes_8h-source.html">gbffootnotes.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_h_t_m_l-members.html b/doc/api-documentation/html/class_g_b_f_h_t_m_l-members.html new file mode 100644 index 0000000..2181d53 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_h_t_m_l-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHTML Member List</h1>This is the complete list of members for <a class="el" href="class_g_b_f_h_t_m_l.html">GBFHTML</a>, including all inherited members.<ul> +<li><b>GBFHTML</b>() (defined in <a class="el" href="class_g_b_f_h_t_m_l.html">GBFHTML</a>)<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_g_b_f_h_t_m_l.html">GBFHTML</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_h_t_m_l.gif b/doc/api-documentation/html/class_g_b_f_h_t_m_l.gif Binary files differnew file mode 100644 index 0000000..0d5ab1b --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_h_t_m_l.gif diff --git a/doc/api-documentation/html/class_g_b_f_h_t_m_l.html b/doc/api-documentation/html/class_g_b_f_h_t_m_l.html new file mode 100644 index 0000000..6b54a3e --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_h_t_m_l.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFHTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHTML Class Reference</h1>This filter converts GBF Text into HTML. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfhtml_8h-source.html">gbfhtml.h</a>></code> +<p> +<a href="class_g_b_f_h_t_m_l-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFHTML::GBFHTML"></a> + </td><td valign=bottom><b>GBFHTML</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFHTML::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts GBF Text into HTML. +<p> + +<p> +Definition at line <a class="el" href="gbfhtml_8h-source.html#l00031">31</a> of file <a class="el" href="gbfhtml_8h-source.html">gbfhtml.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfhtml_8h-source.html">gbfhtml.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_h_t_m_l_h_r_e_f-members.html b/doc/api-documentation/html/class_g_b_f_h_t_m_l_h_r_e_f-members.html new file mode 100644 index 0000000..d630bc9 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_h_t_m_l_h_r_e_f-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHTMLHREF Member List</h1>This is the complete list of members for <a class="el" href="class_g_b_f_h_t_m_l_h_r_e_f.html">GBFHTMLHREF</a>, including all inherited members.<ul> +<li><b>addEscapeStringSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>addTokenSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>DualStringMap</b> typedef (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>escSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>GBFHTMLHREF</b>() (defined in <a class="el" href="class_g_b_f_h_t_m_l_h_r_e_f.html">GBFHTMLHREF</a>)<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>handleEscapeString</b>(char **buf, const char *escString, DualStringMap &userData) (defined in <b>SWBasicFilter</b>)<code> [protected, virtual]</code><li><b>handleToken</b>(char **buf, const char *token, DualStringMap &userData) (defined in <a class="el" href="class_g_b_f_h_t_m_l_h_r_e_f.html">GBFHTMLHREF</a>)<code> [protected, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *, const SWModule *=0) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>pushString</b>(char **buf, const char *format,...) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeEnd</b>(const char *escEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStart</b>(const char *escStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStringCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setPassThruUnknownEscapeString</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setPassThruUnknownToken</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenEnd</b>(const char *tokenEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenStart</b>(const char *tokenStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteEscapeString</b>(char **buf, const char *escString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteToken</b>(char **buf, const char *token) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<li><b>tokenSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>~SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_h_t_m_l_h_r_e_f.html b/doc/api-documentation/html/class_g_b_f_h_t_m_l_h_r_e_f.html new file mode 100644 index 0000000..845cf3c --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_h_t_m_l_h_r_e_f.html @@ -0,0 +1,35 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFHTMLHREF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHTMLHREF Class Reference</h1>this filter converts GBF text to HTML text with hrefs. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfhtmlhref_8h-source.html">gbfhtmlhref.h</a>></code> +<p> +<a href="class_g_b_f_h_t_m_l_h_r_e_f-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFHTMLHREF::GBFHTMLHREF"></a> + </td><td valign=bottom><b>GBFHTMLHREF</b> ()</td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="GBFHTMLHREF::handleToken"></a> +virtual bool </td><td valign=bottom><b>handleToken</b> (char **buf, const char *token, DualStringMap &userData)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts GBF text to HTML text with hrefs. +<p> + +<p> +Definition at line <a class="el" href="gbfhtmlhref_8h-source.html#l00026">26</a> of file <a class="el" href="gbfhtmlhref_8h-source.html">gbfhtmlhref.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfhtmlhref_8h-source.html">gbfhtmlhref.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_headings-members.html b/doc/api-documentation/html/class_g_b_f_headings-members.html new file mode 100644 index 0000000..42e53da --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_headings-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHeadings Member List</h1>This is the complete list of members for <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>, including all inherited members.<ul> +<li><b>GBFHeadings</b>() (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<li><b>getOptionName</b>() (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [virtual]</code><li><b>~GBFHeadings</b>() (defined in <a class="el" href="class_g_b_f_headings.html">GBFHeadings</a>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_headings.gif b/doc/api-documentation/html/class_g_b_f_headings.gif Binary files differnew file mode 100644 index 0000000..c0448db --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_headings.gif diff --git a/doc/api-documentation/html/class_g_b_f_headings.html b/doc/api-documentation/html/class_g_b_f_headings.html new file mode 100644 index 0000000..f52d5d1 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_headings.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFHeadings class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHeadings Class Reference</h1>This Filter shows/hides headings in a GBF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfheadings_8h-source.html">gbfheadings.h</a>></code> +<p> +<a href="class_g_b_f_headings-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFHeadings::GBFHeadings"></a> + </td><td valign=bottom><b>GBFHeadings</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFHeadings::~GBFHeadings"></a> +virtual </td><td valign=bottom><b>~GBFHeadings</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="GBFHeadings::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="GBFHeadings::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="GBFHeadings::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="GBFHeadings::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="GBFHeadings::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="GBFHeadings::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="GBFHeadings::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="GBFHeadings::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="GBFHeadings::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="GBFHeadings::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="GBFHeadings::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="GBFHeadings::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides headings in a GBF text. +<p> + +<p> +Definition at line <a class="el" href="gbfheadings_8h-source.html#l00030">30</a> of file <a class="el" href="gbfheadings_8h-source.html">gbfheadings.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfheadings_8h-source.html">gbfheadings.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_morph-members.html b/doc/api-documentation/html/class_g_b_f_morph-members.html new file mode 100644 index 0000000..c1578d4 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_morph-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFMorph Member List</h1>This is the complete list of members for <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>, including all inherited members.<ul> +<li><b>GBFMorph</b>() (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<li><b>getOptionName</b>() (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [virtual]</code><li><b>~GBFMorph</b>() (defined in <a class="el" href="class_g_b_f_morph.html">GBFMorph</a>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_morph.gif b/doc/api-documentation/html/class_g_b_f_morph.gif Binary files differnew file mode 100644 index 0000000..7604852 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_morph.gif diff --git a/doc/api-documentation/html/class_g_b_f_morph.html b/doc/api-documentation/html/class_g_b_f_morph.html new file mode 100644 index 0000000..cd2f6d8 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_morph.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFMorph class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFMorph Class Reference</h1>This Filter shows/hides morph tags in a GBF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfmorph_8h-source.html">gbfmorph.h</a>></code> +<p> +<a href="class_g_b_f_morph-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFMorph::GBFMorph"></a> + </td><td valign=bottom><b>GBFMorph</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFMorph::~GBFMorph"></a> +virtual </td><td valign=bottom><b>~GBFMorph</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="GBFMorph::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="GBFMorph::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="GBFMorph::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="GBFMorph::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="GBFMorph::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="GBFMorph::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="GBFMorph::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="GBFMorph::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="GBFMorph::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="GBFMorph::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="GBFMorph::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="GBFMorph::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides morph tags in a GBF text. +<p> + +<p> +Definition at line <a class="el" href="gbfmorph_8h-source.html#l00029">29</a> of file <a class="el" href="gbfmorph_8h-source.html">gbfmorph.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfmorph_8h-source.html">gbfmorph.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_plain-members.html b/doc/api-documentation/html/class_g_b_f_plain-members.html new file mode 100644 index 0000000..8bc2020 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_plain-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFPlain Member List</h1>This is the complete list of members for <a class="el" href="class_g_b_f_plain.html">GBFPlain</a>, including all inherited members.<ul> +<li><b>GBFPlain</b>() (defined in <a class="el" href="class_g_b_f_plain.html">GBFPlain</a>)<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_g_b_f_plain.html">GBFPlain</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_plain.gif b/doc/api-documentation/html/class_g_b_f_plain.gif Binary files differnew file mode 100644 index 0000000..08cc058 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_plain.gif diff --git a/doc/api-documentation/html/class_g_b_f_plain.html b/doc/api-documentation/html/class_g_b_f_plain.html new file mode 100644 index 0000000..718701a --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_plain.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFPlain class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFPlain Class Reference</h1>This filter converts GBF text into plain text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfplain_8h-source.html">gbfplain.h</a>></code> +<p> +<a href="class_g_b_f_plain-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFPlain::GBFPlain"></a> + </td><td valign=bottom><b>GBFPlain</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFPlain::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts GBF text into plain text. +<p> + +<p> +Definition at line <a class="el" href="gbfplain_8h-source.html#l00030">30</a> of file <a class="el" href="gbfplain_8h-source.html">gbfplain.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfplain_8h-source.html">gbfplain.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_r_t_f-members.html b/doc/api-documentation/html/class_g_b_f_r_t_f-members.html new file mode 100644 index 0000000..fca1359 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_r_t_f-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFRTF Member List</h1>This is the complete list of members for <a class="el" href="class_g_b_f_r_t_f.html">GBFRTF</a>, including all inherited members.<ul> +<li><b>GBFRTF</b>() (defined in <a class="el" href="class_g_b_f_r_t_f.html">GBFRTF</a>)<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_g_b_f_r_t_f.html">GBFRTF</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_r_t_f.gif b/doc/api-documentation/html/class_g_b_f_r_t_f.gif Binary files differnew file mode 100644 index 0000000..5cceaee --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_r_t_f.gif diff --git a/doc/api-documentation/html/class_g_b_f_r_t_f.html b/doc/api-documentation/html/class_g_b_f_r_t_f.html new file mode 100644 index 0000000..73c8bc0 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_r_t_f.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFRTF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFRTF Class Reference</h1>This filter converts GBF text into RTF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfrtf_8h-source.html">gbfrtf.h</a>></code> +<p> +<a href="class_g_b_f_r_t_f-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFRTF::GBFRTF"></a> + </td><td valign=bottom><b>GBFRTF</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFRTF::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts GBF text into RTF text. +<p> + +<p> +Definition at line <a class="el" href="gbfrtf_8h-source.html#l00030">30</a> of file <a class="el" href="gbfrtf_8h-source.html">gbfrtf.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfrtf_8h-source.html">gbfrtf.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_strongs-members.html b/doc/api-documentation/html/class_g_b_f_strongs-members.html new file mode 100644 index 0000000..b527821 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_strongs-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFStrongs Member List</h1>This is the complete list of members for <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>, including all inherited members.<ul> +<li><b>GBFStrongs</b>() (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<li><b>getOptionName</b>() (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [virtual]</code><li><b>~GBFStrongs</b>() (defined in <a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_strongs.gif b/doc/api-documentation/html/class_g_b_f_strongs.gif Binary files differnew file mode 100644 index 0000000..6804f92 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_strongs.gif diff --git a/doc/api-documentation/html/class_g_b_f_strongs.html b/doc/api-documentation/html/class_g_b_f_strongs.html new file mode 100644 index 0000000..85d5aa2 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_strongs.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFStrongs class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFStrongs Class Reference</h1>This Filter shows/hides strong's numbers in a GBF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfstrongs_8h-source.html">gbfstrongs.h</a>></code> +<p> +<a href="class_g_b_f_strongs-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFStrongs::GBFStrongs"></a> + </td><td valign=bottom><b>GBFStrongs</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFStrongs::~GBFStrongs"></a> +virtual </td><td valign=bottom><b>~GBFStrongs</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="GBFStrongs::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="GBFStrongs::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="GBFStrongs::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="GBFStrongs::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="GBFStrongs::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="GBFStrongs::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="GBFStrongs::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="GBFStrongs::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="GBFStrongs::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="GBFStrongs::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="GBFStrongs::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="GBFStrongs::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides strong's numbers in a GBF text. +<p> + +<p> +Definition at line <a class="el" href="gbfstrongs_8h-source.html#l00030">30</a> of file <a class="el" href="gbfstrongs_8h-source.html">gbfstrongs.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfstrongs_8h-source.html">gbfstrongs.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_th_m_l-members.html b/doc/api-documentation/html/class_g_b_f_th_m_l-members.html new file mode 100644 index 0000000..91518a5 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_th_m_l-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFThML Member List</h1>This is the complete list of members for <a class="el" href="class_g_b_f_th_m_l.html">GBFThML</a>, including all inherited members.<ul> +<li><b>GBFThML</b>() (defined in <a class="el" href="class_g_b_f_th_m_l.html">GBFThML</a>)<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <a class="el" href="class_g_b_f_th_m_l.html">GBFThML</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *, const SWModule *=0) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_g_b_f_th_m_l.gif b/doc/api-documentation/html/class_g_b_f_th_m_l.gif Binary files differnew file mode 100644 index 0000000..6e8b6e3 --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_th_m_l.gif diff --git a/doc/api-documentation/html/class_g_b_f_th_m_l.html b/doc/api-documentation/html/class_g_b_f_th_m_l.html new file mode 100644 index 0000000..077a88f --- /dev/null +++ b/doc/api-documentation/html/class_g_b_f_th_m_l.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFThML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFThML Class Reference</h1>this filter converts GBF text into ThML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfthml_8h-source.html">gbfthml.h</a>></code> +<p> +<a href="class_g_b_f_th_m_l-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFThML::GBFThML"></a> + </td><td valign=bottom><b>GBFThML</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFThML::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen=-1)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts GBF text into ThML text. +<p> + +<p> +Definition at line <a class="el" href="gbfthml_8h-source.html#l00027">27</a> of file <a class="el" href="gbfthml_8h-source.html">gbfthml.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfthml_8h-source.html">gbfthml.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbffootnotes-members.html b/doc/api-documentation/html/class_gbffootnotes-members.html new file mode 100644 index 0000000..029f1ac --- /dev/null +++ b/doc/api-documentation/html/class_gbffootnotes-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFFootnotes Member List</h1>This is the complete list of members for <a class="el" href="class_gbffootnotes.html">GBFFootnotes</a>, including all inherited members.<ul> +<li><b>GBFFootnotes</b>() (defined in <a class="el" href="class_gbffootnotes.html">GBFFootnotes</a>)<li><a class="el" href="class_gbffootnotes.html#a3">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_gbffootnotes.html#a4">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_gbffootnotes.html">GBFFootnotes</a>)<code> [virtual]</code><li><a class="el" href="class_gbffootnotes.html#a7">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_gbffootnotes.html">GBFFootnotes</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_gbffootnotes.html">GBFFootnotes</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_gbffootnotes.html">GBFFootnotes</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_gbffootnotes.html">GBFFootnotes</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_gbffootnotes.html">GBFFootnotes</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_gbffootnotes.html">GBFFootnotes</a>)<code> [private, static]</code><li><a class="el" href="class_gbffootnotes.html#a2">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_gbffootnotes.html#a5">setOptionValue</a>(const char *ival) +<code> [virtual]</code><li><b>~GBFFootnotes</b>() (defined in <a class="el" href="class_gbffootnotes.html">GBFFootnotes</a>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbffootnotes.gif b/doc/api-documentation/html/class_gbffootnotes.gif Binary files differnew file mode 100644 index 0000000..b196f70 --- /dev/null +++ b/doc/api-documentation/html/class_gbffootnotes.gif diff --git a/doc/api-documentation/html/class_gbffootnotes.html b/doc/api-documentation/html/class_gbffootnotes.html new file mode 100644 index 0000000..7a6d654 --- /dev/null +++ b/doc/api-documentation/html/class_gbffootnotes.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFFootnotes class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFFootnotes Class Reference</h1>This Filter shows/hides footnotes in a GBF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a>></code> +<p> +<p>Inheritance diagram for GBFFootnotes:: +<p><center><img src="class_gbffootnotes.gif" usemap="#GBFFootnotes_map" border="0"></center> +<map name="GBFFootnotes_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,92,24"> +</map> +<a href="class_gbffootnotes-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFFootnotes::GBFFootnotes"></a> + </td><td valign=bottom><b>GBFFootnotes</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFFootnotes::~GBFFootnotes"></a> +virtual </td><td valign=bottom><b>~GBFFootnotes</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_gbffootnotes.html#a2">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_gbffootnotes.html#a3">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_gbffootnotes.html#a4">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_gbffootnotes.html#a5">setOptionValue</a> (const char *ival)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_gbffootnotes.html#a7">getOptionValues</a>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="GBFFootnotes::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_gbffootnotes.html#a7">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="GBFFootnotes::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="GBFFootnotes::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="GBFFootnotes::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="GBFFootnotes::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="GBFFootnotes::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="GBFFootnotes::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides footnotes in a GBF text. +<p> + +<p> +Definition at line <a class="el" href="gbffootnotes_h-source.html#l00030">30</a> of file <a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="GBFFootnotes::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char GBFFootnotes::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<a name="a3" doxytag="GBFFootnotes::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * GBFFootnotes::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a1">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbffootnotes_h-source.html#l00042">42</a> of file <a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="GBFFootnotes::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * GBFFootnotes::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a2">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbffootnotes_h-source.html#l00046">46</a> of file <a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="GBFFootnotes::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList GBFFootnotes::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a3">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbffootnotes_h-source.html#l00052">52</a> of file <a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="GBFFootnotes::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual void GBFFootnotes::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_gbffootnotes.html#a7">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a4">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbffootnotes_h-source.html">gbffootnotes.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfheadings-members.html b/doc/api-documentation/html/class_gbfheadings-members.html new file mode 100644 index 0000000..52175b2 --- /dev/null +++ b/doc/api-documentation/html/class_gbfheadings-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHeadings Member List</h1>This is the complete list of members for <a class="el" href="class_gbfheadings.html">GBFHeadings</a>, including all inherited members.<ul> +<li><b>GBFHeadings</b>() (defined in <a class="el" href="class_gbfheadings.html">GBFHeadings</a>)<li><a class="el" href="class_gbfheadings.html#a3">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_gbfheadings.html#a4">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_gbfheadings.html">GBFHeadings</a>)<code> [virtual]</code><li><a class="el" href="class_gbfheadings.html#a7">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_gbfheadings.html">GBFHeadings</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_gbfheadings.html">GBFHeadings</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_gbfheadings.html">GBFHeadings</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_gbfheadings.html">GBFHeadings</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_gbfheadings.html">GBFHeadings</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_gbfheadings.html">GBFHeadings</a>)<code> [private, static]</code><li><a class="el" href="class_gbfheadings.html#a2">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_gbfheadings.html#a5">setOptionValue</a>(const char *ival) +<code> [virtual]</code><li><b>~GBFHeadings</b>() (defined in <a class="el" href="class_gbfheadings.html">GBFHeadings</a>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfheadings.gif b/doc/api-documentation/html/class_gbfheadings.gif Binary files differnew file mode 100644 index 0000000..c0448db --- /dev/null +++ b/doc/api-documentation/html/class_gbfheadings.gif diff --git a/doc/api-documentation/html/class_gbfheadings.html b/doc/api-documentation/html/class_gbfheadings.html new file mode 100644 index 0000000..5b392e9 --- /dev/null +++ b/doc/api-documentation/html/class_gbfheadings.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFHeadings class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHeadings Class Reference</h1>This Filter shows/hides headings in a GBF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfheadings_h-source.html">gbfheadings.h</a>></code> +<p> +<p>Inheritance diagram for GBFHeadings:: +<p><center><img src="class_gbfheadings.gif" usemap="#GBFHeadings_map" border="0"></center> +<map name="GBFHeadings_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,90,24"> +</map> +<a href="class_gbfheadings-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFHeadings::GBFHeadings"></a> + </td><td valign=bottom><b>GBFHeadings</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFHeadings::~GBFHeadings"></a> +virtual </td><td valign=bottom><b>~GBFHeadings</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_gbfheadings.html#a2">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_gbfheadings.html#a3">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_gbfheadings.html#a4">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_gbfheadings.html#a5">setOptionValue</a> (const char *ival)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_gbfheadings.html#a7">getOptionValues</a>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="GBFHeadings::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_gbfheadings.html#a7">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="GBFHeadings::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="GBFHeadings::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="GBFHeadings::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="GBFHeadings::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="GBFHeadings::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="GBFHeadings::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides headings in a GBF text. +<p> + +<p> +Definition at line <a class="el" href="gbfheadings_h-source.html#l00030">30</a> of file <a class="el" href="gbfheadings_h-source.html">gbfheadings.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="GBFHeadings::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char GBFHeadings::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<a name="a3" doxytag="GBFHeadings::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * GBFHeadings::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a1">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbfheadings_h-source.html#l00042">42</a> of file <a class="el" href="gbfheadings_h-source.html">gbfheadings.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="GBFHeadings::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * GBFHeadings::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a2">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbfheadings_h-source.html#l00046">46</a> of file <a class="el" href="gbfheadings_h-source.html">gbfheadings.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="GBFHeadings::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList GBFHeadings::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a3">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbfheadings_h-source.html#l00052">52</a> of file <a class="el" href="gbfheadings_h-source.html">gbfheadings.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="GBFHeadings::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual void GBFHeadings::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_gbfheadings.html#a7">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a4">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfheadings_h-source.html">gbfheadings.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfhtml-members.html b/doc/api-documentation/html/class_gbfhtml-members.html new file mode 100644 index 0000000..341cfe9 --- /dev/null +++ b/doc/api-documentation/html/class_gbfhtml-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHTML Member List</h1>This is the complete list of members for <a class="el" href="class_gbfhtml.html">GBFHTML</a>, including all inherited members.<ul> +<li><b>GBFHTML</b>() (defined in <a class="el" href="class_gbfhtml.html">GBFHTML</a>)<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_gbfhtml.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfhtml.gif b/doc/api-documentation/html/class_gbfhtml.gif Binary files differnew file mode 100644 index 0000000..0d5ab1b --- /dev/null +++ b/doc/api-documentation/html/class_gbfhtml.gif diff --git a/doc/api-documentation/html/class_gbfhtml.html b/doc/api-documentation/html/class_gbfhtml.html new file mode 100644 index 0000000..748dc2d --- /dev/null +++ b/doc/api-documentation/html/class_gbfhtml.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFHTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHTML Class Reference</h1>This filter converts GBF Text into HTML. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfhtml_h-source.html">gbfhtml.h</a>></code> +<p> +<p>Inheritance diagram for GBFHTML:: +<p><center><img src="class_gbfhtml.gif" usemap="#GBFHTML_map" border="0"></center> +<map name="GBFHTML_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,71,24"> +</map> +<a href="class_gbfhtml-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFHTML::GBFHTML"></a> + </td><td valign=bottom><b>GBFHTML</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_gbfhtml.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts GBF Text into HTML. +<p> + +<p> +Definition at line <a class="el" href="gbfhtml_h-source.html#l00031">31</a> of file <a class="el" href="gbfhtml_h-source.html">gbfhtml.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="GBFHTML::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char GBFHTML::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfhtml_h-source.html">gbfhtml.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfhtmlhref-members.html b/doc/api-documentation/html/class_gbfhtmlhref-members.html new file mode 100644 index 0000000..d4556a8 --- /dev/null +++ b/doc/api-documentation/html/class_gbfhtmlhref-members.html @@ -0,0 +1,23 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHTMLHREF Member List</h1>This is the complete list of members for <a class="el" href="class_gbfhtmlhref.html">GBFHTMLHREF</a>, including all inherited members.<ul> +<li><b>addEscapeStringSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>addTokenSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>DualStringMap</b> typedef (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>escSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>GBFHTMLHREF</b>() (defined in <a class="el" href="class_gbfhtmlhref.html">GBFHTMLHREF</a>)<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>handleEscapeString</b>(char **buf, const char *escString, DualStringMap &userData) (defined in <b>SWBasicFilter</b>)<code> [protected, virtual]</code><li><b>handleToken</b>(char **buf, const char *token, DualStringMap &userData) (defined in <a class="el" href="class_gbfhtmlhref.html">GBFHTMLHREF</a>)<code> [protected, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a6">SWFilter::ProcessText</a>(char *text, int maxlen, const SWKey *) +<code> [inline, virtual]</code><li><b>pushString</b>(char **buf, const char *fragToPush) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeEnd</b>(const char *escEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStart</b>(const char *escStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStringCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>setPassThruUnknownEscapeString</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setPassThruUnknownToken</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenEnd</b>(const char *tokenEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenStart</b>(const char *tokenStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteEscapeString</b>(char **buf, const char *escString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteToken</b>(char **buf, const char *token) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<li><b>tokenSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>~SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfhtmlhref.html b/doc/api-documentation/html/class_gbfhtmlhref.html new file mode 100644 index 0000000..b341275 --- /dev/null +++ b/doc/api-documentation/html/class_gbfhtmlhref.html @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFHTMLHREF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFHTMLHREF Class Reference</h1>this filter converts GBF text to HTML text with hrefs. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfhtmlhref_h-source.html">gbfhtmlhref.h</a>></code> +<p> +<a href="class_gbfhtmlhref-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFHTMLHREF::GBFHTMLHREF"></a> + </td><td valign=bottom><b>GBFHTMLHREF</b> ()</td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="GBFHTMLHREF::handleToken"></a> +virtual bool </td><td valign=bottom><b>handleToken</b> (char **buf, const char *token, DualStringMap &userData)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts GBF text to HTML text with hrefs. +<p> + +<p> +Definition at line <a class="el" href="gbfhtmlhref_h-source.html#l00026">26</a> of file <a class="el" href="gbfhtmlhref_h-source.html">gbfhtmlhref.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfhtmlhref_h-source.html">gbfhtmlhref.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfmorph-members.html b/doc/api-documentation/html/class_gbfmorph-members.html new file mode 100644 index 0000000..8f2d9ad --- /dev/null +++ b/doc/api-documentation/html/class_gbfmorph-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFMorph Member List</h1>This is the complete list of members for <a class="el" href="class_gbfmorph.html">GBFMorph</a>, including all inherited members.<ul> +<li><b>GBFMorph</b>() (defined in <a class="el" href="class_gbfmorph.html">GBFMorph</a>)<li><a class="el" href="class_gbfmorph.html#a3">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_gbfmorph.html#a4">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_gbfmorph.html">GBFMorph</a>)<code> [virtual]</code><li><a class="el" href="class_gbfmorph.html#a7">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_gbfmorph.html">GBFMorph</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_gbfmorph.html">GBFMorph</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_gbfmorph.html">GBFMorph</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_gbfmorph.html">GBFMorph</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_gbfmorph.html">GBFMorph</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_gbfmorph.html">GBFMorph</a>)<code> [private, static]</code><li><a class="el" href="class_gbfmorph.html#a2">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_gbfmorph.html#a5">setOptionValue</a>(const char *ival) +<code> [virtual]</code><li><b>~GBFMorph</b>() (defined in <a class="el" href="class_gbfmorph.html">GBFMorph</a>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfmorph.gif b/doc/api-documentation/html/class_gbfmorph.gif Binary files differnew file mode 100644 index 0000000..7604852 --- /dev/null +++ b/doc/api-documentation/html/class_gbfmorph.gif diff --git a/doc/api-documentation/html/class_gbfmorph.html b/doc/api-documentation/html/class_gbfmorph.html new file mode 100644 index 0000000..c983c4e --- /dev/null +++ b/doc/api-documentation/html/class_gbfmorph.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFMorph class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFMorph Class Reference</h1>This Filter shows/hides morph tags in a GBF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a>></code> +<p> +<p>Inheritance diagram for GBFMorph:: +<p><center><img src="class_gbfmorph.gif" usemap="#GBFMorph_map" border="0"></center> +<map name="GBFMorph_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,74,24"> +</map> +<a href="class_gbfmorph-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFMorph::GBFMorph"></a> + </td><td valign=bottom><b>GBFMorph</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFMorph::~GBFMorph"></a> +virtual </td><td valign=bottom><b>~GBFMorph</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_gbfmorph.html#a2">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_gbfmorph.html#a3">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_gbfmorph.html#a4">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_gbfmorph.html#a5">setOptionValue</a> (const char *ival)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_gbfmorph.html#a7">getOptionValues</a>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="GBFMorph::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_gbfmorph.html#a7">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="GBFMorph::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="GBFMorph::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="GBFMorph::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="GBFMorph::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="GBFMorph::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="GBFMorph::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides morph tags in a GBF text. +<p> + +<p> +Definition at line <a class="el" href="gbfmorph_h-source.html#l00029">29</a> of file <a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="GBFMorph::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char GBFMorph::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<a name="a3" doxytag="GBFMorph::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * GBFMorph::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a1">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbfmorph_h-source.html#l00041">41</a> of file <a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="GBFMorph::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * GBFMorph::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a2">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbfmorph_h-source.html#l00045">45</a> of file <a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="GBFMorph::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList GBFMorph::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a3">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbfmorph_h-source.html#l00051">51</a> of file <a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="GBFMorph::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual void GBFMorph::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_gbfmorph.html#a7">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a4">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfmorph_h-source.html">gbfmorph.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfplain-members.html b/doc/api-documentation/html/class_gbfplain-members.html new file mode 100644 index 0000000..4c38ff0 --- /dev/null +++ b/doc/api-documentation/html/class_gbfplain-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFPlain Member List</h1>This is the complete list of members for <a class="el" href="class_gbfplain.html">GBFPlain</a>, including all inherited members.<ul> +<li><b>GBFPlain</b>() (defined in <a class="el" href="class_gbfplain.html">GBFPlain</a>)<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_gbfplain.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfplain.gif b/doc/api-documentation/html/class_gbfplain.gif Binary files differnew file mode 100644 index 0000000..08cc058 --- /dev/null +++ b/doc/api-documentation/html/class_gbfplain.gif diff --git a/doc/api-documentation/html/class_gbfplain.html b/doc/api-documentation/html/class_gbfplain.html new file mode 100644 index 0000000..176dfda --- /dev/null +++ b/doc/api-documentation/html/class_gbfplain.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFPlain class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFPlain Class Reference</h1>This filter converts GBF text into plain text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfplain_h-source.html">gbfplain.h</a>></code> +<p> +<p>Inheritance diagram for GBFPlain:: +<p><center><img src="class_gbfplain.gif" usemap="#GBFPlain_map" border="0"></center> +<map name="GBFPlain_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,65,24"> +</map> +<a href="class_gbfplain-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFPlain::GBFPlain"></a> + </td><td valign=bottom><b>GBFPlain</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_gbfplain.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts GBF text into plain text. +<p> + +<p> +Definition at line <a class="el" href="gbfplain_h-source.html#l00030">30</a> of file <a class="el" href="gbfplain_h-source.html">gbfplain.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="GBFPlain::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char GBFPlain::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfplain_h-source.html">gbfplain.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfrtf-members.html b/doc/api-documentation/html/class_gbfrtf-members.html new file mode 100644 index 0000000..287aa27 --- /dev/null +++ b/doc/api-documentation/html/class_gbfrtf-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFRTF Member List</h1>This is the complete list of members for <a class="el" href="class_gbfrtf.html">GBFRTF</a>, including all inherited members.<ul> +<li><b>GBFRTF</b>() (defined in <a class="el" href="class_gbfrtf.html">GBFRTF</a>)<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_gbfrtf.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfrtf.gif b/doc/api-documentation/html/class_gbfrtf.gif Binary files differnew file mode 100644 index 0000000..5cceaee --- /dev/null +++ b/doc/api-documentation/html/class_gbfrtf.gif diff --git a/doc/api-documentation/html/class_gbfrtf.html b/doc/api-documentation/html/class_gbfrtf.html new file mode 100644 index 0000000..dfe3956 --- /dev/null +++ b/doc/api-documentation/html/class_gbfrtf.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFRTF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFRTF Class Reference</h1>This filter converts GBF text into RTF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfrtf_h-source.html">gbfrtf.h</a>></code> +<p> +<p>Inheritance diagram for GBFRTF:: +<p><center><img src="class_gbfrtf.gif" usemap="#GBFRTF_map" border="0"></center> +<map name="GBFRTF_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,60,24"> +</map> +<a href="class_gbfrtf-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFRTF::GBFRTF"></a> + </td><td valign=bottom><b>GBFRTF</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_gbfrtf.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts GBF text into RTF text. +<p> + +<p> +Definition at line <a class="el" href="gbfrtf_h-source.html#l00030">30</a> of file <a class="el" href="gbfrtf_h-source.html">gbfrtf.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="GBFRTF::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char GBFRTF::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfrtf_h-source.html">gbfrtf.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfstrongs-members.html b/doc/api-documentation/html/class_gbfstrongs-members.html new file mode 100644 index 0000000..6cd72a0 --- /dev/null +++ b/doc/api-documentation/html/class_gbfstrongs-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFStrongs Member List</h1>This is the complete list of members for <a class="el" href="class_gbfstrongs.html">GBFStrongs</a>, including all inherited members.<ul> +<li><b>GBFStrongs</b>() (defined in <a class="el" href="class_gbfstrongs.html">GBFStrongs</a>)<li><a class="el" href="class_gbfstrongs.html#a3">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_gbfstrongs.html#a4">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_gbfstrongs.html">GBFStrongs</a>)<code> [virtual]</code><li><a class="el" href="class_gbfstrongs.html#a7">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_gbfstrongs.html">GBFStrongs</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_gbfstrongs.html">GBFStrongs</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_gbfstrongs.html">GBFStrongs</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_gbfstrongs.html">GBFStrongs</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_gbfstrongs.html">GBFStrongs</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_gbfstrongs.html">GBFStrongs</a>)<code> [private, static]</code><li><a class="el" href="class_gbfstrongs.html#a2">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_gbfstrongs.html#a5">setOptionValue</a>(const char *ival) +<code> [virtual]</code><li><b>~GBFStrongs</b>() (defined in <a class="el" href="class_gbfstrongs.html">GBFStrongs</a>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfstrongs.gif b/doc/api-documentation/html/class_gbfstrongs.gif Binary files differnew file mode 100644 index 0000000..6804f92 --- /dev/null +++ b/doc/api-documentation/html/class_gbfstrongs.gif diff --git a/doc/api-documentation/html/class_gbfstrongs.html b/doc/api-documentation/html/class_gbfstrongs.html new file mode 100644 index 0000000..95acb8e --- /dev/null +++ b/doc/api-documentation/html/class_gbfstrongs.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFStrongs class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFStrongs Class Reference</h1>This Filter shows/hides strong's numbers in a GBF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfstrongs_h-source.html">gbfstrongs.h</a>></code> +<p> +<p>Inheritance diagram for GBFStrongs:: +<p><center><img src="class_gbfstrongs.gif" usemap="#GBFStrongs_map" border="0"></center> +<map name="GBFStrongs_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,80,24"> +</map> +<a href="class_gbfstrongs-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFStrongs::GBFStrongs"></a> + </td><td valign=bottom><b>GBFStrongs</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="GBFStrongs::~GBFStrongs"></a> +virtual </td><td valign=bottom><b>~GBFStrongs</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_gbfstrongs.html#a2">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_gbfstrongs.html#a3">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_gbfstrongs.html#a4">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_gbfstrongs.html#a5">setOptionValue</a> (const char *ival)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_gbfstrongs.html#a7">getOptionValues</a>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="GBFStrongs::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_gbfstrongs.html#a7">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="GBFStrongs::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="GBFStrongs::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="GBFStrongs::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="GBFStrongs::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="GBFStrongs::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="GBFStrongs::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides strong's numbers in a GBF text. +<p> + +<p> +Definition at line <a class="el" href="gbfstrongs_h-source.html#l00030">30</a> of file <a class="el" href="gbfstrongs_h-source.html">gbfstrongs.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="GBFStrongs::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char GBFStrongs::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<a name="a3" doxytag="GBFStrongs::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * GBFStrongs::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a1">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbfstrongs_h-source.html#l00042">42</a> of file <a class="el" href="gbfstrongs_h-source.html">gbfstrongs.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="GBFStrongs::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * GBFStrongs::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a2">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbfstrongs_h-source.html#l00046">46</a> of file <a class="el" href="gbfstrongs_h-source.html">gbfstrongs.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="GBFStrongs::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList GBFStrongs::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a3">SWFilter</a>. +<p> +Definition at line <a class="el" href="gbfstrongs_h-source.html#l00052">52</a> of file <a class="el" href="gbfstrongs_h-source.html">gbfstrongs.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="GBFStrongs::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual void GBFStrongs::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_gbfstrongs.html#a7">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a4">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfstrongs_h-source.html">gbfstrongs.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfthml-members.html b/doc/api-documentation/html/class_gbfthml-members.html new file mode 100644 index 0000000..e6e0ed9 --- /dev/null +++ b/doc/api-documentation/html/class_gbfthml-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFThML Member List</h1>This is the complete list of members for <a class="el" href="class_gbfthml.html">GBFThML</a>, including all inherited members.<ul> +<li><b>GBFThML</b>() (defined in <a class="el" href="class_gbfthml.html">GBFThML</a>)<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_gbfthml.html#a1">ProcessText</a>(char *text, int maxlen=-1) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a6">SWFilter::ProcessText</a>(char *text, int maxlen, const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_gbfthml.gif b/doc/api-documentation/html/class_gbfthml.gif Binary files differnew file mode 100644 index 0000000..6e8b6e3 --- /dev/null +++ b/doc/api-documentation/html/class_gbfthml.gif diff --git a/doc/api-documentation/html/class_gbfthml.html b/doc/api-documentation/html/class_gbfthml.html new file mode 100644 index 0000000..17f0cfe --- /dev/null +++ b/doc/api-documentation/html/class_gbfthml.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GBFThML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GBFThML Class Reference</h1>this filter converts GBF text into ThML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="gbfthml_h-source.html">gbfthml.h</a>></code> +<p> +<p>Inheritance diagram for GBFThML:: +<p><center><img src="class_gbfthml.gif" usemap="#GBFThML_map" border="0"></center> +<map name="GBFThML_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,69,24"> +</map> +<a href="class_gbfthml-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="GBFThML::GBFThML"></a> + </td><td valign=bottom><b>GBFThML</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_gbfthml.html#a1">ProcessText</a> (char *text, int maxlen=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function without the 3rd parameter.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts GBF text into ThML text. +<p> + +<p> +Definition at line <a class="el" href="gbfthml_h-source.html#l00027">27</a> of file <a class="el" href="gbfthml_h-source.html">gbfthml.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="GBFThML::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char GBFThML::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em> = -1 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function without the 3rd parameter. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a7">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="gbfthml_h-source.html">gbfthml.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_latin1_u_t_f16-members.html b/doc/api-documentation/html/class_latin1_u_t_f16-members.html new file mode 100644 index 0000000..a449067 --- /dev/null +++ b/doc/api-documentation/html/class_latin1_u_t_f16-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Latin1UTF16 Member List</h1>This is the complete list of members for <a class="el" href="class_latin1_u_t_f16.html">Latin1UTF16</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>Latin1UTF16</b>() (defined in <a class="el" href="class_latin1_u_t_f16.html">Latin1UTF16</a>)<li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_latin1_u_t_f16.html">Latin1UTF16</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_latin1_u_t_f16.gif b/doc/api-documentation/html/class_latin1_u_t_f16.gif Binary files differnew file mode 100644 index 0000000..d32d615 --- /dev/null +++ b/doc/api-documentation/html/class_latin1_u_t_f16.gif diff --git a/doc/api-documentation/html/class_latin1_u_t_f16.html b/doc/api-documentation/html/class_latin1_u_t_f16.html new file mode 100644 index 0000000..620c2a5 --- /dev/null +++ b/doc/api-documentation/html/class_latin1_u_t_f16.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Latin1UTF16 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Latin1UTF16 Class Reference</h1>This filter converts Latin-1 encoded text to UTF-8. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="latin1utf16_8h-source.html">latin1utf16.h</a>></code> +<p> +<a href="class_latin1_u_t_f16-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="Latin1UTF16::Latin1UTF16"></a> + </td><td valign=bottom><b>Latin1UTF16</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="Latin1UTF16::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts Latin-1 encoded text to UTF-8. +<p> + +<p> +Definition at line <a class="el" href="latin1utf16_8h-source.html#l00029">29</a> of file <a class="el" href="latin1utf16_8h-source.html">latin1utf16.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="latin1utf16_8h-source.html">latin1utf16.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_latin1_u_t_f8-members.html b/doc/api-documentation/html/class_latin1_u_t_f8-members.html new file mode 100644 index 0000000..89703ae --- /dev/null +++ b/doc/api-documentation/html/class_latin1_u_t_f8-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Latin1UTF8 Member List</h1>This is the complete list of members for <a class="el" href="class_latin1_u_t_f8.html">Latin1UTF8</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>Latin1UTF8</b>() (defined in <a class="el" href="class_latin1_u_t_f8.html">Latin1UTF8</a>)<li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_latin1_u_t_f8.html">Latin1UTF8</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_latin1_u_t_f8.gif b/doc/api-documentation/html/class_latin1_u_t_f8.gif Binary files differnew file mode 100644 index 0000000..802769d --- /dev/null +++ b/doc/api-documentation/html/class_latin1_u_t_f8.gif diff --git a/doc/api-documentation/html/class_latin1_u_t_f8.html b/doc/api-documentation/html/class_latin1_u_t_f8.html new file mode 100644 index 0000000..22ed143 --- /dev/null +++ b/doc/api-documentation/html/class_latin1_u_t_f8.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Latin1UTF8 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Latin1UTF8 Class Reference</h1>This filter converts Latin-1 encoded text to UTF-8. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="latin1utf8_8h-source.html">latin1utf8.h</a>></code> +<p> +<a href="class_latin1_u_t_f8-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="Latin1UTF8::Latin1UTF8"></a> + </td><td valign=bottom><b>Latin1UTF8</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="Latin1UTF8::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts Latin-1 encoded text to UTF-8. +<p> + +<p> +Definition at line <a class="el" href="latin1utf8_8h-source.html#l00029">29</a> of file <a class="el" href="latin1utf8_8h-source.html">latin1utf8.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="latin1utf8_8h-source.html">latin1utf8.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_latin1utf16-members.html b/doc/api-documentation/html/class_latin1utf16-members.html new file mode 100644 index 0000000..f874f8b --- /dev/null +++ b/doc/api-documentation/html/class_latin1utf16-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Latin1UTF16 Member List</h1>This is the complete list of members for <a class="el" href="class_latin1utf16.html">Latin1UTF16</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>Latin1UTF16</b>() (defined in <a class="el" href="class_latin1utf16.html">Latin1UTF16</a>)<li><a class="el" href="class_latin1utf16.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_latin1utf16.gif b/doc/api-documentation/html/class_latin1utf16.gif Binary files differnew file mode 100644 index 0000000..d32d615 --- /dev/null +++ b/doc/api-documentation/html/class_latin1utf16.gif diff --git a/doc/api-documentation/html/class_latin1utf16.html b/doc/api-documentation/html/class_latin1utf16.html new file mode 100644 index 0000000..e07fa2c --- /dev/null +++ b/doc/api-documentation/html/class_latin1utf16.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Latin1UTF16 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Latin1UTF16 Class Reference</h1>This filter converts Latin-1 encoded text to UTF-8. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="latin1utf16_h-source.html">latin1utf16.h</a>></code> +<p> +<p>Inheritance diagram for Latin1UTF16:: +<p><center><img src="class_latin1utf16.gif" usemap="#Latin1UTF16_map" border="0"></center> +<map name="Latin1UTF16_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,83,24"> +</map> +<a href="class_latin1utf16-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="Latin1UTF16::Latin1UTF16"></a> + </td><td valign=bottom><b>Latin1UTF16</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_latin1utf16.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts Latin-1 encoded text to UTF-8. +<p> + +<p> +Definition at line <a class="el" href="latin1utf16_h-source.html#l00029">29</a> of file <a class="el" href="latin1utf16_h-source.html">latin1utf16.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="Latin1UTF16::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char Latin1UTF16::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="latin1utf16_h-source.html">latin1utf16.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_latin1utf8-members.html b/doc/api-documentation/html/class_latin1utf8-members.html new file mode 100644 index 0000000..3cceb59 --- /dev/null +++ b/doc/api-documentation/html/class_latin1utf8-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Latin1UTF8 Member List</h1>This is the complete list of members for <a class="el" href="class_latin1utf8.html">Latin1UTF8</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>Latin1UTF8</b>() (defined in <a class="el" href="class_latin1utf8.html">Latin1UTF8</a>)<li><a class="el" href="class_latin1utf8.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_latin1utf8.gif b/doc/api-documentation/html/class_latin1utf8.gif Binary files differnew file mode 100644 index 0000000..802769d --- /dev/null +++ b/doc/api-documentation/html/class_latin1utf8.gif diff --git a/doc/api-documentation/html/class_latin1utf8.html b/doc/api-documentation/html/class_latin1utf8.html new file mode 100644 index 0000000..0930160 --- /dev/null +++ b/doc/api-documentation/html/class_latin1utf8.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Latin1UTF8 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Latin1UTF8 Class Reference</h1>This filter converts Latin-1 encoded text to UTF-8. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="latin1utf8_h-source.html">latin1utf8.h</a>></code> +<p> +<p>Inheritance diagram for Latin1UTF8:: +<p><center><img src="class_latin1utf8.gif" usemap="#Latin1UTF8_map" border="0"></center> +<map name="Latin1UTF8_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,76,24"> +</map> +<a href="class_latin1utf8-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="Latin1UTF8::Latin1UTF8"></a> + </td><td valign=bottom><b>Latin1UTF8</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_latin1utf8.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts Latin-1 encoded text to UTF-8. +<p> + +<p> +Definition at line <a class="el" href="latin1utf8_h-source.html#l00029">29</a> of file <a class="el" href="latin1utf8_h-source.html">latin1utf8.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="Latin1UTF8::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char Latin1UTF8::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="latin1utf8_h-source.html">latin1utf8.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_list_key-members.html b/doc/api-documentation/html/class_list_key-members.html new file mode 100644 index 0000000..8095ae1 --- /dev/null +++ b/doc/api-documentation/html/class_list_key-members.html @@ -0,0 +1,44 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ListKey Member List</h1>This is the complete list of members for <a class="el" href="class_list_key.html">ListKey</a>, including all inherited members.<ul> +<li><b>add</b>(const SWKey &ikey) (defined in <a class="el" href="class_list_key.html">ListKey</a>)<code> [virtual]</code><li><b>array</b> (defined in <a class="el" href="class_list_key.html">ListKey</a>)<code> [protected]</code><li><b>arraycnt</b> (defined in <a class="el" href="class_list_key.html">ListKey</a>)<code> [protected]</code><li><b>arraymax</b> (defined in <a class="el" href="class_list_key.html">ListKey</a>)<code> [protected]</code><li><b>arraypos</b> (defined in <a class="el" href="class_list_key.html">ListKey</a>)<code> [protected]</code><li><b>classdef</b> (defined in <a class="el" href="class_list_key.html">ListKey</a>)<code> [private, static]</code><li><a class="el" href="class_list_key.html#a4">ClearList</a>() +<code> [virtual]</code><li><a class="el" href="class_list_key.html#a3">clone</a>() const +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a10">compare</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_list_key.html#a11">copyFrom</a>(const ListKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_list_key.html#a12">copyFrom</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_list_key.html#a5">Count</a>() +<code> [virtual]</code><li><a class="el" href="class_list_key.html#a14">decrement</a>(int step) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a11">equals</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_key.html#a6">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_s_w_object.html#a0">getClass</a>() const +<code> [inline]</code><li><a class="el" href="class_list_key.html#a8">GetElement</a>(int pos=-1) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a9">getText</a>() const +<code> [virtual]</code><li><a class="el" href="class_list_key.html#a15">increment</a>(int step) +<code> [virtual]</code><li><a class="el" href="class_list_key.html#a17">Index</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_list_key.html#a18">Index</a>(long index) +<code> [inline, virtual]</code><li><b>init</b>() (defined in <a class="el" href="class_list_key.html">ListKey</a>)<code> [private]</code><li><b>keytext</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_list_key.html#a0">ListKey</a>(const char *ikey=0) +<li><b>ListKey</b>(ListKey const &k) (defined in <a class="el" href="class_list_key.html">ListKey</a>)<li><b>myclass</b> (defined in <a class="el" href="class_s_w_object.html">SWObject</a>)<code> [protected]</code><li><a class="el" href="class_list_key.html#a9">operator<<</a>(const SWKey &ikey) +<code> [inline]</code><li><b>operator=</b>(const ListKey &key) (defined in <a class="el" href="class_list_key.html">ListKey</a>)<code> [inline]</code><li><a class="el" href="class_s_w_key.html#a4">Persist</a>() const +<li><a class="el" href="class_s_w_key.html#a5">Persist</a>(char ikey) +<li><b>persist</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_list_key.html#a6">Remove</a>() +<code> [virtual]</code><li><a class="el" href="class_list_key.html#a13">setPosition</a>(SW_POSITION) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a7">setText</a>(const char *ikey) +<code> [virtual]</code><li><a class="el" href="class_list_key.html#a7">SetToElement</a>(int ielement, SW_POSITION=TOP) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a0">SWKey</a>(const char *ikey=0) +<li><a class="el" href="class_s_w_key.html#a1">SWKey</a>(SWKey const &k) +<li><b>Traversable</b>() (defined in <a class="el" href="class_list_key.html">ListKey</a>)<code> [inline, virtual]</code><li><a class="el" href="class_list_key.html#a2">~ListKey</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a2">~SWKey</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_list_key.gif b/doc/api-documentation/html/class_list_key.gif Binary files differnew file mode 100644 index 0000000..1f03f73 --- /dev/null +++ b/doc/api-documentation/html/class_list_key.gif diff --git a/doc/api-documentation/html/class_list_key.html b/doc/api-documentation/html/class_list_key.html new file mode 100644 index 0000000..3474384 --- /dev/null +++ b/doc/api-documentation/html/class_list_key.html @@ -0,0 +1,566 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ListKey class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ListKey Class Reference</h1>ListKey is the basis for all types of keys that have lists of specified indexes (e.g. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="listkey_8h-source.html">listkey.h</a>></code> +<p> +<p>Inheritance diagram for ListKey:: +<p><center><img src="class_list_key.gif" usemap="#ListKey_map" border="0"></center> +<map name="ListKey_map"> +<area href="class_s_w_key.html" alt="SWKey" shape="rect" coords="0,56,68,80"> +<area href="class_s_w_object.html" alt="SWObject" shape="rect" coords="0,0,68,24"> +</map> +<a href="class_list_key-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_list_key.html#a0">ListKey</a> (const char *ikey=0)</td></tr> +<tr><td> </td><td><font size=-1><em>initializes instance of ListKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ListKey::ListKey"></a> + </td><td valign=bottom><b>ListKey</b> (ListKey const &k)</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="ListKey::~ListKey"></a> +virtual </td><td valign=bottom><a class="el" href="class_list_key.html#a2">~ListKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>cleans up instance of ListKey.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_list_key.html#a3">clone</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns a copy of this <a class="el" href="class_s_w_key.html">SWKey</a> object.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="ListKey::ClearList"></a> +virtual void </td><td valign=bottom><a class="el" href="class_list_key.html#a4">ClearList</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Clears out elements of list.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_list_key.html#a5">Count</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns number of elements in list.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="ListKey::Remove"></a> +virtual void </td><td valign=bottom><a class="el" href="class_list_key.html#a6">Remove</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Removes current element from list.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_list_key.html#a7">SetToElement</a> (int ielement, SW_POSITION=TOP)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets key to element number.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_list_key.html#a8">GetElement</a> (int pos=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>Gets a key element number.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>ListKey & </td><td valign=bottom><a class="el" href="class_list_key.html#a9">operator<<</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds an element to the list.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a10" doxytag="ListKey::add"></a> +virtual void </td><td valign=bottom><b>add</b> (const <a class="el" href="class_s_w_key.html">SWKey</a> &ikey)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_list_key.html#a11">copyFrom</a> (const ListKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this ListKey to another ListKey object.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_list_key.html#a12">copyFrom</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this <a class="el" href="class_s_w_key.html">SWKey</a> to another <a class="el" href="class_s_w_key.html">SWKey</a> object.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_list_key.html#a13">setPosition</a> (SW_POSITION)</td></tr> +<tr><td> </td><td><font size=-1><em>Positions this key.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a14" doxytag="ListKey::decrement"></a> +virtual void </td><td valign=bottom><a class="el" href="class_list_key.html#a14">decrement</a> (int step)</td></tr> +<tr><td> </td><td><font size=-1><em>Decrements a number of elements.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a15" doxytag="ListKey::increment"></a> +virtual void </td><td valign=bottom><a class="el" href="class_list_key.html#a15">increment</a> (int step)</td></tr> +<tr><td> </td><td><font size=-1><em>Increments a number of elements.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a16" doxytag="ListKey::Traversable"></a> +virtual char </td><td valign=bottom><b>Traversable</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_list_key.html#a17">Index</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Use this function to get te current position withing a module.</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_list_key.html#a18">Index</a> (long index)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the index for the new one given as as parameter.</em> <a href="#a18">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a19" doxytag="ListKey::operator="></a> +SWKEY_OPERATORS ListKey & </td><td valign=bottom><b>operator=</b> (const ListKey &key)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="ListKey::arraypos"></a> +int </td><td valign=bottom><b>arraypos</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="ListKey::arraymax"></a> +int </td><td valign=bottom><b>arraymax</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="ListKey::arraycnt"></a> +int </td><td valign=bottom><b>arraycnt</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n3" doxytag="ListKey::array"></a> +<a class="el" href="class_s_w_key.html">SWKey</a> ** </td><td valign=bottom><b>array</b></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="ListKey::init"></a> +void </td><td valign=bottom><b>init</b> ()</td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="ListKey::classdef"></a> +<a class="el" href="class_s_w_class.html">SWClass</a> </td><td valign=bottom><b>classdef</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +ListKey is the basis for all types of keys that have lists of specified indexes (e.g. +<p> +a list of verses, place, etc.) +<p> + +<p> +Definition at line <a class="el" href="listkey_8h-source.html#l00036">36</a> of file <a class="el" href="listkey_8h-source.html">listkey.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="ListKey::ListKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +ListKey::ListKey + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ikey</em> = 0 </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +initializes instance of ListKey. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +text key </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a5" doxytag="ListKey::Count"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual int ListKey::Count + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns number of elements in list. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +number of elements in list </dl> </td> + </tr> +</table> +<a name="a8" doxytag="ListKey::GetElement"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual <a class="el" href="class_s_w_key.html">SWKey</a>* ListKey::GetElement + </td> + <td class="md">( </td> + <td class="md">int </td> + <td class="mdname"> <em>pos</em> = -1 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets a key element number. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>pos +</em> </td><td> +element number to get (or default current) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Key or null on error </dl> </td> + </tr> +</table> +<a name="a18" doxytag="ListKey::Index"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual long ListKey::Index + </td> + <td class="md">( </td> + <td class="md">long </td> + <td class="mdname"> <em>index</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the index for the new one given as as parameter. +<p> +The first parameter is the new index. +<p> +Reimplemented from <a class="el" href="class_s_w_key.html">SWKey</a>. +<p> +Definition at line <a class="el" href="listkey_8h-source.html#l00112">112</a> of file <a class="el" href="listkey_8h-source.html">listkey.h</a>. </td> + </tr> +</table> +<a name="a17" doxytag="ListKey::Index"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual long ListKey::Index + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Use this function to get te current position withing a module. +<p> +Here's a small example how to use this function and <a class="el" href="class_list_key.html#a18">Index</a>(long). This function uses the GerLut module and chooses a random verse from the Bible and returns it. <div class="fragment"><pre> <font class="keyword">const</font> <font class="keywordtype">char</font>* randomVerse()<font class="keyword"> </font>{ + <a class="code" href="class_verse_key.html">VerseKey</a> vk; + <a class="code" href="class_s_w_mgr.html">SWMgr</a> mgr; + LocaleMgr::systemLocaleMgr.<a class="code" href="class_locale_mgr.html#a6">setDefaultLocaleName</a>(<font class="stringliteral">"de"</font>); + + <a class="code" href="class_s_w_module.html">SWModule</a>* module = mgr-><a class="code" href="class_s_w_mgr.html#m2">Modules</a>(<font class="stringliteral">"GerLut"</font>); + srand( time(0) ); + <font class="keyword">const</font> <font class="keywordtype">double</font> newIndex = (double(rand())/RAND_MAX)*(24108+8224); + vk.<a class="code" href="class_verse_key.html#a31">Index</a>(newIndex); + module-><a class="code" href="class_s_w_module.html#a5">SetKey</a>(vk); + + <font class="keywordtype">char</font>* text; + sprintf(text, <font class="stringliteral">"%s: %s"</font>,(<font class="keyword">const</font> <font class="keywordtype">char</font>*)vk ,module-><a class="code" href="class_s_w_module.html#a53">StripText</a>(&vk)); + <font class="keywordflow">return</font> text;</pre></div> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html#a16">SWKey</a>. +<p> +Definition at line <a class="el" href="listkey_8h-source.html#l00106">106</a> of file <a class="el" href="listkey_8h-source.html">listkey.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="ListKey::SetToElement"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char ListKey::SetToElement + </td> + <td class="md">( </td> + <td class="md">int </td> + <td class="mdname"> <em>ielement</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SW_POSITION </td> + <td class="mdname"> = TOP </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets key to element number. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ielement +</em> </td><td> +element number to set to </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +error status </dl> +<p> +Referenced by <a class="el" href="listkey_8h-source.html#l00112">Index</a>(). +<p> + </td> + </tr> +</table> +<a name="a3" doxytag="ListKey::clone"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual <a class="el" href="class_s_w_key.html">SWKey</a>* ListKey::clone + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns a copy of this <a class="el" href="class_s_w_key.html">SWKey</a> object. +<p> +This is useful to get a 1:1 copy of an <a class="el" href="class_s_w_key.html">SWKey</a> based object. <dl compact><dt> +<b>Returns: </b><dd> +<a class="el" href="class_s_w_key.html">SWKey</a> </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html#a3">SWKey</a>. </td> + </tr> +</table> +<a name="a12" doxytag="ListKey::copyFrom"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void ListKey::copyFrom + </td> + <td class="md">( </td> + <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this <a class="el" href="class_s_w_key.html">SWKey</a> to another <a class="el" href="class_s_w_key.html">SWKey</a> object. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +other swkey object </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html#a8">SWKey</a>. +<p> +Definition at line <a class="el" href="listkey_8h-source.html#l00090">90</a> of file <a class="el" href="listkey_8h-source.html">listkey.h</a>. </td> + </tr> +</table> +<a name="a11" doxytag="ListKey::copyFrom"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void ListKey::copyFrom + </td> + <td class="md">( </td> + <td class="md">const ListKey & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this ListKey to another ListKey object. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +other ListKey object </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a9" doxytag="ListKey::operator<<"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +ListKey& ListKey::operator<< + </td> + <td class="md">( </td> + <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds an element to the list. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +the element to add </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="listkey_8h-source.html#l00082">82</a> of file <a class="el" href="listkey_8h-source.html">listkey.h</a>. </td> + </tr> +</table> +<a name="a13" doxytag="ListKey::setPosition"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void ListKey::setPosition + </td> + <td class="md">( </td> + <td class="md">SW_POSITION </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Positions this key. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>p +</em> </td><td> +position </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html">SWKey</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="listkey_8h-source.html">listkey.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_listkey-members.html b/doc/api-documentation/html/class_listkey-members.html new file mode 100644 index 0000000..ec7db29 --- /dev/null +++ b/doc/api-documentation/html/class_listkey-members.html @@ -0,0 +1,45 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ListKey Member List</h1>This is the complete list of members for <a class="el" href="class_listkey.html">ListKey</a>, including all inherited members.<ul> +<li><b>add</b>(const SWKey &ikey) (defined in <a class="el" href="class_listkey.html">ListKey</a>)<code> [virtual]</code><li><b>array</b> (defined in <a class="el" href="class_listkey.html">ListKey</a>)<code> [protected]</code><li><b>arraycnt</b> (defined in <a class="el" href="class_listkey.html">ListKey</a>)<code> [protected]</code><li><b>arraymax</b> (defined in <a class="el" href="class_listkey.html">ListKey</a>)<code> [protected]</code><li><b>arraypos</b> (defined in <a class="el" href="class_listkey.html">ListKey</a>)<code> [protected]</code><li><b>classdef</b> (defined in <a class="el" href="class_listkey.html">ListKey</a>)<code> [private, static]</code><li><a class="el" href="class_listkey.html#a4">ClearList</a>() +<code> [virtual]</code><li><a class="el" href="class_listkey.html#a3">clone</a>() const +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a10">compare</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_listkey.html#a11">copyFrom</a>(const ListKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_listkey.html#a12">copyFrom</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_listkey.html#a5">Count</a>() +<code> [virtual]</code><li><a class="el" href="class_listkey.html#a14">decrement</a>(int step) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a11">equals</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_swkey.html#a6">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_swobject.html#a0">getClass</a>() const +<code> [inline]</code><li><a class="el" href="class_listkey.html#a8">GetElement</a>(int pos=-1) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a9">getText</a>() const +<code> [virtual]</code><li><a class="el" href="class_listkey.html#a15">increment</a>(int step) +<code> [virtual]</code><li><a class="el" href="class_listkey.html#a17">Index</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_listkey.html#a18">Index</a>(long index) +<code> [inline, virtual]</code><li><b>init</b>() (defined in <a class="el" href="class_listkey.html">ListKey</a>)<code> [private]</code><li><b>keytext</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_listkey.html#a0">ListKey</a>(const char *ikey=0) +<li><b>ListKey</b>(ListKey const &k) (defined in <a class="el" href="class_listkey.html">ListKey</a>)<li><b>myclass</b> (defined in <a class="el" href="class_swobject.html">SWObject</a>)<code> [protected]</code><li><a class="el" href="class_listkey.html#a9">operator<<</a>(const SWKey &ikey) +<code> [inline]</code><li><b>operator=</b>(const ListKey &key) (defined in <a class="el" href="class_listkey.html">ListKey</a>)<code> [inline]</code><li><a class="el" href="class_swkey.html#a4">Persist</a>() const +<li><a class="el" href="class_swkey.html#a5">Persist</a>(char ikey) +<li><b>persist</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_listkey.html#a6">Remove</a>() +<code> [virtual]</code><li><a class="el" href="class_listkey.html#a13">setPosition</a>(SW_POSITION) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a7">setText</a>(const char *ikey) +<code> [virtual]</code><li><a class="el" href="class_listkey.html#a7">SetToElement</a>(int ielement, SW_POSITION=TOP) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a0">SWKey</a>(const char *ikey=0) +<li><a class="el" href="class_swkey.html#a1">SWKey</a>(SWKey const &k) +<li><b>Traversable</b>() (defined in <a class="el" href="class_listkey.html">ListKey</a>)<code> [inline, virtual]</code><li><a class="el" href="class_listkey.html#a2">~ListKey</a>() +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a2">~SWKey</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_listkey.gif b/doc/api-documentation/html/class_listkey.gif Binary files differnew file mode 100644 index 0000000..1f03f73 --- /dev/null +++ b/doc/api-documentation/html/class_listkey.gif diff --git a/doc/api-documentation/html/class_listkey.html b/doc/api-documentation/html/class_listkey.html new file mode 100644 index 0000000..ed38500 --- /dev/null +++ b/doc/api-documentation/html/class_listkey.html @@ -0,0 +1,540 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ListKey class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ListKey Class Reference</h1>ListKey is the basis for all types of keys that have lists of specified indexes (e.g. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="listkey_h-source.html">listkey.h</a>></code> +<p> +<p>Inheritance diagram for ListKey:: +<p><center><img src="class_listkey.gif" usemap="#ListKey_map" border="0"></center> +<map name="ListKey_map"> +<area href="class_swkey.html" alt="SWKey" shape="rect" coords="0,56,68,80"> +<area href="class_swobject.html" alt="SWObject" shape="rect" coords="0,0,68,24"> +</map> +<a href="class_listkey-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_listkey.html#a0">ListKey</a> (const char *ikey=0)</td></tr> +<tr><td> </td><td><font size=-1><em>initializes instance of ListKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ListKey::ListKey"></a> + </td><td valign=bottom><b>ListKey</b> (ListKey const &k)</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="ListKey::~ListKey"></a> +virtual </td><td valign=bottom><a class="el" href="class_listkey.html#a2">~ListKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>cleans up instance of ListKey.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_listkey.html#a3">clone</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns a copy of this <a class="el" href="class_swkey.html">SWKey</a> object.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="ListKey::ClearList"></a> +virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a4">ClearList</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Clears out elements of list.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_listkey.html#a5">Count</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Returns number of elements in list.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="ListKey::Remove"></a> +virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a6">Remove</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Removes current element from list.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_listkey.html#a7">SetToElement</a> (int ielement, SW_POSITION=TOP)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets key to element number.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_listkey.html#a8">GetElement</a> (int pos=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>Gets a key element number.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>ListKey& </td><td valign=bottom><a class="el" href="class_listkey.html#a9">operator<<</a> (const <a class="el" href="class_swkey.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds an element to the list.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a10" doxytag="ListKey::add"></a> +virtual void </td><td valign=bottom><b>add</b> (const <a class="el" href="class_swkey.html">SWKey</a> &ikey)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a11">copyFrom</a> (const ListKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this ListKey to another ListKey object.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a12">copyFrom</a> (const <a class="el" href="class_swkey.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this <a class="el" href="class_swkey.html">SWKey</a> to another <a class="el" href="class_swkey.html">SWKey</a> object.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a13">setPosition</a> (SW_POSITION)</td></tr> +<tr><td> </td><td><font size=-1><em>Positions this key.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a14" doxytag="ListKey::decrement"></a> +virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a14">decrement</a> (int step)</td></tr> +<tr><td> </td><td><font size=-1><em>Decrements a number of elements.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a15" doxytag="ListKey::increment"></a> +virtual void </td><td valign=bottom><a class="el" href="class_listkey.html#a15">increment</a> (int step)</td></tr> +<tr><td> </td><td><font size=-1><em>Increments a number of elements.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a16" doxytag="ListKey::Traversable"></a> +virtual char </td><td valign=bottom><b>Traversable</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_listkey.html#a17">Index</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Use this function to get te current position withing a module.</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_listkey.html#a18">Index</a> (long index)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns the index for the new one given as as parameter.</em> <a href="#a18">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a19" doxytag="ListKey::operator="></a> +SWKEY_OPERATORS ListKey& </td><td valign=bottom><b>operator=</b> (const ListKey &key)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="ListKey::arraypos"></a> +int </td><td valign=bottom><b>arraypos</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="ListKey::arraymax"></a> +int </td><td valign=bottom><b>arraymax</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="ListKey::arraycnt"></a> +int </td><td valign=bottom><b>arraycnt</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n3" doxytag="ListKey::array"></a> +<a class="el" href="class_swkey.html">SWKey</a>** </td><td valign=bottom><b>array</b></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="ListKey::init"></a> +void </td><td valign=bottom><b>init</b> ()</td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="ListKey::classdef"></a> +<a class="el" href="class_swclass.html">SWClass</a> </td><td valign=bottom><b>classdef</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +ListKey is the basis for all types of keys that have lists of specified indexes (e.g. +<p> +a list of verses, place, etc.) +<p> + +<p> +Definition at line <a class="el" href="listkey_h-source.html#l00036">36</a> of file <a class="el" href="listkey_h-source.html">listkey.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="ListKey::ListKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +ListKey::ListKey ( + </b></td> + <td valign="bottom"><b> +const char * <em>ikey</em> = 0 ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +initializes instance of ListKey. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +text key </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a5" doxytag="ListKey::Count"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int ListKey::Count ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns number of elements in list. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +number of elements in list </dl> </td> + </tr> +</table> +<a name="a8" doxytag="ListKey::GetElement"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="class_swkey.html">SWKey</a> * ListKey::GetElement ( + </b></td> + <td valign="bottom"><b> +int <em>pos</em> = -1 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets a key element number. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>pos</em> + </td><td> +element number to get (or default current) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Key or null on error </dl> </td> + </tr> +</table> +<a name="a18" doxytag="ListKey::Index"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +long ListKey::Index ( + </b></td> + <td valign="bottom"><b> +long <em>index</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the index for the new one given as as parameter. +<p> +The first parameter is the new index. +<p> +Reimplemented from <a class="el" href="class_swkey.html">SWKey</a>. +<p> +Definition at line <a class="el" href="listkey_h-source.html#l00112">112</a> of file <a class="el" href="listkey_h-source.html">listkey.h</a>. </td> + </tr> +</table> +<a name="a17" doxytag="ListKey::Index"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +long ListKey::Index ( + </b></td> + <td valign="bottom"><b> +) const<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Use this function to get te current position withing a module. +<p> +Here's a small example how to use this function and <a class="el" href="class_listkey.html#a18">Index</a>(long). This function uses the GerLut module and chooses a random verse from the Bible and returns it. <div class="fragment"><pre> <font class="keyword">const</font> <font class="keywordtype">char</font>* randomVerse()<font class="keyword"> </font>{ + <a class="code" href="class_versekey.html">VerseKey</a> vk; + <a class="code" href="class_swmgr.html">SWMgr</a> mgr; + LocaleMgr::systemLocaleMgr.<a class="code" href="class_localemgr.html#a6">setDefaultLocaleName</a>(<font class="stringliteral">"de"</font>); + + <a class="code" href="class_swmodule.html">SWModule</a>* module = mgr-><a class="code" href="class_swmgr.html#m2">Modules</a>(<font class="stringliteral">"GerLut"</font>); + srand( time(0) ); + <font class="keyword">const</font> <font class="keywordtype">double</font> newIndex = (double(rand())/RAND_MAX)*(24108+8224); + vk.<a class="code" href="class_versekey.html#a31">Index</a>(newIndex); + module-><a class="code" href="class_swmodule.html#a5">SetKey</a>(vk); + + <font class="keywordtype">char</font>* text; + sprintf(text, <font class="stringliteral">"%s: %s"</font>,(<font class="keyword">const</font> <font class="keywordtype">char</font>*)vk ,module-><a class="code" href="class_swmodule.html#a43">StripText</a>(&vk)); + <font class="keywordflow">return</font> text;</pre></div> +<p> +Reimplemented from <a class="el" href="class_swkey.html#a16">SWKey</a>. +<p> +Definition at line <a class="el" href="listkey_h-source.html#l00106">106</a> of file <a class="el" href="listkey_h-source.html">listkey.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="ListKey::SetToElement"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char ListKey::SetToElement ( + </b></td> + <td valign="bottom"><b> +int <em>ielement</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +SW_POSITION = TOP )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets key to element number. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ielement</em> + </td><td> +element number to set to </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +error status </dl> +<p> +Referenced by <a class="el" href="listkey_h-source.html#l00112">Index</a>(). </td> + </tr> +</table> +<a name="a3" doxytag="ListKey::clone"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual <a class="el" href="class_swkey.html">SWKey</a>* ListKey::clone ( + </b></td> + <td valign="bottom"><b> +) const<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns a copy of this <a class="el" href="class_swkey.html">SWKey</a> object. +<p> +This is useful to get a 1:1 copy of an <a class="el" href="class_swkey.html">SWKey</a> based object. <dl compact><dt> +<b>Returns: </b><dd> +<a class="el" href="class_swkey.html">SWKey</a> </dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html#a3">SWKey</a>. </td> + </tr> +</table> +<a name="a12" doxytag="ListKey::copyFrom"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void ListKey::copyFrom ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="class_swkey.html">SWKey</a> & <em>ikey</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this <a class="el" href="class_swkey.html">SWKey</a> to another <a class="el" href="class_swkey.html">SWKey</a> object. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +other swkey object </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html#a8">SWKey</a>. +<p> +Definition at line <a class="el" href="listkey_h-source.html#l00090">90</a> of file <a class="el" href="listkey_h-source.html">listkey.h</a>. </td> + </tr> +</table> +<a name="a11" doxytag="ListKey::copyFrom"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void ListKey::copyFrom ( + </b></td> + <td valign="bottom"><b> +const ListKey & <em>ikey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this ListKey to another ListKey object. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +other ListKey object </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a9" doxytag="ListKey::operator<<"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +ListKey & ListKey::operator<< ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="class_swkey.html">SWKey</a> & <em>ikey</em> )<code> [inline]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds an element to the list. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +the element to add </td></tr> +</table> +</dl> +<p> +Definition at line <a class="el" href="listkey_h-source.html#l00082">82</a> of file <a class="el" href="listkey_h-source.html">listkey.h</a>. </td> + </tr> +</table> +<a name="a13" doxytag="ListKey::setPosition"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void ListKey::setPosition ( + </b></td> + <td valign="bottom"><b> +SW_POSITION )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Positions this key. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>p</em> + </td><td> +position </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html">SWKey</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="listkey_h-source.html">listkey.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_locale_mgr-members.html b/doc/api-documentation/html/class_locale_mgr-members.html new file mode 100644 index 0000000..8fd5638 --- /dev/null +++ b/doc/api-documentation/html/class_locale_mgr-members.html @@ -0,0 +1,25 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>LocaleMgr Member List</h1>This is the complete list of members for <a class="el" href="class_locale_mgr.html">LocaleMgr</a>, including all inherited members.<ul> +<li><b>defaultLocaleName</b> (defined in <a class="el" href="class_locale_mgr.html">LocaleMgr</a>)<code> [private]</code><li><b>deleteLocales</b>() (defined in <a class="el" href="class_locale_mgr.html">LocaleMgr</a>)<code> [private]</code><li><a class="el" href="class_locale_mgr.html#a3">getAvailableLocales</a>() +<code> [virtual]</code><li><a class="el" href="class_locale_mgr.html#a5">getDefaultLocaleName</a>() +<code> [virtual]</code><li><a class="el" href="class_locale_mgr.html#a2">getLocale</a>(const char *name) +<code> [virtual]</code><li><b>loadConfigDir</b>(const char *ipath) (defined in <a class="el" href="class_locale_mgr.html">LocaleMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_locale_mgr.html#a0">LocaleMgr</a>(const char *iConfigPath=0) +<li><b>locales</b> (defined in <a class="el" href="class_locale_mgr.html">LocaleMgr</a>)<code> [protected]</code><li><a class="el" href="class_locale_mgr.html#a6">setDefaultLocaleName</a>(const char *name) +<code> [virtual]</code><li><a class="el" href="class_locale_mgr.html#p0">systemLocaleMgr</a> +<code> [static]</code><li><a class="el" href="class_locale_mgr.html#a4">translate</a>(const char *name, const char *text) +<code> [virtual]</code><li><a class="el" href="class_locale_mgr.html#a1">~LocaleMgr</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_locale_mgr.html b/doc/api-documentation/html/class_locale_mgr.html new file mode 100644 index 0000000..64acb09 --- /dev/null +++ b/doc/api-documentation/html/class_locale_mgr.html @@ -0,0 +1,302 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>LocaleMgr class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>LocaleMgr Class Reference</h1>The LocaleMgr class handles all the different locales of Sword. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="localemgr_8h-source.html">localemgr.h</a>></code> +<p> +<a href="class_locale_mgr-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="LocaleMgr::LocaleMgr"></a> + </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a0">LocaleMgr</a> (const char *iConfigPath=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Default constructor of LocaleMgr You do normally not need this constructor, use <a class="el" href="class_locale_mgr.html#p0">LocaleMgr::systemLocaleMgr</a> instead.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="LocaleMgr::~LocaleMgr"></a> +virtual </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a1">~LocaleMgr</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Default destructor of LocaleMgr.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_locale.html">SWLocale</a> * </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a2">getLocale</a> (const char *name)</td></tr> +<tr><td> </td><td><font size=-1><em>Get the locale connected with the name "name".</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual list< string > </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a3">getAvailableLocales</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Get the list of available locales.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a4">translate</a> (const char *name, const char *text)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns translated text.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a5">getDefaultLocaleName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Get the default locale name.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_locale_mgr.html#a6">setDefaultLocaleName</a> (const char *name)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the new standard locale of Sword.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>LocaleMgr </td><td valign=bottom><a class="el" href="class_locale_mgr.html#p0">systemLocaleMgr</a></td></tr> +<tr><td> </td><td><font size=-1><em>The LocaleMgr object used globally in the Sword world.</em> <a href="#p0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="LocaleMgr::loadConfigDir"></a> +virtual void </td><td valign=bottom><b>loadConfigDir</b> (const char *ipath)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="LocaleMgr::locales"></a> +LocaleMap </td><td valign=bottom><b>locales</b></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="LocaleMgr::deleteLocales"></a> +void </td><td valign=bottom><b>deleteLocales</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="LocaleMgr::defaultLocaleName"></a> +char * </td><td valign=bottom><b>defaultLocaleName</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The LocaleMgr class handles all the different locales of Sword. +<p> +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. +<p> +To get the default locale name use <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_locale_mgr.html#a5">getDefaultLocaleName</a> To set the default locale name use , <a class="el" href="class_locale_mgr.html#a6">setDefaultLocaleName</a> To get the locale for a language name use , <a class="el" href="class_locale_mgr.html#a2">getLocale</a> To get a list of availble locales use , <a class="el" href="class_locale_mgr.html#a3">getAvailableLocales</a> </dl> +<p> + +<p> +Definition at line <a class="el" href="localemgr_8h-source.html#l00049">49</a> of file <a class="el" href="localemgr_8h-source.html">localemgr.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="LocaleMgr::getAvailableLocales"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual list< string > LocaleMgr::getAvailableLocales + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the list of available locales. +<p> +@ret Returns a list of strings, which contains the names of the available locales. </td> + </tr> +</table> +<a name="a5" doxytag="LocaleMgr::getDefaultLocaleName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* LocaleMgr::getDefaultLocaleName + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the default locale name. +<p> +To set it use <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_locale_mgr.html#a6">setDefaultLocaleName</a> +<p> +</dl>@ret Returns the default locale name </td> + </tr> +</table> +<a name="a2" doxytag="LocaleMgr::getLocale"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual <a class="el" href="class_s_w_locale.html">SWLocale</a>* LocaleMgr::getLocale + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>name</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the locale connected with the name "name". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name +</em> </td><td> +The name of the locale you want to have. For example use getLocale("de") to get the locale for the German language. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Returns the locale object if the locale with the name given as parameter was found. If it wasn't found return NULL. </dl> </td> + </tr> +</table> +<a name="a6" doxytag="LocaleMgr::setDefaultLocaleName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void LocaleMgr::setDefaultLocaleName + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>name</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the new standard locale of Sword. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name +</em> </td><td> +The name of the new default locale </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a4" doxytag="LocaleMgr::translate"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* LocaleMgr::translate + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>name</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>text</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns translated text. +<p> +This function uses both parameters to return the translated version of the given text.<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name +</em> </td><td> +The name of the locale Sword should use </td></tr> +</table> +</dl><dl compact><dt> +<b>an The text to translate into the language given by the first parameter.</b><dd> + </dl><dl compact><dt> +<b>Returns: </b><dd> +Returns the translated text. </dl> </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="p0" doxytag="LocaleMgr::systemLocaleMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +LocaleMgr LocaleMgr::systemLocaleMgr<code> [static]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The LocaleMgr object used globally in the Sword world. +<p> +Do not create your own LocaleMgr, use this static object instead. +<p> +Definition at line <a class="el" href="localemgr_8h-source.html#l00107">107</a> of file <a class="el" href="localemgr_8h-source.html">localemgr.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="localemgr_8h-source.html">localemgr.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_localemgr-members.html b/doc/api-documentation/html/class_localemgr-members.html new file mode 100644 index 0000000..ca196dd --- /dev/null +++ b/doc/api-documentation/html/class_localemgr-members.html @@ -0,0 +1,26 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>LocaleMgr Member List</h1>This is the complete list of members for <a class="el" href="class_localemgr.html">LocaleMgr</a>, including all inherited members.<ul> +<li><b>defaultLocaleName</b> (defined in <a class="el" href="class_localemgr.html">LocaleMgr</a>)<code> [private]</code><li><b>deleteLocales</b>() (defined in <a class="el" href="class_localemgr.html">LocaleMgr</a>)<code> [private]</code><li><a class="el" href="class_localemgr.html#a3">getAvailableLocales</a>() +<code> [virtual]</code><li><a class="el" href="class_localemgr.html#a5">getDefaultLocaleName</a>() +<code> [virtual]</code><li><a class="el" href="class_localemgr.html#a2">getLocale</a>(const char *name) +<code> [virtual]</code><li><b>loadConfigDir</b>(const char *ipath) (defined in <a class="el" href="class_localemgr.html">LocaleMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_localemgr.html#a0">LocaleMgr</a>(const char *iConfigPath=0) +<li><b>locales</b> (defined in <a class="el" href="class_localemgr.html">LocaleMgr</a>)<code> [protected]</code><li><a class="el" href="class_localemgr.html#a6">setDefaultLocaleName</a>(const char *name) +<code> [virtual]</code><li><a class="el" href="class_localemgr.html#p0">systemLocaleMgr</a> +<code> [static]</code><li><a class="el" href="class_localemgr.html#a4">translate</a>(const char *name, const char *text) +<code> [virtual]</code><li><a class="el" href="class_localemgr.html#a1">~LocaleMgr</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_localemgr.html b/doc/api-documentation/html/class_localemgr.html new file mode 100644 index 0000000..26bd05f --- /dev/null +++ b/doc/api-documentation/html/class_localemgr.html @@ -0,0 +1,292 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>LocaleMgr class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>LocaleMgr Class Reference</h1>The LocaleMgr class handles all the different locales of Sword. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="localemgr_h-source.html">localemgr.h</a>></code> +<p> +<a href="class_localemgr-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="LocaleMgr::LocaleMgr"></a> + </td><td valign=bottom><a class="el" href="class_localemgr.html#a0">LocaleMgr</a> (const char *iConfigPath=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Default constructor of LocaleMgr You do normally not need this constructor, use <a class="el" href="class_localemgr.html#p0">LocaleMgr::systemLocaleMgr</a> instead.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="LocaleMgr::~LocaleMgr"></a> +virtual </td><td valign=bottom><a class="el" href="class_localemgr.html#a1">~LocaleMgr</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Default destructor of LocaleMgr.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_swlocale.html">SWLocale</a>* </td><td valign=bottom><a class="el" href="class_localemgr.html#a2">getLocale</a> (const char *name)</td></tr> +<tr><td> </td><td><font size=-1><em>Get the locale connected with the name "name".</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual list< string > </td><td valign=bottom><a class="el" href="class_localemgr.html#a3">getAvailableLocales</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Get the list of available locales.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_localemgr.html#a4">translate</a> (const char *name, const char *text)</td></tr> +<tr><td> </td><td><font size=-1><em>Returns translated text.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_localemgr.html#a5">getDefaultLocaleName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Get the default locale name.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_localemgr.html#a6">setDefaultLocaleName</a> (const char *name)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the new standard locale of Sword.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>LocaleMgr </td><td valign=bottom><a class="el" href="class_localemgr.html#p0">systemLocaleMgr</a></td></tr> +<tr><td> </td><td><font size=-1><em>The LocaleMgr object used globally in the Sword world.</em> <a href="#p0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="LocaleMgr::loadConfigDir"></a> +virtual void </td><td valign=bottom><b>loadConfigDir</b> (const char *ipath)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="LocaleMgr::locales"></a> +LocaleMap </td><td valign=bottom><b>locales</b></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="LocaleMgr::deleteLocales"></a> +void </td><td valign=bottom><b>deleteLocales</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="LocaleMgr::defaultLocaleName"></a> +char* </td><td valign=bottom><b>defaultLocaleName</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The LocaleMgr class handles all the different locales of Sword. +<p> +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. +<p> +To get the default locale name use <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_localemgr.html#a5">getDefaultLocaleName</a> To set the default locale name use , <a class="el" href="class_localemgr.html#a6">setDefaultLocaleName</a> To get the locale for a language name use , <a class="el" href="class_localemgr.html#a2">getLocale</a> To get a list of availble locales use , <a class="el" href="class_localemgr.html#a3">getAvailableLocales</a> </dl> +<p> + +<p> +Definition at line <a class="el" href="localemgr_h-source.html#l00049">49</a> of file <a class="el" href="localemgr_h-source.html">localemgr.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="LocaleMgr::getAvailableLocales"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +list< string > LocaleMgr::getAvailableLocales ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the list of available locales. +<p> +@ret Returns a list of strings, which contains the names of the available locales. </td> + </tr> +</table> +<a name="a5" doxytag="LocaleMgr::getDefaultLocaleName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * LocaleMgr::getDefaultLocaleName ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the default locale name. +<p> +To set it use <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_localemgr.html#a6">setDefaultLocaleName</a> +<p> +</dl>@ret Returns the default locale name </td> + </tr> +</table> +<a name="a2" doxytag="LocaleMgr::getLocale"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="class_swlocale.html">SWLocale</a> * LocaleMgr::getLocale ( + </b></td> + <td valign="bottom"><b> +const char * <em>name</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the locale connected with the name "name". +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> + </td><td> +The name of the locale you want to have. For example use getLocale("de") to get the locale for the German language. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Returns the locale object if the locale with the name given as parameter was found. If it wasn't found return NULL. </dl> </td> + </tr> +</table> +<a name="a6" doxytag="LocaleMgr::setDefaultLocaleName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void LocaleMgr::setDefaultLocaleName ( + </b></td> + <td valign="bottom"><b> +const char * <em>name</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the new standard locale of Sword. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> + </td><td> +The name of the new default locale </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a4" doxytag="LocaleMgr::translate"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * LocaleMgr::translate ( + </b></td> + <td valign="bottom"><b> +const char * <em>name</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const char * <em>text</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns translated text. +<p> +This function uses both parameters to return the translated version of the given text.<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>name</em> + </td><td> +The name of the locale Sword should use </td></tr> +</table> +</dl><dl compact><dt> +<b>an The text to translate into the language given by the first parameter.</b><dd> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Returns the translated text. </dl> </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="p0" doxytag="LocaleMgr::systemLocaleMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +LocaleMgr LocaleMgr::systemLocaleMgr<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The LocaleMgr object used globally in the Sword world. +<p> +Do not create your own LocaleMgr, use this static object instead. +<p> +Definition at line <a class="el" href="localemgr_h-source.html#l00107">107</a> of file <a class="el" href="localemgr_h-source.html">localemgr.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="localemgr_h-source.html">localemgr.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_markup_filter_mgr-members.html b/doc/api-documentation/html/class_markup_filter_mgr-members.html new file mode 100644 index 0000000..5daed1b --- /dev/null +++ b/doc/api-documentation/html/class_markup_filter_mgr-members.html @@ -0,0 +1,26 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>MarkupFilterMgr Member List</h1>This is the complete list of members for <a class="el" href="class_markup_filter_mgr.html">MarkupFilterMgr</a>, including all inherited members.<ul> +<li><a class="el" href="class_encoding_filter_mgr.html#a4">AddEncodingFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [virtual]</code><li><b>AddGlobalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><b>AddLocalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><a class="el" href="class_encoding_filter_mgr.html#a3">AddRawFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [virtual]</code><li><a class="el" href="class_markup_filter_mgr.html#a3">AddRenderFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [virtual]</code><li><b>AddStripFilters</b>(SWModule *module, ConfigEntMap &section) (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><b>CreateFilters</b>(char markup) (defined in <a class="el" href="class_markup_filter_mgr.html">MarkupFilterMgr</a>)<code> [protected]</code><li><a class="el" href="class_encoding_filter_mgr.html#a2">Encoding</a>(char enc) +<li><b>encoding</b> (defined in <a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a>)<code> [protected]</code><li><a class="el" href="class_encoding_filter_mgr.html#a0">EncodingFilterMgr</a>(char encoding=ENC_UTF8) +<li><b>fromgbf</b> (defined in <a class="el" href="class_markup_filter_mgr.html">MarkupFilterMgr</a>)<code> [protected]</code><li><b>fromosis</b> (defined in <a class="el" href="class_markup_filter_mgr.html">MarkupFilterMgr</a>)<code> [protected]</code><li><b>fromplain</b> (defined in <a class="el" href="class_markup_filter_mgr.html">MarkupFilterMgr</a>)<code> [protected]</code><li><b>fromthml</b> (defined in <a class="el" href="class_markup_filter_mgr.html">MarkupFilterMgr</a>)<code> [protected]</code><li><b>getParentMgr</b>() (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><b>latin1utf8</b> (defined in <a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a>)<code> [protected]</code><li><b>markup</b> (defined in <a class="el" href="class_markup_filter_mgr.html">MarkupFilterMgr</a>)<code> [protected]</code><li><a class="el" href="class_markup_filter_mgr.html#a2">Markup</a>(char m=FMT_UNKNOWN) +<li><a class="el" href="class_markup_filter_mgr.html#a0">MarkupFilterMgr</a>(char markup=FMT_THML, char encoding=ENC_UTF8) +<li><b>scsuutf8</b> (defined in <a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a>)<code> [protected]</code><li><b>setParentMgr</b>(SWMgr *parentMgr) (defined in <b>SWFilterMgr</b>)<code> [virtual]</code><li><b>SWFilterMgr</b>() (defined in <b>SWFilterMgr</b>)<li><b>targetenc</b> (defined in <a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a>)<code> [protected]</code><li><a class="el" href="class_encoding_filter_mgr.html#a1">~EncodingFilterMgr</a>() +<li><a class="el" href="class_markup_filter_mgr.html#a1">~MarkupFilterMgr</a>() +<li><b>~SWFilterMgr</b>() (defined in <b>SWFilterMgr</b>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_markup_filter_mgr.gif b/doc/api-documentation/html/class_markup_filter_mgr.gif Binary files differnew file mode 100644 index 0000000..039d358 --- /dev/null +++ b/doc/api-documentation/html/class_markup_filter_mgr.gif diff --git a/doc/api-documentation/html/class_markup_filter_mgr.html b/doc/api-documentation/html/class_markup_filter_mgr.html new file mode 100644 index 0000000..a215d53 --- /dev/null +++ b/doc/api-documentation/html/class_markup_filter_mgr.html @@ -0,0 +1,221 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>MarkupFilterMgr class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>MarkupFilterMgr Class Reference</h1>This class is like a normal SWEncodingMgr, but you can additonally specify which markup you want to use. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="markupfiltmgr_8h-source.html">markupfiltmgr.h</a>></code> +<p> +<p>Inheritance diagram for MarkupFilterMgr:: +<p><center><img src="class_markup_filter_mgr.gif" usemap="#MarkupFilterMgr_map" border="0"></center> +<map name="MarkupFilterMgr_map"> +<area href="class_encoding_filter_mgr.html" alt="EncodingFilterMgr" shape="rect" coords="0,0,117,24"> +</map> +<a href="class_markup_filter_mgr-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_markup_filter_mgr.html#a0">MarkupFilterMgr</a> (char markup=FMT_THML, char encoding=ENC_UTF8)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor of SWMarkupMgr.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="MarkupFilterMgr::~MarkupFilterMgr"></a> + </td><td valign=bottom><a class="el" href="class_markup_filter_mgr.html#a1">~MarkupFilterMgr</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>The destructor of SWMarkupMgr.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="class_markup_filter_mgr.html#a2">Markup</a> (char m=FMT_UNKNOWN)</td></tr> +<tr><td> </td><td><font size=-1><em>Markup sets/gets the markup after initialization.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_markup_filter_mgr.html#a3">AddRenderFilters</a> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the render filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module".</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="MarkupFilterMgr::CreateFilters"></a> +void </td><td valign=bottom><b>CreateFilters</b> (char markup)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="MarkupFilterMgr::fromthml"></a> +SWFilter * </td><td valign=bottom><b>fromthml</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="MarkupFilterMgr::fromgbf"></a> +SWFilter * </td><td valign=bottom><b>fromgbf</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="MarkupFilterMgr::fromplain"></a> +SWFilter * </td><td valign=bottom><b>fromplain</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n3" doxytag="MarkupFilterMgr::fromosis"></a> +SWFilter * </td><td valign=bottom><b>fromosis</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n4" doxytag="MarkupFilterMgr::markup"></a> +char </td><td valign=bottom><b>markup</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class is like a normal SWEncodingMgr, but you can additonally specify which markup you want to use. +<p> + +<p> +Definition at line <a class="el" href="markupfiltmgr_8h-source.html#l00031">31</a> of file <a class="el" href="markupfiltmgr_8h-source.html">markupfiltmgr.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="MarkupFilterMgr::MarkupFilterMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +MarkupFilterMgr::MarkupFilterMgr + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>markup</em> = FMT_THML, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">char </td> + <td class="mdname"> <em>encoding</em> = ENC_UTF8 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor of SWMarkupMgr. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iconfig +</em> </td><td> +</td></tr> +<tr><td valign=top><em>isysconfig +</em> </td><td> +</td></tr> +<tr><td valign=top><em>autoload +</em> </td><td> +If this bool is true the constructor starts loading the installed modules. If you reimplemented <a class="el" href="class_s_w_mgr.html">SWMgr</a> you can set autoload=false to load the modules with your own reimplemented function. </td></tr> +<tr><td valign=top><em>encoding +</em> </td><td> +The desired encoding. </td></tr> +<tr><td valign=top><em>markup +</em> </td><td> +The desired markup format. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="MarkupFilterMgr::AddRenderFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void MarkupFilterMgr::AddRenderFilters + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> * </td> + <td class="mdname"> <em>module</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">ConfigEntMap & </td> + <td class="mdname"> <em>section</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the render filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module +</em> </td><td> +To this module the render filter(s) are added </td></tr> +<tr><td valign=top><em>section +</em> </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a2" doxytag="MarkupFilterMgr::Markup"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +char MarkupFilterMgr::Markup + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>m</em> = FMT_UNKNOWN </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Markup sets/gets the markup after initialization. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>m +</em> </td><td> +The new markup or FMT_UNKNOWN if you just want to get the current markup. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +The current (possibly changed) markup format. </dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="markupfiltmgr_8h-source.html">markupfiltmgr.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_p_l_a_i_n_footnotes-members.html b/doc/api-documentation/html/class_p_l_a_i_n_footnotes-members.html new file mode 100644 index 0000000..0c861cf --- /dev/null +++ b/doc/api-documentation/html/class_p_l_a_i_n_footnotes-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>PLAINFootnotes Member List</h1>This is the complete list of members for <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [private, static]</code><li><b>PLAINFootnotes</b>() (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [virtual]</code><li><b>~PLAINFootnotes</b>() (defined in <a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_p_l_a_i_n_footnotes.gif b/doc/api-documentation/html/class_p_l_a_i_n_footnotes.gif Binary files differnew file mode 100644 index 0000000..4804e41 --- /dev/null +++ b/doc/api-documentation/html/class_p_l_a_i_n_footnotes.gif diff --git a/doc/api-documentation/html/class_p_l_a_i_n_footnotes.html b/doc/api-documentation/html/class_p_l_a_i_n_footnotes.html new file mode 100644 index 0000000..85f8166 --- /dev/null +++ b/doc/api-documentation/html/class_p_l_a_i_n_footnotes.html @@ -0,0 +1,64 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>PLAINFootnotes class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>PLAINFootnotes Class Reference</h1>Shows or hides footnotes in plain text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="plainfootnotes_8h-source.html">plainfootnotes.h</a>></code> +<p> +<a href="class_p_l_a_i_n_footnotes-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="PLAINFootnotes::PLAINFootnotes"></a> + </td><td valign=bottom><b>PLAINFootnotes</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="PLAINFootnotes::~PLAINFootnotes"></a> +virtual </td><td valign=bottom><b>~PLAINFootnotes</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="PLAINFootnotes::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="PLAINFootnotes::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="PLAINFootnotes::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="PLAINFootnotes::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="PLAINFootnotes::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="PLAINFootnotes::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="PLAINFootnotes::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="PLAINFootnotes::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="PLAINFootnotes::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="PLAINFootnotes::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="PLAINFootnotes::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="PLAINFootnotes::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Shows or hides footnotes in plain text. +<p> +<dl compact><dt> +<b>Author: </b><dd> +The team of BibleTime </dl> +<p> + +<p> +Definition at line <a class="el" href="plainfootnotes_8h-source.html#l00033">33</a> of file <a class="el" href="plainfootnotes_8h-source.html">plainfootnotes.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="plainfootnotes_8h-source.html">plainfootnotes.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_p_l_a_i_n_h_t_m_l-members.html b/doc/api-documentation/html/class_p_l_a_i_n_h_t_m_l-members.html new file mode 100644 index 0000000..62f149c --- /dev/null +++ b/doc/api-documentation/html/class_p_l_a_i_n_h_t_m_l-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>PLAINHTML Member List</h1>This is the complete list of members for <a class="el" href="class_p_l_a_i_n_h_t_m_l.html">PLAINHTML</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>PLAINHTML</b>() (defined in <a class="el" href="class_p_l_a_i_n_h_t_m_l.html">PLAINHTML</a>)<li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_p_l_a_i_n_h_t_m_l.html">PLAINHTML</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_p_l_a_i_n_h_t_m_l.gif b/doc/api-documentation/html/class_p_l_a_i_n_h_t_m_l.gif Binary files differnew file mode 100644 index 0000000..147743f --- /dev/null +++ b/doc/api-documentation/html/class_p_l_a_i_n_h_t_m_l.gif diff --git a/doc/api-documentation/html/class_p_l_a_i_n_h_t_m_l.html b/doc/api-documentation/html/class_p_l_a_i_n_h_t_m_l.html new file mode 100644 index 0000000..dd59847 --- /dev/null +++ b/doc/api-documentation/html/class_p_l_a_i_n_h_t_m_l.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>PLAINHTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>PLAINHTML Class Reference</h1>this filter converts plain text to HTML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="plainhtml_8h-source.html">plainhtml.h</a>></code> +<p> +<a href="class_p_l_a_i_n_h_t_m_l-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="PLAINHTML::PLAINHTML"></a> + </td><td valign=bottom><b>PLAINHTML</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="PLAINHTML::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts plain text to HTML text. +<p> + +<p> +Definition at line <a class="el" href="plainhtml_8h-source.html#l00031">31</a> of file <a class="el" href="plainhtml_8h-source.html">plainhtml.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="plainhtml_8h-source.html">plainhtml.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_plainfootnotes-members.html b/doc/api-documentation/html/class_plainfootnotes-members.html new file mode 100644 index 0000000..93f4c8d --- /dev/null +++ b/doc/api-documentation/html/class_plainfootnotes-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>PLAINFootnotes Member List</h1>This is the complete list of members for <a class="el" href="class_plainfootnotes.html">PLAINFootnotes</a>, including all inherited members.<ul> +<li><a class="el" href="class_plainfootnotes.html#a3">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_plainfootnotes.html#a4">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_plainfootnotes.html">PLAINFootnotes</a>)<code> [virtual]</code><li><a class="el" href="class_plainfootnotes.html#a7">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_plainfootnotes.html">PLAINFootnotes</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_plainfootnotes.html">PLAINFootnotes</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_plainfootnotes.html">PLAINFootnotes</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_plainfootnotes.html">PLAINFootnotes</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_plainfootnotes.html">PLAINFootnotes</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_plainfootnotes.html">PLAINFootnotes</a>)<code> [private, static]</code><li><b>PLAINFootnotes</b>() (defined in <a class="el" href="class_plainfootnotes.html">PLAINFootnotes</a>)<li><a class="el" href="class_plainfootnotes.html#a2">ProcessText</a>(char *text, int maxlen=-1, const SWKey *key=0) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_plainfootnotes.html#a5">setOptionValue</a>(const char *ival) +<code> [virtual]</code><li><b>~PLAINFootnotes</b>() (defined in <a class="el" href="class_plainfootnotes.html">PLAINFootnotes</a>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_plainfootnotes.gif b/doc/api-documentation/html/class_plainfootnotes.gif Binary files differnew file mode 100644 index 0000000..4804e41 --- /dev/null +++ b/doc/api-documentation/html/class_plainfootnotes.gif diff --git a/doc/api-documentation/html/class_plainfootnotes.html b/doc/api-documentation/html/class_plainfootnotes.html new file mode 100644 index 0000000..d87fd64 --- /dev/null +++ b/doc/api-documentation/html/class_plainfootnotes.html @@ -0,0 +1,282 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>PLAINFootnotes class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>PLAINFootnotes Class Reference</h1>Shows or hides footnotes in plain text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="plainfootnotes_h-source.html">plainfootnotes.h</a>></code> +<p> +<p>Inheritance diagram for PLAINFootnotes:: +<p><center><img src="class_plainfootnotes.gif" usemap="#PLAINFootnotes_map" border="0"></center> +<map name="PLAINFootnotes_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,103,24"> +</map> +<a href="class_plainfootnotes-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="PLAINFootnotes::PLAINFootnotes"></a> + </td><td valign=bottom><b>PLAINFootnotes</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="PLAINFootnotes::~PLAINFootnotes"></a> +virtual </td><td valign=bottom><b>~PLAINFootnotes</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_plainfootnotes.html#a2">ProcessText</a> (char *text, int maxlen=-1, const <a class="el" href="class_swkey.html">SWKey</a> *key=0)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_plainfootnotes.html#a3">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_plainfootnotes.html#a4">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_plainfootnotes.html#a5">setOptionValue</a> (const char *ival)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_plainfootnotes.html#a7">getOptionValues</a>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="PLAINFootnotes::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_plainfootnotes.html#a7">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="PLAINFootnotes::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="PLAINFootnotes::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="PLAINFootnotes::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="PLAINFootnotes::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="PLAINFootnotes::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="PLAINFootnotes::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Shows or hides footnotes in plain text. +<p> +<dl compact><dt> +<b>Author(s): </b><dd> +The team of BibleTime </dl> +<p> + +<p> +Definition at line <a class="el" href="plainfootnotes_h-source.html#l00033">33</a> of file <a class="el" href="plainfootnotes_h-source.html">plainfootnotes.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="PLAINFootnotes::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char PLAINFootnotes::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em> = -1, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> = 0 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<a name="a3" doxytag="PLAINFootnotes::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * PLAINFootnotes::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a1">SWFilter</a>. +<p> +Definition at line <a class="el" href="plainfootnotes_h-source.html#l00047">47</a> of file <a class="el" href="plainfootnotes_h-source.html">plainfootnotes.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="PLAINFootnotes::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * PLAINFootnotes::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a2">SWFilter</a>. +<p> +Definition at line <a class="el" href="plainfootnotes_h-source.html#l00051">51</a> of file <a class="el" href="plainfootnotes_h-source.html">plainfootnotes.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="PLAINFootnotes::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList PLAINFootnotes::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a3">SWFilter</a>. +<p> +Definition at line <a class="el" href="plainfootnotes_h-source.html#l00057">57</a> of file <a class="el" href="plainfootnotes_h-source.html">plainfootnotes.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="PLAINFootnotes::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual void PLAINFootnotes::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_plainfootnotes.html#a7">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a4">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="plainfootnotes_h-source.html">plainfootnotes.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_plainhtml-members.html b/doc/api-documentation/html/class_plainhtml-members.html new file mode 100644 index 0000000..6808cf3 --- /dev/null +++ b/doc/api-documentation/html/class_plainhtml-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>PLAINHTML Member List</h1>This is the complete list of members for <a class="el" href="class_plainhtml.html">PLAINHTML</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>PLAINHTML</b>() (defined in <a class="el" href="class_plainhtml.html">PLAINHTML</a>)<li><a class="el" href="class_plainhtml.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_plainhtml.gif b/doc/api-documentation/html/class_plainhtml.gif Binary files differnew file mode 100644 index 0000000..147743f --- /dev/null +++ b/doc/api-documentation/html/class_plainhtml.gif diff --git a/doc/api-documentation/html/class_plainhtml.html b/doc/api-documentation/html/class_plainhtml.html new file mode 100644 index 0000000..59310ba --- /dev/null +++ b/doc/api-documentation/html/class_plainhtml.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>PLAINHTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>PLAINHTML Class Reference</h1>this filter converts plain text to HTML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="plainhtml_h-source.html">plainhtml.h</a>></code> +<p> +<p>Inheritance diagram for PLAINHTML:: +<p><center><img src="class_plainhtml.gif" usemap="#PLAINHTML_map" border="0"></center> +<map name="PLAINHTML_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,82,24"> +</map> +<a href="class_plainhtml-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="PLAINHTML::PLAINHTML"></a> + </td><td valign=bottom><b>PLAINHTML</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_plainhtml.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts plain text to HTML text. +<p> + +<p> +Definition at line <a class="el" href="plainhtml_h-source.html#l00031">31</a> of file <a class="el" href="plainhtml_h-source.html">plainhtml.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="PLAINHTML::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char PLAINHTML::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="plainhtml_h-source.html">plainhtml.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_r_t_f_h_t_m_l-members.html b/doc/api-documentation/html/class_r_t_f_h_t_m_l-members.html new file mode 100644 index 0000000..a487229 --- /dev/null +++ b/doc/api-documentation/html/class_r_t_f_h_t_m_l-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RTFHTML Member List</h1>This is the complete list of members for <a class="el" href="class_r_t_f_h_t_m_l.html">RTFHTML</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_r_t_f_h_t_m_l.html">RTFHTML</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>RTFHTML</b>() (defined in <a class="el" href="class_r_t_f_h_t_m_l.html">RTFHTML</a>)<li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_r_t_f_h_t_m_l.gif b/doc/api-documentation/html/class_r_t_f_h_t_m_l.gif Binary files differnew file mode 100644 index 0000000..db5a111 --- /dev/null +++ b/doc/api-documentation/html/class_r_t_f_h_t_m_l.gif diff --git a/doc/api-documentation/html/class_r_t_f_h_t_m_l.html b/doc/api-documentation/html/class_r_t_f_h_t_m_l.html new file mode 100644 index 0000000..30994f7 --- /dev/null +++ b/doc/api-documentation/html/class_r_t_f_h_t_m_l.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>RTFHTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RTFHTML Class Reference</h1>this filter converts RTF text into HTML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="rtfhtml_8h-source.html">rtfhtml.h</a>></code> +<p> +<a href="class_r_t_f_h_t_m_l-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="RTFHTML::RTFHTML"></a> + </td><td valign=bottom><b>RTFHTML</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="RTFHTML::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts RTF text into HTML text. +<p> + +<p> +Definition at line <a class="el" href="rtfhtml_8h-source.html#l00030">30</a> of file <a class="el" href="rtfhtml_8h-source.html">rtfhtml.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="rtfhtml_8h-source.html">rtfhtml.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_r_w_p_h_t_m_l-members.html b/doc/api-documentation/html/class_r_w_p_h_t_m_l-members.html new file mode 100644 index 0000000..ad1d6e6 --- /dev/null +++ b/doc/api-documentation/html/class_r_w_p_h_t_m_l-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RWPHTML Member List</h1>This is the complete list of members for <a class="el" href="class_r_w_p_h_t_m_l.html">RWPHTML</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_r_w_p_h_t_m_l.html">RWPHTML</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>RWPHTML</b>() (defined in <a class="el" href="class_r_w_p_h_t_m_l.html">RWPHTML</a>)<li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_r_w_p_h_t_m_l.gif b/doc/api-documentation/html/class_r_w_p_h_t_m_l.gif Binary files differnew file mode 100644 index 0000000..bc475ac --- /dev/null +++ b/doc/api-documentation/html/class_r_w_p_h_t_m_l.gif diff --git a/doc/api-documentation/html/class_r_w_p_h_t_m_l.html b/doc/api-documentation/html/class_r_w_p_h_t_m_l.html new file mode 100644 index 0000000..c940826 --- /dev/null +++ b/doc/api-documentation/html/class_r_w_p_h_t_m_l.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>RWPHTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RWPHTML Class Reference</h1>this filter converts RWP text to HTML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="rwphtml_8h-source.html">rwphtml.h</a>></code> +<p> +<a href="class_r_w_p_h_t_m_l-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="RWPHTML::RWPHTML"></a> + </td><td valign=bottom><b>RWPHTML</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="RWPHTML::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts RWP text to HTML text. +<p> + +<p> +Definition at line <a class="el" href="rwphtml_8h-source.html#l00031">31</a> of file <a class="el" href="rwphtml_8h-source.html">rwphtml.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="rwphtml_8h-source.html">rwphtml.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_r_w_p_r_t_f-members.html b/doc/api-documentation/html/class_r_w_p_r_t_f-members.html new file mode 100644 index 0000000..6a4f612 --- /dev/null +++ b/doc/api-documentation/html/class_r_w_p_r_t_f-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RWPRTF Member List</h1>This is the complete list of members for <a class="el" href="class_r_w_p_r_t_f.html">RWPRTF</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_r_w_p_r_t_f.html">RWPRTF</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>RWPRTF</b>() (defined in <a class="el" href="class_r_w_p_r_t_f.html">RWPRTF</a>)<li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_r_w_p_r_t_f.gif b/doc/api-documentation/html/class_r_w_p_r_t_f.gif Binary files differnew file mode 100644 index 0000000..347ee26 --- /dev/null +++ b/doc/api-documentation/html/class_r_w_p_r_t_f.gif diff --git a/doc/api-documentation/html/class_r_w_p_r_t_f.html b/doc/api-documentation/html/class_r_w_p_r_t_f.html new file mode 100644 index 0000000..599603b --- /dev/null +++ b/doc/api-documentation/html/class_r_w_p_r_t_f.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>RWPRTF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RWPRTF Class Reference</h1>this filter converts RWP text to RTF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="rwprtf_8h-source.html">rwprtf.h</a>></code> +<p> +<a href="class_r_w_p_r_t_f-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="RWPRTF::RWPRTF"></a> + </td><td valign=bottom><b>RWPRTF</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="RWPRTF::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts RWP text to RTF text. +<p> + +<p> +Definition at line <a class="el" href="rwprtf_8h-source.html#l00033">33</a> of file <a class="el" href="rwprtf_8h-source.html">rwprtf.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="rwprtf_8h-source.html">rwprtf.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_rtfhtml-members.html b/doc/api-documentation/html/class_rtfhtml-members.html new file mode 100644 index 0000000..7f120be --- /dev/null +++ b/doc/api-documentation/html/class_rtfhtml-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RTFHTML Member List</h1>This is the complete list of members for <a class="el" href="class_rtfhtml.html">RTFHTML</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_rtfhtml.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><b>RTFHTML</b>() (defined in <a class="el" href="class_rtfhtml.html">RTFHTML</a>)<li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_rtfhtml.gif b/doc/api-documentation/html/class_rtfhtml.gif Binary files differnew file mode 100644 index 0000000..db5a111 --- /dev/null +++ b/doc/api-documentation/html/class_rtfhtml.gif diff --git a/doc/api-documentation/html/class_rtfhtml.html b/doc/api-documentation/html/class_rtfhtml.html new file mode 100644 index 0000000..3605d39 --- /dev/null +++ b/doc/api-documentation/html/class_rtfhtml.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>RTFHTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RTFHTML Class Reference</h1>this filter converts RTF text into HTML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="rtfhtml_h-source.html">rtfhtml.h</a>></code> +<p> +<p>Inheritance diagram for RTFHTML:: +<p><center><img src="class_rtfhtml.gif" usemap="#RTFHTML_map" border="0"></center> +<map name="RTFHTML_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,69,24"> +</map> +<a href="class_rtfhtml-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="RTFHTML::RTFHTML"></a> + </td><td valign=bottom><b>RTFHTML</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_rtfhtml.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts RTF text into HTML text. +<p> + +<p> +Definition at line <a class="el" href="rtfhtml_h-source.html#l00030">30</a> of file <a class="el" href="rtfhtml_h-source.html">rtfhtml.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="RTFHTML::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char RTFHTML::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="rtfhtml_h-source.html">rtfhtml.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_rwphtml-members.html b/doc/api-documentation/html/class_rwphtml-members.html new file mode 100644 index 0000000..8a3b91c --- /dev/null +++ b/doc/api-documentation/html/class_rwphtml-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RWPHTML Member List</h1>This is the complete list of members for <a class="el" href="class_rwphtml.html">RWPHTML</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_rwphtml.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><b>RWPHTML</b>() (defined in <a class="el" href="class_rwphtml.html">RWPHTML</a>)<li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_rwphtml.gif b/doc/api-documentation/html/class_rwphtml.gif Binary files differnew file mode 100644 index 0000000..bc475ac --- /dev/null +++ b/doc/api-documentation/html/class_rwphtml.gif diff --git a/doc/api-documentation/html/class_rwphtml.html b/doc/api-documentation/html/class_rwphtml.html new file mode 100644 index 0000000..0732b00 --- /dev/null +++ b/doc/api-documentation/html/class_rwphtml.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>RWPHTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RWPHTML Class Reference</h1>this filter converts RWP text to HTML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="rwphtml_h-source.html">rwphtml.h</a>></code> +<p> +<p>Inheritance diagram for RWPHTML:: +<p><center><img src="class_rwphtml.gif" usemap="#RWPHTML_map" border="0"></center> +<map name="RWPHTML_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,73,24"> +</map> +<a href="class_rwphtml-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="RWPHTML::RWPHTML"></a> + </td><td valign=bottom><b>RWPHTML</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_rwphtml.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts RWP text to HTML text. +<p> + +<p> +Definition at line <a class="el" href="rwphtml_h-source.html#l00031">31</a> of file <a class="el" href="rwphtml_h-source.html">rwphtml.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="RWPHTML::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char RWPHTML::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="rwphtml_h-source.html">rwphtml.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:35 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_rwprtf-members.html b/doc/api-documentation/html/class_rwprtf-members.html new file mode 100644 index 0000000..b3309aa --- /dev/null +++ b/doc/api-documentation/html/class_rwprtf-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RWPRTF Member List</h1>This is the complete list of members for <a class="el" href="class_rwprtf.html">RWPRTF</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_rwprtf.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><b>RWPRTF</b>() (defined in <a class="el" href="class_rwprtf.html">RWPRTF</a>)<li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_rwprtf.gif b/doc/api-documentation/html/class_rwprtf.gif Binary files differnew file mode 100644 index 0000000..347ee26 --- /dev/null +++ b/doc/api-documentation/html/class_rwprtf.gif diff --git a/doc/api-documentation/html/class_rwprtf.html b/doc/api-documentation/html/class_rwprtf.html new file mode 100644 index 0000000..26a0b31 --- /dev/null +++ b/doc/api-documentation/html/class_rwprtf.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>RWPRTF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>RWPRTF Class Reference</h1>this filter converts RWP text to RTF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="rwprtf_h-source.html">rwprtf.h</a>></code> +<p> +<p>Inheritance diagram for RWPRTF:: +<p><center><img src="class_rwprtf.gif" usemap="#RWPRTF_map" border="0"></center> +<map name="RWPRTF_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,62,24"> +</map> +<a href="class_rwprtf-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="RWPRTF::RWPRTF"></a> + </td><td valign=bottom><b>RWPRTF</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_rwprtf.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts RWP text to RTF text. +<p> + +<p> +Definition at line <a class="el" href="rwprtf_h-source.html#l00033">33</a> of file <a class="el" href="rwprtf_h-source.html">rwprtf.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="RWPRTF::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char RWPRTF::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="rwprtf_h-source.html">rwprtf.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_c_s_u_u_t_f8-members.html b/doc/api-documentation/html/class_s_c_s_u_u_t_f8-members.html new file mode 100644 index 0000000..03cd911 --- /dev/null +++ b/doc/api-documentation/html/class_s_c_s_u_u_t_f8-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SCSUUTF8 Member List</h1>This is the complete list of members for <a class="el" href="class_s_c_s_u_u_t_f8.html">SCSUUTF8</a>, including all inherited members.<ul> +<li><b>c</b> (defined in <a class="el" href="class_s_c_s_u_u_t_f8.html">SCSUUTF8</a>)<code> [private]</code><li><b>d</b> (defined in <a class="el" href="class_s_c_s_u_u_t_f8.html">SCSUUTF8</a>)<code> [private]</code><li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_s_c_s_u_u_t_f8.html">SCSUUTF8</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>SCSUUTF8</b>() (defined in <a class="el" href="class_s_c_s_u_u_t_f8.html">SCSUUTF8</a>)<li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>UTF8Output</b>(unsigned long, unsigned char *text) (defined in <a class="el" href="class_s_c_s_u_u_t_f8.html">SCSUUTF8</a>)<code> [private]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_c_s_u_u_t_f8.gif b/doc/api-documentation/html/class_s_c_s_u_u_t_f8.gif Binary files differnew file mode 100644 index 0000000..db2a474 --- /dev/null +++ b/doc/api-documentation/html/class_s_c_s_u_u_t_f8.gif diff --git a/doc/api-documentation/html/class_s_c_s_u_u_t_f8.html b/doc/api-documentation/html/class_s_c_s_u_u_t_f8.html new file mode 100644 index 0000000..833e90b --- /dev/null +++ b/doc/api-documentation/html/class_s_c_s_u_u_t_f8.html @@ -0,0 +1,42 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SCSUUTF8 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SCSUUTF8 Class Reference</h1>This filter converts SCSU compressed (encoded) text to UTF-8. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="scsuutf8_8h-source.html">scsuutf8.h</a>></code> +<p> +<a href="class_s_c_s_u_u_t_f8-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SCSUUTF8::SCSUUTF8"></a> + </td><td valign=bottom><b>SCSUUTF8</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SCSUUTF8::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="SCSUUTF8::UTF8Output"></a> +unsigned char * </td><td valign=bottom><b>UTF8Output</b> (unsigned long, unsigned char *text)</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="SCSUUTF8::c"></a> +unsigned long </td><td valign=bottom><b>c</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="SCSUUTF8::d"></a> +unsigned long </td><td valign=bottom><b>d</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts SCSU compressed (encoded) text to UTF-8. +<p> + +<p> +Definition at line <a class="el" href="scsuutf8_8h-source.html#l00029">29</a> of file <a class="el" href="scsuutf8_8h-source.html">scsuutf8.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="scsuutf8_8h-source.html">scsuutf8.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_class-members.html b/doc/api-documentation/html/class_s_w_class-members.html new file mode 100644 index 0000000..9205656 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_class-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWClass Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_class.html">SWClass</a>, including all inherited members.<ul> +<li><b>descends</b> (defined in <a class="el" href="class_s_w_class.html">SWClass</a>)<code> [private]</code><li><b>isAssignableFrom</b>(const char *className) const (defined in <a class="el" href="class_s_w_class.html">SWClass</a>)<code> [inline]</code><li><b>SWClass</b>(const char **descends) (defined in <a class="el" href="class_s_w_class.html">SWClass</a>)<code> [inline]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_class.html b/doc/api-documentation/html/class_s_w_class.html new file mode 100644 index 0000000..658b126 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_class.html @@ -0,0 +1,37 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWClass class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWClass Class Reference</h1>Class used for SWDYNAMIC_CAST to save the inheritance order. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swobject_8h-source.html">swobject.h</a>></code> +<p> +<a href="class_s_w_class-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SWClass::SWClass"></a> + </td><td valign=bottom><b>SWClass</b> (const char **descends)</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWClass::isAssignableFrom"></a> +bool </td><td valign=bottom><b>isAssignableFrom</b> (const char *className) const</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="SWClass::descends"></a> +const char ** </td><td valign=bottom><b>descends</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Class used for SWDYNAMIC_CAST to save the inheritance order. +<p> + +<p> +Definition at line <a class="el" href="swobject_8h-source.html#l00018">18</a> of file <a class="el" href="swobject_8h-source.html">swobject.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swobject_8h-source.html">swobject.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_com-members.html b/doc/api-documentation/html/class_s_w_com-members.html new file mode 100644 index 0000000..024ad67 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_com-members.html @@ -0,0 +1,83 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWCom Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_com.html">SWCom</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_module.html#a42">AddEncodingFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a51">AddOptionFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a48">AddRawFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a38">AddRenderFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a46">AddStripFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_com.html#a2">CreateKey</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#d1">createModule</a>(const char *) +<code> [inline, static]</code><li><b>createSearchFramework</b>() (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a32">deleteEntry</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a13">Description</a>(const char *imoddesc=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a15">Direction</a>(signed char newdir=-1) +<code> [virtual]</code><li><b>direction</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#n10">disp</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a11">Disp</a>(SWDisplay *idisp=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a10">Display</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a16">Encoding</a>(signed char enc=-1) +<code> [virtual]</code><li><b>encoding</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a45">encodingFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n16">encodingFilters</a> +<code> [protected]</code><li><b>entrybuf</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>entrySize</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a2">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a49">filterBuffer</a>(FilterList *filters, char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a4">getEntrySize</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a25">getRawEntry</a>()=0 +<code> [pure virtual]</code><li><b>hasSearchFramework</b>() (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a22">isSearchOptimallySupported</a>(const char *istr, int searchType, int flags, SWKey *scope) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a3">isUnicode</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a28">isWritable</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a7">Key</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a8">Key</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n1">key</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a9">KeyText</a>(const char *imodtype=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a18">Lang</a>(const char *imodlang=0) +<code> [virtual]</code><li><b>listkey</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a17">Markup</a>(signed char enc=-1) +<code> [virtual]</code><li><b>markup</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>moddesc</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modlang</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modname</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modtype</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a12">Name</a>(const char *imodname=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#d0">nullPercent</a>(char percent, void *userData) +<code> [static]</code><li><a class="el" href="class_s_w_module.html#a24">operator char *</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a26">operator SWKey &</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a27">operator SWKey *</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a35">operator++</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a34">operator+=</a>(int increment) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a36">operator--</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a33">operator-=</a>(int decrement) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a30">operator<<</a>(const char *) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a31">operator<<</a>(const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a37">operator=</a>(SW_POSITION p) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a52">optionFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n15">optionFilters</a> +<code> [protected]</code><li><b>rawdisp</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected, static]</code><li><a class="el" href="class_s_w_module.html#a50">rawFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n13">rawFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a43">RemoveEncodingFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a39">RemoveRenderFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><b>render</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a41">renderFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n14">renderFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a54">RenderText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a56">RenderText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a44">ReplaceEncodingFilter</a>(SWFilter *oldfilter, SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a40">ReplaceRenderFilter</a>(SWFilter *oldfilter, SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a19">Search</a>(const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a29">setentry</a>(const char *inbuf, long len) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a5">SetKey</a>(const SWKey *ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a6">SetKey</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a47">stripFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n12">stripFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a53">StripText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a55">StripText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_s_w_com.html#a0">SWCom</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, SWTextEncoding enc=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup mark=FMT_UNKNOWN, const char *ilang=0) +<li><a class="el" href="class_s_w_module.html#a0">SWModule</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char *imodtype=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *modlang=0) +<li><a class="el" href="class_s_w_module.html#m0">terminateSearch</a> +<li><a class="el" href="class_s_w_module.html#a14">Type</a>(const char *imodtype=0) +<code> [virtual]</code><li><b>~SWCom</b>() (defined in <a class="el" href="class_s_w_com.html">SWCom</a>)<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a1">~SWModule</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_com.gif b/doc/api-documentation/html/class_s_w_com.gif Binary files differnew file mode 100644 index 0000000..a8cee96 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_com.gif diff --git a/doc/api-documentation/html/class_s_w_com.html b/doc/api-documentation/html/class_s_w_com.html new file mode 100644 index 0000000..e67ec30 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_com.html @@ -0,0 +1,186 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWCom class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWCom Class Reference</h1>The basis for all commentary modules. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swcom_8h-source.html">swcom.h</a>></code> +<p> +<p>Inheritance diagram for SWCom:: +<p><center><img src="class_s_w_com.gif" usemap="#SWCom_map" border="0"></center> +<map name="SWCom_map"> +<area href="class_s_w_module.html" alt="SWModule" shape="rect" coords="0,0,73,24"> +</map> +<a href="class_s_w_com-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_com.html#a0">SWCom</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_s_w_display.html">SWDisplay</a> *idisp=0, SWTextEncoding enc=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup mark=FMT_UNKNOWN, const char *ilang=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Initializes data for instance of SWCom.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWCom::~SWCom"></a> +virtual </td><td valign=bottom><b>~SWCom</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_s_w_com.html#a2">CreateKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Allocates a key of specific type for module The different reimplementatiosn of <a class="el" href="class_s_w_module.html">SWModule</a> (e.g.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The basis for all commentary modules. +<p> + +<p> +Definition at line <a class="el" href="swcom_8h-source.html#l00033">33</a> of file <a class="el" href="swcom_8h-source.html">swcom.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWCom::SWCom"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWCom::SWCom + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>imodname</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>imoddesc</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_display.html">SWDisplay</a> * </td> + <td class="mdname"> <em>idisp</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextEncoding </td> + <td class="mdname"> <em>enc</em> = ENC_UNKNOWN, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextDirection </td> + <td class="mdname"> <em>dir</em> = DIRECTION_LTR, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextMarkup </td> + <td class="mdname"> <em>mark</em> = FMT_UNKNOWN, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>ilang</em> = 0 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initializes data for instance of SWCom. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodname +</em> </td><td> +Internal name for module </td></tr> +<tr><td valign=top><em>imoddesc +</em> </td><td> +Name to display to user for module </td></tr> +<tr><td valign=top><em>idisp +</em> </td><td> +Display object to use for displaying </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="SWCom::CreateKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual <a class="el" href="class_s_w_key.html">SWKey</a>* SWCom::CreateKey + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Allocates a key of specific type for module The different reimplementatiosn of <a class="el" href="class_s_w_module.html">SWModule</a> (e.g. +<p> +<a class="el" href="class_s_w_text.html">SWText</a>) support <a class="el" href="class_s_w_key.html">SWKey</a> implementations, which support special. This functions returns a <a class="el" href="class_s_w_key.html">SWKey</a> object which works with the current implementation of <a class="el" href="class_s_w_module.html">SWModule</a>. For example for the <a class="el" href="class_s_w_text.html">SWText</a> class it returns a <a class="el" href="class_verse_key.html">VerseKey</a> object. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_verse_key.html">VerseKey</a>, <a class="el" href="class_list_key.html">ListKey</a>, <a class="el" href="class_s_w_text.html">SWText</a>, <a class="el" href="class_s_w_l_d.html">SWLD</a>, SWCom </dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to allocated key </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_module.html#a23">SWModule</a>. +<p> +Definition at line <a class="el" href="swcom_8h-source.html#l00044">44</a> of file <a class="el" href="swcom_8h-source.html">swcom.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swcom_8h-source.html">swcom.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_config-members.html b/doc/api-documentation/html/class_s_w_config-members.html new file mode 100644 index 0000000..fe05df9 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_config-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWConfig Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_config.html">SWConfig</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_config.html#m0">filename</a> +<li><b>getline</b>(FILE *fp, string &line) (defined in <a class="el" href="class_s_w_config.html">SWConfig</a>)<code> [private]</code><li><a class="el" href="class_s_w_config.html#a2">Load</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_config.html#a4">operator+=</a>(SWConfig &addFrom) +<code> [virtual]</code><li><a class="el" href="class_s_w_config.html#a5">operator[]</a>(const char *section) +<code> [virtual]</code><li><a class="el" href="class_s_w_config.html#a3">Save</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_config.html#m1">Sections</a> +<li><a class="el" href="class_s_w_config.html#a0">SWConfig</a>(const char *ifilename) +<li><b>~SWConfig</b>() (defined in <a class="el" href="class_s_w_config.html">SWConfig</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_config.html b/doc/api-documentation/html/class_s_w_config.html new file mode 100644 index 0000000..2284e58 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_config.html @@ -0,0 +1,173 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWConfig class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWConfig Class Reference</h1>The class to read and save settings using a file on disk. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swconfig_8h-source.html">swconfig.h</a>></code> +<p> +<a href="class_s_w_config-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_config.html#a0">SWConfig</a> (const char *ifilename)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor of SWConfig.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWConfig::~SWConfig"></a> +virtual </td><td valign=bottom><b>~SWConfig</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="SWConfig::Load"></a> +virtual void </td><td valign=bottom><a class="el" href="class_s_w_config.html#a2">Load</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Load from disk Load the contzent from disk.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="SWConfig::Save"></a> +virtual void </td><td valign=bottom><a class="el" href="class_s_w_config.html#a3">Save</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Save to disk Save the content of this config object to disk.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWConfig & </td><td valign=bottom><a class="el" href="class_s_w_config.html#a4">operator+=</a> (SWConfig &addFrom)</td></tr> +<tr><td> </td><td><font size=-1><em>Merges the values of addFrom.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual ConfigEntMap & </td><td valign=bottom><a class="el" href="class_s_w_config.html#a5">operator[]</a> (const char *section)</td></tr> +<tr><td> </td><td><font size=-1><em>Get a section This is an easy way to get and store config values.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="m0" doxytag="SWConfig::filename"></a> +string </td><td valign=bottom><a class="el" href="class_s_w_config.html#m0">filename</a></td></tr> +<tr><td> </td><td><font size=-1><em>The filename used by this SWConfig object.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="m1" doxytag="SWConfig::Sections"></a> +SectionMap </td><td valign=bottom><a class="el" href="class_s_w_config.html#m1">Sections</a></td></tr> +<tr><td> </td><td><font size=-1><em>Map of available sections The map of available sections.</em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="SWConfig::getline"></a> +char </td><td valign=bottom><b>getline</b> (FILE *fp, string &line)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The class to read and save settings using a file on disk. +<p> + +<p> +Definition at line <a class="el" href="swconfig_8h-source.html#l00056">56</a> of file <a class="el" href="swconfig_8h-source.html">swconfig.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWConfig::SWConfig"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWConfig::SWConfig + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ifilename</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor of SWConfig. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ifilename +</em> </td><td> +The file, which should be used for this config. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="SWConfig::operator+="></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWConfig& SWConfig::operator+= + </td> + <td class="md">( </td> + <td class="md">SWConfig & </td> + <td class="mdname"> <em>addFrom</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Merges the values of addFrom. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>The +</em> </td><td> +config which values should be merged to this config object. Already existing values will be overwritten. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a5" doxytag="SWConfig::operator[]"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual ConfigEntMap& SWConfig::operator[] + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>section</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get a section This is an easy way to get and store config values. +<p> +The following will work:<br> + +<p> +<div class="fragment"><pre> <a class="code" href="class_s_w_config.html">SWConfig</a> config(<font class="stringliteral">"/home/user/.setttings"</font>); + config[<font class="stringliteral">"Colors"</font>][<font class="stringliteral">"Background"</font>] = <font class="stringliteral">"red"</font>;</pre></div> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swconfig_8h-source.html">swconfig.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_display-members.html b/doc/api-documentation/html/class_s_w_display-members.html new file mode 100644 index 0000000..73df2dd --- /dev/null +++ b/doc/api-documentation/html/class_s_w_display-members.html @@ -0,0 +1,18 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWDisplay Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_display.html">SWDisplay</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_display.html#a1">Display</a>(SWModule &imodule) +<code> [virtual]</code><li><b>SWDisplay</b>() (defined in <a class="el" href="class_s_w_display.html">SWDisplay</a>)<code> [inline]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_display.html b/doc/api-documentation/html/class_s_w_display.html new file mode 100644 index 0000000..e91943b --- /dev/null +++ b/doc/api-documentation/html/class_s_w_display.html @@ -0,0 +1,79 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWDisplay class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWDisplay Class Reference</h1>swdisp is the basis for all types of displays (e.g. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swdisp_8h-source.html">swdisp.h</a>></code> +<p> +<a href="class_s_w_display-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SWDisplay::SWDisplay"></a> + </td><td valign=bottom><b>SWDisplay</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_display.html#a1">Display</a> (<a class="el" href="class_s_w_module.html">SWModule</a> &imodule)</td></tr> +<tr><td> </td><td><font size=-1><em>casts a module to a character pointer and displays it to raw output (overriden for different display types and module types if necessary).</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +swdisp is the basis for all types of displays (e.g. +<p> +raw textout, curses, xwindow, etc.) +<p> + +<p> +Definition at line <a class="el" href="swdisp_8h-source.html#l00033">33</a> of file <a class="el" href="swdisp_8h-source.html">swdisp.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="SWDisplay::Display"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWDisplay::Display + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> & </td> + <td class="mdname"> <em>imodule</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +casts a module to a character pointer and displays it to raw output (overriden for different display types and module types if necessary). +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodule +</em> </td><td> +module to display </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +error status </dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swdisp_8h-source.html">swdisp.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_encoding_mgr-members.html b/doc/api-documentation/html/class_s_w_encoding_mgr-members.html new file mode 100644 index 0000000..1cd5089 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_encoding_mgr-members.html @@ -0,0 +1,38 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWEncodingMgr Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_encoding_mgr.html#a4">AddEncodingFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [virtual]</code><li><b>AddGlobalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><b>AddLocalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><b>AddModToConfig</b>(int conffd, const char *fname) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_s_w_encoding_mgr.html#a3">AddRawFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#b9">AddRenderFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [protected, virtual]</code><li><a class="el" href="class_s_w_mgr.html#b10">AddStripFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [protected, virtual]</code><li><b>cipherFilters</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>cleanupFilters</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#m0">config</a> +<li><b>configPath</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<li><b>configType</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>CreateMod</b>(string name, string driver, ConfigEntMap &section) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>CreateMods</b>() (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#p0">debug</a> +<code> [static]</code><li><b>DeleteMods</b>() (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>encoding</b> (defined in <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_encoding_mgr.html#a2">Encoding</a>(char enc) +<li><b>findConfig</b>(char *configType, char **prefixPath, char **configPath) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [static]</code><li><b>gbfplain</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#a6">getGlobalOption</a>(const char *option) +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a8">getGlobalOptions</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a7">getGlobalOptionTip</a>(const char *option) +<code> [virtual]</code><li><b>getGlobalOptionValues</b>(const char *option) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [virtual]</code><li><b>init</b>() (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_s_w_mgr.html#a3">InstallScan</a>(const char *dir) +<code> [virtual]</code><li><b>latin1utf8</b> (defined in <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#a4">Load</a>() +<code> [virtual]</code><li><b>loadConfigDir</b>(const char *ipath) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_s_w_mgr.html#m2">Modules</a> +<li><b>myconfig</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>mysysconfig</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>optionFilters</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>options</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#m3">prefixPath</a> +<li><b>scsuutf8</b> (defined in <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#a10">setCipherKey</a>(const char *modName, const char *key) +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a5">setGlobalOption</a>(const char *option, const char *value) +<code> [virtual]</code><li><a class="el" href="class_s_w_encoding_mgr.html#a0">SWEncodingMgr</a>(SWConfig *iconfig=0, SWConfig *isysconfig=0, bool autoload=true, char encoding=ENC_UTF8) +<li><a class="el" href="class_s_w_mgr.html#a0">SWMgr</a>(SWConfig *iconfig=0, SWConfig *isysconfig=0, bool autoload=true) +<li><b>SWMgr</b>(const char *iConfigPath, bool autoload=true) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<li><b>sysconfig</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<li><b>targetenc</b> (defined in <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>)<code> [protected]</code><li><b>thmlplain</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#a11">Version</a>() const +<code> [inline]</code><li><a class="el" href="class_s_w_encoding_mgr.html#a1">~SWEncodingMgr</a>() +<li><a class="el" href="class_s_w_mgr.html#a2">~SWMgr</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Oct 30 16:04:53 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_encoding_mgr.gif b/doc/api-documentation/html/class_s_w_encoding_mgr.gif Binary files differnew file mode 100644 index 0000000..485b763 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_encoding_mgr.gif diff --git a/doc/api-documentation/html/class_s_w_encoding_mgr.html b/doc/api-documentation/html/class_s_w_encoding_mgr.html new file mode 100644 index 0000000..257a0dc --- /dev/null +++ b/doc/api-documentation/html/class_s_w_encoding_mgr.html @@ -0,0 +1,293 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWEncodingMgr class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWEncodingMgr Class Reference</h1>This class is like a normal <a class="el" href="class_s_w_mgr.html">SWMgr</a>, but you can additonally specify which encoding you want to use. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swencodingmgr_8h-source.html">swencodingmgr.h</a>></code> +<p> +<p>Inheritance diagram for SWEncodingMgr:: +<p><center><img src="class_s_w_encoding_mgr.gif" usemap="#SWEncodingMgr_map" border="0"></center> +<map name="SWEncodingMgr_map"> +<area href="class_s_w_mgr.html" alt="SWMgr" shape="rect" coords="0,0,107,24"> +<area href="class_s_w_markup_mgr.html" alt="SWMarkupMgr" shape="rect" coords="0,112,107,136"> +</map> +<a href="class_s_w_encoding_mgr-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_encoding_mgr.html#a0">SWEncodingMgr</a> (<a class="el" href="class_s_w_config.html">SWConfig</a> *iconfig=0, <a class="el" href="class_s_w_config.html">SWConfig</a> *isysconfig=0, bool autoload=true, char encoding=ENC_UTF8)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor of SWEncodingMgr.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWEncodingMgr::~SWEncodingMgr"></a> + </td><td valign=bottom><a class="el" href="class_s_w_encoding_mgr.html#a1">~SWEncodingMgr</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>The destructor of SWEncodingMgr.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="class_s_w_encoding_mgr.html#a2">Encoding</a> (char enc)</td></tr> +<tr><td> </td><td><font size=-1><em>Markup sets/gets the encoding after initialization.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_encoding_mgr.html#a3">AddRawFilters</a> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the raw filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module".</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_encoding_mgr.html#a4">AddEncodingFilters</a> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the encoding filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module".</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWEncodingMgr::latin1utf8"></a> +<a class="el" href="class_s_w_filter.html">SWFilter</a> * </td><td valign=bottom><b>latin1utf8</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWEncodingMgr::scsuutf8"></a> +<a class="el" href="class_s_w_filter.html">SWFilter</a> * </td><td valign=bottom><b>scsuutf8</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWEncodingMgr::targetenc"></a> +<a class="el" href="class_s_w_filter.html">SWFilter</a> * </td><td valign=bottom><b>targetenc</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n3" doxytag="SWEncodingMgr::encoding"></a> +char </td><td valign=bottom><b>encoding</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class is like a normal <a class="el" href="class_s_w_mgr.html">SWMgr</a>, but you can additonally specify which encoding you want to use. +<p> + +<p> +Definition at line <a class="el" href="swencodingmgr_8h-source.html#l00031">31</a> of file <a class="el" href="swencodingmgr_8h-source.html">swencodingmgr.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWEncodingMgr::SWEncodingMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWEncodingMgr::SWEncodingMgr + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_config.html">SWConfig</a> * </td> + <td class="mdname"> <em>iconfig</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_config.html">SWConfig</a> * </td> + <td class="mdname"> <em>isysconfig</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">bool </td> + <td class="mdname"> <em>autoload</em> = true, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">char </td> + <td class="mdname"> <em>encoding</em> = ENC_UTF8 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor of SWEncodingMgr. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iconfig +</em> </td><td> +</td></tr> +<tr><td valign=top><em>isysconfig +</em> </td><td> +</td></tr> +<tr><td valign=top><em>autoload +</em> </td><td> +If this bool is true the constructor starts loading the installed modules. If you reimplemented <a class="el" href="class_s_w_mgr.html">SWMgr</a> you can set autoload=false to load the modules with your own reimplemented function. </td></tr> +<tr><td valign=top><em>encoding +</em> </td><td> +The desired encoding. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="SWEncodingMgr::AddEncodingFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWEncodingMgr::AddEncodingFilters + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> * </td> + <td class="mdname"> <em>module</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">ConfigEntMap & </td> + <td class="mdname"> <em>section</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the encoding filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module +</em> </td><td> +To this module the encoding filter(s) are added </td></tr> +<tr><td valign=top><em>section +</em> </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_s_w_mgr.html#b8">SWMgr</a>. </td> + </tr> +</table> +<a name="a3" doxytag="SWEncodingMgr::AddRawFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWEncodingMgr::AddRawFilters + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> * </td> + <td class="mdname"> <em>module</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">ConfigEntMap & </td> + <td class="mdname"> <em>section</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the raw filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module +</em> </td><td> +To this module the raw filter(s) are added </td></tr> +<tr><td valign=top><em>section +</em> </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_s_w_mgr.html#b11">SWMgr</a>. </td> + </tr> +</table> +<a name="a2" doxytag="SWEncodingMgr::Encoding"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +char SWEncodingMgr::Encoding + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>enc</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Markup sets/gets the encoding after initialization. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>m +</em> </td><td> +The new encoding or ENC_UNKNOWN if you just want to get the current markup. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +The current (possibly changed) encoding format. </dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swencodingmgr_8h-source.html">swencodingmgr.h</a></ul> +<hr><address><small>Generated at Tue Oct 30 16:04:52 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_filter-members.html b/doc/api-documentation/html/class_s_w_filter-members.html new file mode 100644 index 0000000..9d74b8b --- /dev/null +++ b/doc/api-documentation/html/class_s_w_filter-members.html @@ -0,0 +1,23 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWFilter Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_filter.html">SWFilter</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_filter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_filter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_s_w_filter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_s_w_filter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_filter.html#a6">ProcessText</a>(char *text, int maxlen, const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_filter.html#a7">ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_filter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_s_w_filter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Wed Dec 5 22:22:01 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_filter.gif b/doc/api-documentation/html/class_s_w_filter.gif Binary files differnew file mode 100644 index 0000000..8614453 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_filter.gif diff --git a/doc/api-documentation/html/class_s_w_filter.html b/doc/api-documentation/html/class_s_w_filter.html new file mode 100644 index 0000000..4e3aad3 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_filter.html @@ -0,0 +1,382 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWFilter class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWFilter Class Reference</h1>Base class for all filters in sword. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swfilter_8h-source.html">swfilter.h</a>></code> +<p> +<p>Inheritance diagram for SWFilter:: +<p><center><img src="class_s_w_filter.gif" usemap="#SWFilter_map" border="0"></center> +<map name="SWFilter_map"> +<area href="class_g_b_f_footnotes.html" alt="GBFFootnotes" shape="rect" coords="132,56,254,80"> +<area href="class_g_b_f_headings.html" alt="GBFHeadings" shape="rect" coords="132,112,254,136"> +<area href="class_g_b_f_h_t_m_l.html" alt="GBFHTML" shape="rect" coords="132,168,254,192"> +<area href="class_g_b_f_morph.html" alt="GBFMorph" shape="rect" coords="132,224,254,248"> +<area href="class_g_b_f_plain.html" alt="GBFPlain" shape="rect" coords="132,280,254,304"> +<area href="class_g_b_f_r_t_f.html" alt="GBFRTF" shape="rect" coords="132,336,254,360"> +<area href="class_g_b_f_strongs.html" alt="GBFStrongs" shape="rect" coords="132,392,254,416"> +<area href="class_g_b_f_th_m_l.html" alt="GBFThML" shape="rect" coords="132,448,254,472"> +<area href="class_latin1_u_t_f16.html" alt="Latin1UTF16" shape="rect" coords="132,504,254,528"> +<area href="class_latin1_u_t_f8.html" alt="Latin1UTF8" shape="rect" coords="132,560,254,584"> +<area href="class_p_l_a_i_n_footnotes.html" alt="PLAINFootnotes" shape="rect" coords="132,616,254,640"> +<area href="class_p_l_a_i_n_h_t_m_l.html" alt="PLAINHTML" shape="rect" coords="132,672,254,696"> +<area href="class_r_t_f_h_t_m_l.html" alt="RTFHTML" shape="rect" coords="132,728,254,752"> +<area href="class_r_w_p_h_t_m_l.html" alt="RWPHTML" shape="rect" coords="132,784,254,808"> +<area href="class_r_w_p_r_t_f.html" alt="RWPRTF" shape="rect" coords="132,840,254,864"> +<area href="class_s_c_s_u_u_t_f8.html" alt="SCSUUTF8" shape="rect" coords="132,896,254,920"> +<area href="class_th_m_l_footnotes.html" alt="ThMLFootnotes" shape="rect" coords="132,952,254,976"> +<area href="class_th_m_l_g_b_f.html" alt="ThMLGBF" shape="rect" coords="132,1008,254,1032"> +<area href="class_th_m_l_headings.html" alt="ThMLHeadings" shape="rect" coords="132,1064,254,1088"> +<area href="class_th_m_l_lemma.html" alt="ThMLLemma" shape="rect" coords="132,1120,254,1144"> +<area href="class_th_m_l_morph.html" alt="ThMLMorph" shape="rect" coords="132,1176,254,1200"> +<area href="class_th_m_l_o_l_b.html" alt="ThMLOLB" shape="rect" coords="132,1232,254,1256"> +<area href="class_th_m_l_plain.html" alt="ThMLPlain" shape="rect" coords="132,1288,254,1312"> +<area href="class_th_m_l_scripref.html" alt="ThMLScripref" shape="rect" coords="132,1344,254,1368"> +<area href="class_th_m_l_strongs.html" alt="ThMLStrongs" shape="rect" coords="132,1400,254,1424"> +<area href="class_unicode_r_t_f.html" alt="UnicodeRTF" shape="rect" coords="132,1456,254,1480"> +<area href="class_u_t_f16_u_t_f8.html" alt="UTF16UTF8" shape="rect" coords="132,1512,254,1536"> +<area href="class_u_t_f8_cantillation.html" alt="UTF8Cantillation" shape="rect" coords="132,1568,254,1592"> +<area href="class_u_t_f8_greek_accents.html" alt="UTF8GreekAccents" shape="rect" coords="132,1624,254,1648"> +<area href="class_u_t_f8_hebrew_points.html" alt="UTF8HebrewPoints" shape="rect" coords="132,1680,254,1704"> +<area href="class_u_t_f8_h_t_m_l.html" alt="UTF8HTML" shape="rect" coords="132,1736,254,1760"> +<area href="class_u_t_f8_latin1.html" alt="UTF8Latin1" shape="rect" coords="132,1792,254,1816"> +<area href="class_u_t_f8_u_t_f16.html" alt="UTF8UTF16" shape="rect" coords="132,1848,254,1872"> +</map> +<a href="class_s_w_filter-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SWFilter::~SWFilter"></a> +virtual </td><td valign=bottom><b>~SWFilter</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_filter.html#a1">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_filter.html#a2">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_s_w_filter.html#a3">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_filter.html#a4">setOptionValue</a> (const char *)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_s_w_filter.html#a3">getOptionValues</a>.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="SWFilter::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_filter.html#a6">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_filter.html#a7">ProcessText</a> (char *text, int maxlen=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function without the 3rd parameter.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Base class for all filters in sword. +<p> +Filters are used to filter/convert text between different formats like GBF, HTML, RTF ... +<p> + +<p> +Definition at line <a class="el" href="swfilter_8h-source.html#l00041">41</a> of file <a class="el" href="swfilter_8h-source.html">swfilter.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a7" doxytag="SWFilter::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWFilter::ProcessText + </td> + <td class="md">( </td> + <td class="md">char * </td> + <td class="mdname"> <em>text</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">int </td> + <td class="mdname"> <em>maxlen</em> = -1 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function without the 3rd parameter. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text +</em> </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen +</em> </td><td> +maximal length of text to be processed </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented in <a class="el" href="class_g_b_f_th_m_l.html#a1">GBFThML</a>, <a class="el" href="class_th_m_l_g_b_f.html#a1">ThMLGBF</a>, <a class="el" href="class_th_m_l_o_l_b.html#a1">ThMLOLB</a>, and <a class="el" href="class_th_m_l_plain.html#a1">ThMLPlain</a>. +<p> +Definition at line <a class="el" href="swfilter_8h-source.html#l00100">100</a> of file <a class="el" href="swfilter_8h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a6" doxytag="SWFilter::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWFilter::ProcessText + </td> + <td class="md">( </td> + <td class="md">char * </td> + <td class="mdname"> <em>text</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">int </td> + <td class="mdname"> <em>maxlen</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>key</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text +</em> </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen +</em> </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key +</em> </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented in <a class="el" href="class_g_b_f_footnotes.html#a2">GBFFootnotes</a>, <a class="el" href="class_g_b_f_headings.html#a2">GBFHeadings</a>, <a class="el" href="class_g_b_f_h_t_m_l.html#a1">GBFHTML</a>, <a class="el" href="class_g_b_f_morph.html#a2">GBFMorph</a>, <a class="el" href="class_g_b_f_plain.html#a1">GBFPlain</a>, <a class="el" href="class_g_b_f_r_t_f.html#a1">GBFRTF</a>, <a class="el" href="class_g_b_f_strongs.html#a2">GBFStrongs</a>, <a class="el" href="class_latin1_u_t_f16.html#a1">Latin1UTF16</a>, <a class="el" href="class_latin1_u_t_f8.html#a1">Latin1UTF8</a>, <a class="el" href="class_p_l_a_i_n_footnotes.html#a2">PLAINFootnotes</a>, <a class="el" href="class_p_l_a_i_n_h_t_m_l.html#a1">PLAINHTML</a>, <a class="el" href="class_r_t_f_h_t_m_l.html#a1">RTFHTML</a>, <a class="el" href="class_r_w_p_h_t_m_l.html#a1">RWPHTML</a>, <a class="el" href="class_r_w_p_r_t_f.html#a1">RWPRTF</a>, <a class="el" href="class_s_c_s_u_u_t_f8.html#a1">SCSUUTF8</a>, <a class="el" href="class_th_m_l_footnotes.html#a2">ThMLFootnotes</a>, <a class="el" href="class_th_m_l_headings.html#a2">ThMLHeadings</a>, <a class="el" href="class_th_m_l_lemma.html#a2">ThMLLemma</a>, <a class="el" href="class_th_m_l_morph.html#a2">ThMLMorph</a>, <a class="el" href="class_th_m_l_scripref.html#a2">ThMLScripref</a>, <a class="el" href="class_th_m_l_strongs.html#a2">ThMLStrongs</a>, <a class="el" href="class_unicode_r_t_f.html#a1">UnicodeRTF</a>, <a class="el" href="class_u_t_f16_u_t_f8.html#a1">UTF16UTF8</a>, <a class="el" href="class_u_t_f8_cantillation.html#a2">UTF8Cantillation</a>, <a class="el" href="class_u_t_f8_greek_accents.html#a2">UTF8GreekAccents</a>, <a class="el" href="class_u_t_f8_hebrew_points.html#a2">UTF8HebrewPoints</a>, <a class="el" href="class_u_t_f8_h_t_m_l.html#a1">UTF8HTML</a>, <a class="el" href="class_u_t_f8_latin1.html#a1">UTF8Latin1</a>, and <a class="el" href="class_u_t_f8_u_t_f16.html#a1">UTF8UTF16</a>. +<p> +Definition at line <a class="el" href="swfilter_8h-source.html#l00091">91</a> of file <a class="el" href="swfilter_8h-source.html">swfilter.h</a>. +<p> +Referenced by <a class="el" href="swfilter_8h-source.html#l00100">ProcessText</a>(). +<p> + </td> + </tr> +</table> +<a name="a1" doxytag="SWFilter::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWFilter::getOptionName + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented in <a class="el" href="class_g_b_f_footnotes.html#a3">GBFFootnotes</a>, <a class="el" href="class_g_b_f_headings.html#a3">GBFHeadings</a>, <a class="el" href="class_g_b_f_morph.html#a3">GBFMorph</a>, <a class="el" href="class_g_b_f_strongs.html#a3">GBFStrongs</a>, <a class="el" href="class_p_l_a_i_n_footnotes.html#a3">PLAINFootnotes</a>, <a class="el" href="class_th_m_l_footnotes.html#a3">ThMLFootnotes</a>, <a class="el" href="class_th_m_l_headings.html#a3">ThMLHeadings</a>, <a class="el" href="class_th_m_l_lemma.html#a3">ThMLLemma</a>, <a class="el" href="class_th_m_l_morph.html#a3">ThMLMorph</a>, <a class="el" href="class_th_m_l_scripref.html#a3">ThMLScripref</a>, <a class="el" href="class_th_m_l_strongs.html#a3">ThMLStrongs</a>, <a class="el" href="class_u_t_f8_cantillation.html#a3">UTF8Cantillation</a>, <a class="el" href="class_u_t_f8_greek_accents.html#a3">UTF8GreekAccents</a>, and <a class="el" href="class_u_t_f8_hebrew_points.html#a3">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_8h-source.html#l00051">51</a> of file <a class="el" href="swfilter_8h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a2" doxytag="SWFilter::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWFilter::getOptionTip + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented in <a class="el" href="class_g_b_f_footnotes.html#a4">GBFFootnotes</a>, <a class="el" href="class_g_b_f_headings.html#a4">GBFHeadings</a>, <a class="el" href="class_g_b_f_morph.html#a4">GBFMorph</a>, <a class="el" href="class_g_b_f_strongs.html#a4">GBFStrongs</a>, <a class="el" href="class_p_l_a_i_n_footnotes.html#a4">PLAINFootnotes</a>, <a class="el" href="class_th_m_l_footnotes.html#a4">ThMLFootnotes</a>, <a class="el" href="class_th_m_l_headings.html#a4">ThMLHeadings</a>, <a class="el" href="class_th_m_l_lemma.html#a4">ThMLLemma</a>, <a class="el" href="class_th_m_l_morph.html#a4">ThMLMorph</a>, <a class="el" href="class_th_m_l_scripref.html#a4">ThMLScripref</a>, <a class="el" href="class_th_m_l_strongs.html#a4">ThMLStrongs</a>, <a class="el" href="class_u_t_f8_cantillation.html#a4">UTF8Cantillation</a>, <a class="el" href="class_u_t_f8_greek_accents.html#a4">UTF8GreekAccents</a>, and <a class="el" href="class_u_t_f8_hebrew_points.html#a4">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_8h-source.html#l00059">59</a> of file <a class="el" href="swfilter_8h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a3" doxytag="SWFilter::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual OptionsList SWFilter::getOptionValues + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented in <a class="el" href="class_g_b_f_footnotes.html#a7">GBFFootnotes</a>, <a class="el" href="class_g_b_f_headings.html#a7">GBFHeadings</a>, <a class="el" href="class_g_b_f_morph.html#a7">GBFMorph</a>, <a class="el" href="class_g_b_f_strongs.html#a7">GBFStrongs</a>, <a class="el" href="class_p_l_a_i_n_footnotes.html#a7">PLAINFootnotes</a>, <a class="el" href="class_th_m_l_footnotes.html#a7">ThMLFootnotes</a>, <a class="el" href="class_th_m_l_headings.html#a7">ThMLHeadings</a>, <a class="el" href="class_th_m_l_lemma.html#a7">ThMLLemma</a>, <a class="el" href="class_th_m_l_morph.html#a7">ThMLMorph</a>, <a class="el" href="class_th_m_l_scripref.html#a7">ThMLScripref</a>, <a class="el" href="class_th_m_l_strongs.html#a7">ThMLStrongs</a>, <a class="el" href="class_u_t_f8_cantillation.html#a7">UTF8Cantillation</a>, <a class="el" href="class_u_t_f8_greek_accents.html#a7">UTF8GreekAccents</a>, and <a class="el" href="class_u_t_f8_hebrew_points.html#a7">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_8h-source.html#l00067">67</a> of file <a class="el" href="swfilter_8h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="SWFilter::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWFilter::setOptionValue + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ival</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_s_w_filter.html#a3">getOptionValues</a>. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival +</em> </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented in <a class="el" href="class_g_b_f_footnotes.html#a5">GBFFootnotes</a>, <a class="el" href="class_g_b_f_headings.html#a5">GBFHeadings</a>, <a class="el" href="class_g_b_f_morph.html#a5">GBFMorph</a>, <a class="el" href="class_g_b_f_strongs.html#a5">GBFStrongs</a>, <a class="el" href="class_p_l_a_i_n_footnotes.html#a5">PLAINFootnotes</a>, <a class="el" href="class_th_m_l_footnotes.html#a5">ThMLFootnotes</a>, <a class="el" href="class_th_m_l_headings.html#a5">ThMLHeadings</a>, <a class="el" href="class_th_m_l_lemma.html#a5">ThMLLemma</a>, <a class="el" href="class_th_m_l_morph.html#a5">ThMLMorph</a>, <a class="el" href="class_th_m_l_scripref.html#a5">ThMLScripref</a>, <a class="el" href="class_th_m_l_strongs.html#a5">ThMLStrongs</a>, <a class="el" href="class_u_t_f8_cantillation.html#a5">UTF8Cantillation</a>, <a class="el" href="class_u_t_f8_greek_accents.html#a5">UTF8GreekAccents</a>, and <a class="el" href="class_u_t_f8_hebrew_points.html#a5">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_8h-source.html#l00078">78</a> of file <a class="el" href="swfilter_8h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swfilter_8h-source.html">swfilter.h</a></ul> +<hr><address><small>Generated at Wed Dec 5 22:22:01 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_key-members.html b/doc/api-documentation/html/class_s_w_key-members.html new file mode 100644 index 0000000..b7fdc5c --- /dev/null +++ b/doc/api-documentation/html/class_s_w_key-members.html @@ -0,0 +1,33 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWKey Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_key.html">SWKey</a>, including all inherited members.<ul> +<li><b>classdef</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [private, static]</code><li><a class="el" href="class_s_w_key.html#a3">clone</a>() const +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a10">compare</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a8">copyFrom</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a13">decrement</a>(int steps=1) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a11">equals</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><b>error</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_s_w_key.html#a6">Error</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_object.html#a0">getClass</a>() const +<code> [inline]</code><li><a class="el" href="class_s_w_key.html#a9">getText</a>() const +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a14">increment</a>(int steps=1) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a16">Index</a>() const +<code> [inline, virtual]</code><li><b>Index</b>(long iindex) (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [inline, virtual]</code><li><b>index</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [private]</code><li><b>init</b>() (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [private]</code><li><b>keytext</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><b>myclass</b> (defined in <a class="el" href="class_s_w_object.html">SWObject</a>)<code> [protected]</code><li><b>persist</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_s_w_key.html#a4">Persist</a>() const +<li><a class="el" href="class_s_w_key.html#a5">Persist</a>(char ikey) +<li><b>setPosition</b>(SW_POSITION) (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a7">setText</a>(const char *ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a0">SWKey</a>(const char *ikey=0) +<li><a class="el" href="class_s_w_key.html#a1">SWKey</a>(SWKey const &k) +<li><b>Traversable</b>() (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [inline, virtual]</code><li><a class="el" href="class_s_w_key.html#a2">~SWKey</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_key.gif b/doc/api-documentation/html/class_s_w_key.gif Binary files differnew file mode 100644 index 0000000..bb80a6c --- /dev/null +++ b/doc/api-documentation/html/class_s_w_key.gif diff --git a/doc/api-documentation/html/class_s_w_key.html b/doc/api-documentation/html/class_s_w_key.html new file mode 100644 index 0000000..349ea40 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_key.html @@ -0,0 +1,649 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWKey class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWKey Class Reference</h1>SWKey is the basis for all types of keys for indexing into modules (e.g. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swkey_8h-source.html">swkey.h</a>></code> +<p> +<p>Inheritance diagram for SWKey:: +<p><center><img src="class_s_w_key.gif" usemap="#SWKey_map" border="0"></center> +<map name="SWKey_map"> +<area href="class_s_w_object.html" alt="SWObject" shape="rect" coords="78,0,146,24"> +<area href="class_list_key.html" alt="ListKey" shape="rect" coords="0,112,68,136"> +<area href="class_str_key.html" alt="StrKey" shape="rect" coords="78,112,146,136"> +<area href="class_verse_key.html" alt="VerseKey" shape="rect" coords="156,112,224,136"> +</map> +<a href="class_s_w_key-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_key.html#a0">SWKey</a> (const char *ikey=0)</td></tr> +<tr><td> </td><td><font size=-1><em>initializes instance of SWKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_key.html#a1">SWKey</a> (SWKey const &k)</td></tr> +<tr><td> </td><td><font size=-1><em>Copy Constructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="SWKey::~SWKey"></a> +virtual </td><td valign=bottom><a class="el" href="class_s_w_key.html#a2">~SWKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Destructor, cleans up this instance of SWKey.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWKey * </td><td valign=bottom><a class="el" href="class_s_w_key.html#a3">clone</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns a copy of this SWKey object.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="class_s_w_key.html#a4">Persist</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets whether this object itself persists within a module that it was used to SetKey or just a copy.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="class_s_w_key.html#a5">Persist</a> (char ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_key.html#a6">Error</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Gets and clears error status.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_key.html#a7">setText</a> (const char *ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this SWKey to a character string.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_key.html#a8">copyFrom</a> (const SWKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this SWKey to another SWKey object.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a9" doxytag="SWKey::getText"></a> +virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_key.html#a9">getText</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>returns text key if (char *) cast is requested.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_s_w_key.html#a10">compare</a> (const SWKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Compares another <a class="el" href="class_verse_key.html">VerseKey</a> object.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="class_s_w_key.html#a11">equals</a> (const SWKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Compares another <a class="el" href="class_verse_key.html">VerseKey</a> object.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a12" doxytag="SWKey::setPosition"></a> +virtual void </td><td valign=bottom><b>setPosition</b> (SW_POSITION)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_key.html#a13">decrement</a> (int steps=1)</td></tr> +<tr><td> </td><td><font size=-1><em>Decrements key a number of entries.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_key.html#a14">increment</a> (int steps=1)</td></tr> +<tr><td> </td><td><font size=-1><em>Increments key a number of entries.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a15" doxytag="SWKey::Traversable"></a> +virtual char </td><td valign=bottom><b>Traversable</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_s_w_key.html#a16">Index</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Use this function to get te current position withing a module.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a17" doxytag="SWKey::Index"></a> +virtual long </td><td valign=bottom><b>Index</b> (long iindex)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWKey::keytext"></a> +char * </td><td valign=bottom><b>keytext</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWKey::persist"></a> +char </td><td valign=bottom><b>persist</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWKey::error"></a> +char </td><td valign=bottom><b>error</b></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="SWKey::init"></a> +void </td><td valign=bottom><b>init</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="SWKey::index"></a> +long </td><td valign=bottom><b>index</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="SWKey::classdef"></a> +<a class="el" href="class_s_w_class.html">SWClass</a> </td><td valign=bottom><b>classdef</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +SWKey is the basis for all types of keys for indexing into modules (e.g. +<p> +verse, word, place, etc.) +<p> + +<p> +Definition at line <a class="el" href="swkey_8h-source.html#l00076">76</a> of file <a class="el" href="swkey_8h-source.html">swkey.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWKey::SWKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWKey::SWKey + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ikey</em> = 0 </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +initializes instance of SWKey. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +text key </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="SWKey::SWKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWKey::SWKey + </td> + <td class="md">( </td> + <td class="md">SWKey const & </td> + <td class="mdname"> <em>k</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Copy Constructor. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>The +</em> </td><td> +SWKey object to copy. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a6" doxytag="SWKey::Error"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWKey::Error + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets and clears error status. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +error status </dl> </td> + </tr> +</table> +<a name="a16" doxytag="SWKey::Index"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual long SWKey::Index + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Use this function to get te current position withing a module. +<p> +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. <div class="fragment"><pre> <font class="keyword">const</font> <font class="keywordtype">char</font>* randomVerse()<font class="keyword"> </font>{ + <a class="code" href="class_verse_key.html">VerseKey</a> vk; + <a class="code" href="class_s_w_mgr.html">SWMgr</a> mgr; + LocaleMgr::systemLocaleMgr.<a class="code" href="class_locale_mgr.html#a6">setDefaultLocaleName</a>(<font class="stringliteral">"de"</font>); + + <a class="code" href="class_s_w_module.html">SWModule</a>* module = mgr-><a class="code" href="class_s_w_mgr.html#m2">Modules</a>(<font class="stringliteral">"GerLut"</font>); + srand( time(0) ); + <font class="keyword">const</font> <font class="keywordtype">double</font> newIndex = (double(rand())/RAND_MAX)*(24108+8224); + vk.<a class="code" href="class_verse_key.html#a31">Index</a>(newIndex); + module-><a class="code" href="class_s_w_module.html#a5">SetKey</a>(vk); + + <font class="keywordtype">char</font>* text; + sprintf(text, <font class="stringliteral">"%s: %s"</font>,(<font class="keyword">const</font> <font class="keywordtype">char</font>*)vk ,module-><a class="code" href="class_s_w_module.html#a53">StripText</a>(&vk)); + <font class="keywordflow">return</font> text;</pre></div> +<p> +Reimplemented in <a class="el" href="class_list_key.html#a17">ListKey</a>, and <a class="el" href="class_verse_key.html#a31">VerseKey</a>. +<p> +Definition at line <a class="el" href="swkey_8h-source.html#l00204">204</a> of file <a class="el" href="swkey_8h-source.html">swkey.h</a>. +<p> +Referenced by <a class="el" href="listkey_8h-source.html#l00112">ListKey::Index</a>(). +<p> + </td> + </tr> +</table> +<a name="a5" doxytag="SWKey::Persist"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +char SWKey::Persist + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy. +<p> +(1 - persists in module; 0 - a copy is attempted<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ipersist +</em> </td><td> +value which to set persist; [-1] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +value of persist </dl> </td> + </tr> +</table> +<a name="a4" doxytag="SWKey::Persist"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +char SWKey::Persist + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets whether this object itself persists within a module that it was used to SetKey or just a copy. +<p> +(1 - persists in module; 0 - a copy is attempted +<p> +<dl compact><dt> +<b>Returns: </b><dd> +value of persist </dl> </td> + </tr> +</table> +<a name="a3" doxytag="SWKey::clone"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWKey* SWKey::clone + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns a copy of this SWKey object. +<p> +This is useful to get a 1:1 copy of an SWKey based object. <dl compact><dt> +<b>Returns: </b><dd> +SWKey </dl> +<p> +Reimplemented in <a class="el" href="class_list_key.html#a3">ListKey</a>, and <a class="el" href="class_verse_key.html#a10">VerseKey</a>. </td> + </tr> +</table> +<a name="a10" doxytag="SWKey::compare"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual int SWKey::compare + </td> + <td class="md">( </td> + <td class="md">const SWKey & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compares another <a class="el" href="class_verse_key.html">VerseKey</a> object. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +key to compare with this one </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +>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 </dl> +<p> +Reimplemented in <a class="el" href="class_verse_key.html#a34">VerseKey</a>. +<p> +Referenced by <a class="el" href="swkey_8h-source.html#l00163">equals</a>(). +<p> + </td> + </tr> +</table> +<a name="a8" doxytag="SWKey::copyFrom"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWKey::copyFrom + </td> + <td class="md">( </td> + <td class="md">const SWKey & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this SWKey to another SWKey object. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +other swkey object </td></tr> +</table> +</dl> +<p> +Reimplemented in <a class="el" href="class_list_key.html#a12">ListKey</a>, and <a class="el" href="class_verse_key.html#a13">VerseKey</a>. +<p> +Referenced by <a class="el" href="listkey_8h-source.html#l00090">ListKey::copyFrom</a>(). +<p> + </td> + </tr> +</table> +<a name="a13" doxytag="SWKey::decrement"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWKey::decrement + </td> + <td class="md">( </td> + <td class="md">int </td> + <td class="mdname"> <em>step</em> = 1 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Decrements key a number of entries. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>steps +</em> </td><td> +Number of entries to jump backward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented in <a class="el" href="class_list_key.html#a14">ListKey</a>, and <a class="el" href="class_verse_key.html#a16">VerseKey</a>. </td> + </tr> +</table> +<a name="a11" doxytag="SWKey::equals"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual bool SWKey::equals + </td> + <td class="md">( </td> + <td class="md">const SWKey & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compares another <a class="el" href="class_verse_key.html">VerseKey</a> object. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +key to compare with this one </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +true if the keys are the same </dl> +<p> +Definition at line <a class="el" href="swkey_8h-source.html#l00163">163</a> of file <a class="el" href="swkey_8h-source.html">swkey.h</a>. </td> + </tr> +</table> +<a name="a14" doxytag="SWKey::increment"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWKey::increment + </td> + <td class="md">( </td> + <td class="md">int </td> + <td class="mdname"> <em>step</em> = 1 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Increments key a number of entries. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>increment +</em> </td><td> +Number of entries to jump forward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented in <a class="el" href="class_list_key.html#a15">ListKey</a>, and <a class="el" href="class_verse_key.html#a17">VerseKey</a>. </td> + </tr> +</table> +<a name="a7" doxytag="SWKey::setText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWKey::setText + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this SWKey to a character string. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +string to set this key to </td></tr> +</table> +</dl> +<p> +Reimplemented in <a class="el" href="class_verse_key.html#a12">VerseKey</a>. +<p> +Referenced by <a class="el" href="versekey_8h-source.html#l00229">VerseKey::setText</a>(). +<p> + </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swkey_8h-source.html">swkey.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_l_d-members.html b/doc/api-documentation/html/class_s_w_l_d-members.html new file mode 100644 index 0000000..942e38f --- /dev/null +++ b/doc/api-documentation/html/class_s_w_l_d-members.html @@ -0,0 +1,83 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWLD Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_l_d.html">SWLD</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_module.html#a42">AddEncodingFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a51">AddOptionFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a48">AddRawFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a38">AddRenderFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a46">AddStripFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_l_d.html#a2">CreateKey</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#d1">createModule</a>(const char *) +<code> [inline, static]</code><li><b>createSearchFramework</b>() (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a32">deleteEntry</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a13">Description</a>(const char *imoddesc=0) +<code> [virtual]</code><li><b>direction</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a15">Direction</a>(signed char newdir=-1) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a11">Disp</a>(SWDisplay *idisp=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#n10">disp</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a10">Display</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a16">Encoding</a>(signed char enc=-1) +<code> [virtual]</code><li><b>encoding</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a45">encodingFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n16">encodingFilters</a> +<code> [protected]</code><li><b>entkeytxt</b> (defined in <a class="el" href="class_s_w_l_d.html">SWLD</a>)<code> [protected]</code><li><b>entrybuf</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>entrySize</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a2">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a49">filterBuffer</a>(FilterList *filters, char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a4">getEntrySize</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a25">getRawEntry</a>()=0 +<code> [pure virtual]</code><li><b>hasSearchFramework</b>() (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a22">isSearchOptimallySupported</a>(const char *istr, int searchType, int flags, SWKey *scope) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a3">isUnicode</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a28">isWritable</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a7">Key</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a8">Key</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n1">key</a> +<code> [protected]</code><li><a class="el" href="class_s_w_l_d.html#a3">KeyText</a>(const char *ikeytext) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a18">Lang</a>(const char *imodlang=0) +<code> [virtual]</code><li><b>listkey</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a17">Markup</a>(signed char enc=-1) +<code> [virtual]</code><li><b>markup</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>moddesc</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modlang</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modname</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modtype</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a12">Name</a>(const char *imodname=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#d0">nullPercent</a>(char percent, void *userData) +<code> [static]</code><li><a class="el" href="class_s_w_module.html#a24">operator char *</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a26">operator SWKey &</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a27">operator SWKey *</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a35">operator++</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a34">operator+=</a>(int increment) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a36">operator--</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a33">operator-=</a>(int decrement) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a30">operator<<</a>(const char *) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a31">operator<<</a>(const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a37">operator=</a>(SW_POSITION p) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a52">optionFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n15">optionFilters</a> +<code> [protected]</code><li><b>rawdisp</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected, static]</code><li><a class="el" href="class_s_w_module.html#a50">rawFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n13">rawFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a43">RemoveEncodingFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a39">RemoveRenderFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><b>render</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a41">renderFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n14">renderFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a54">RenderText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a56">RenderText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a44">ReplaceEncodingFilter</a>(SWFilter *oldfilter, SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a40">ReplaceRenderFilter</a>(SWFilter *oldfilter, SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a19">Search</a>(const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a29">setentry</a>(const char *inbuf, long len) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a5">SetKey</a>(const SWKey *ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a6">SetKey</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a47">stripFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n12">stripFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a53">StripText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a55">StripText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_s_w_l_d.html#a0">SWLD</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *ilang=0) +<li><a class="el" href="class_s_w_module.html#a0">SWModule</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char *imodtype=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *modlang=0) +<li><a class="el" href="class_s_w_module.html#m0">terminateSearch</a> +<li><a class="el" href="class_s_w_module.html#a14">Type</a>(const char *imodtype=0) +<code> [virtual]</code><li><b>~SWLD</b>() (defined in <a class="el" href="class_s_w_l_d.html">SWLD</a>)<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a1">~SWModule</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_l_d.gif b/doc/api-documentation/html/class_s_w_l_d.gif Binary files differnew file mode 100644 index 0000000..510eb20 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_l_d.gif diff --git a/doc/api-documentation/html/class_s_w_l_d.html b/doc/api-documentation/html/class_s_w_l_d.html new file mode 100644 index 0000000..5dc8086 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_l_d.html @@ -0,0 +1,235 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWLD class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWLD Class Reference</h1>the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swld_8h-source.html">swld.h</a>></code> +<p> +<p>Inheritance diagram for SWLD:: +<p><center><img src="class_s_w_l_d.gif" usemap="#SWLD_map" border="0"></center> +<map name="SWLD_map"> +<area href="class_s_w_module.html" alt="SWModule" shape="rect" coords="0,0,73,24"> +</map> +<a href="class_s_w_l_d-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_l_d.html#a0">SWLD</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_s_w_display.html">SWDisplay</a> *idisp=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *ilang=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Initializes data for instance of SWLD.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWLD::~SWLD"></a> +virtual </td><td valign=bottom><b>~SWLD</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_s_w_l_d.html#a2">CreateKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Allocates a key of specific type for module The different reimplementatiosn of <a class="el" href="class_s_w_module.html">SWModule</a> (e.g.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_l_d.html#a3">KeyText</a> (const char *ikeytext)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module KeyText, getting from saved text if key is persistent.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWLD::entkeytxt"></a> +char * </td><td valign=bottom><b>entkeytxt</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). +<p> + +<p> +Definition at line <a class="el" href="swld_8h-source.html#l00034">34</a> of file <a class="el" href="swld_8h-source.html">swld.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWLD::SWLD"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWLD::SWLD + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>imodname</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>imoddesc</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_display.html">SWDisplay</a> * </td> + <td class="mdname"> <em>idisp</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextEncoding </td> + <td class="mdname"> <em>encoding</em> = ENC_UNKNOWN, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextDirection </td> + <td class="mdname"> <em>dir</em> = DIRECTION_LTR, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextMarkup </td> + <td class="mdname"> <em>markup</em> = FMT_UNKNOWN, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>ilang</em> = 0 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initializes data for instance of SWLD. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodname +</em> </td><td> +Internal name for module </td></tr> +<tr><td valign=top><em>imoddesc +</em> </td><td> +Name to display to user for module </td></tr> +<tr><td valign=top><em>idisp +</em> </td><td> +Display object to use for displaying </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="SWLD::CreateKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual <a class="el" href="class_s_w_key.html">SWKey</a>* SWLD::CreateKey + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Allocates a key of specific type for module The different reimplementatiosn of <a class="el" href="class_s_w_module.html">SWModule</a> (e.g. +<p> +<a class="el" href="class_s_w_text.html">SWText</a>) support <a class="el" href="class_s_w_key.html">SWKey</a> implementations, which support special. This functions returns a <a class="el" href="class_s_w_key.html">SWKey</a> object which works with the current implementation of <a class="el" href="class_s_w_module.html">SWModule</a>. For example for the <a class="el" href="class_s_w_text.html">SWText</a> class it returns a <a class="el" href="class_verse_key.html">VerseKey</a> object. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_verse_key.html">VerseKey</a>, <a class="el" href="class_list_key.html">ListKey</a>, <a class="el" href="class_s_w_text.html">SWText</a>, SWLD, <a class="el" href="class_s_w_com.html">SWCom</a> </dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to allocated key </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_module.html#a23">SWModule</a>. +<p> +Definition at line <a class="el" href="swld_8h-source.html#l00047">47</a> of file <a class="el" href="swld_8h-source.html">swld.h</a>. </td> + </tr> +</table> +<a name="a3" doxytag="SWLD::KeyText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWLD::KeyText + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ikeytext</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module KeyText, getting from saved text if key is persistent. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikeytext +</em> </td><td> +value which to set keytext; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to keytext </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_module.html#a9">SWModule</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swld_8h-source.html">swld.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_locale-members.html b/doc/api-documentation/html/class_s_w_locale-members.html new file mode 100644 index 0000000..13b0e57 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_locale-members.html @@ -0,0 +1,19 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWLocale Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_locale.html">SWLocale</a>, including all inherited members.<ul> +<li><b>BMAX</b> (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [private]</code><li><b>bookAbbrevs</b> (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [private]</code><li><b>books</b> (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [private]</code><li><b>description</b> (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [private]</code><li><b>getBookAbbrevs</b>() (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [virtual]</code><li><b>getBooks</b>(char **iBMAX, struct sbook ***ibooks) (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [virtual]</code><li><a class="el" href="class_s_w_locale.html#a3">getDescription</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_locale.html#a2">getName</a>() +<code> [virtual]</code><li><b>localeSource</b> (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [private]</code><li><b>lookupTable</b> (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [private]</code><li><b>name</b> (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [private]</code><li><b>operator+=</b>(SWLocale &addFrom) (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [virtual]</code><li><b>SWLocale</b>(const char *ifilename) (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<li><b>translate</b>(const char *text) (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [virtual]</code><li><b>~SWLocale</b>() (defined in <a class="el" href="class_s_w_locale.html">SWLocale</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_locale.html b/doc/api-documentation/html/class_s_w_locale.html new file mode 100644 index 0000000..6c43806 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_locale.html @@ -0,0 +1,131 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWLocale class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWLocale Class Reference</h1>SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swlocale_8h-source.html">swlocale.h</a>></code> +<p> +<a href="class_s_w_locale-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SWLocale::SWLocale"></a> + </td><td valign=bottom><b>SWLocale</b> (const char *ifilename)</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWLocale::~SWLocale"></a> +virtual </td><td valign=bottom><b>~SWLocale</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_locale.html#a2">getName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>This function is used to get the name of the languages which this object is handling.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_locale.html#a3">getDescription</a> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="SWLocale::translate"></a> +virtual const char * </td><td valign=bottom><b>translate</b> (const char *text)</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="SWLocale::operator+="></a> +virtual SWLocale & </td><td valign=bottom><b>operator+=</b> (SWLocale &addFrom)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="SWLocale::getBookAbbrevs"></a> +virtual const struct abbrev * </td><td valign=bottom><b>getBookAbbrevs</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="SWLocale::getBooks"></a> +virtual void </td><td valign=bottom><b>getBooks</b> (char **iBMAX, struct sbook ***ibooks)</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="SWLocale::lookupTable"></a> +LookupMap </td><td valign=bottom><b>lookupTable</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="SWLocale::localeSource"></a> +<a class="el" href="class_s_w_config.html">SWConfig</a> * </td><td valign=bottom><b>localeSource</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o2" doxytag="SWLocale::name"></a> +char * </td><td valign=bottom><b>name</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o3" doxytag="SWLocale::description"></a> +char * </td><td valign=bottom><b>description</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o4" doxytag="SWLocale::bookAbbrevs"></a> +abbrev * </td><td valign=bottom><b>bookAbbrevs</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o5" doxytag="SWLocale::BMAX"></a> +char * </td><td valign=bottom><b>BMAX</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o6" doxytag="SWLocale::books"></a> +sbook ** </td><td valign=bottom><b>books</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language. +<p> +Every language supported by Sword has one SWLocale object, get the name of the Language using <dl compact><dt> +<b>See also: </b><dd> +getname of this class. Another functions useful for frontend developers is , <a class="el" href="class_s_w_locale.html#a3">getDescription</a>. </dl> +<p> + +<p> +Definition at line <a class="el" href="swlocale_8h-source.html#l00044">44</a> of file <a class="el" href="swlocale_8h-source.html">swlocale.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="SWLocale::getDescription"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWLocale::getDescription + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt> +<b>Returns: </b><dd> +The description. A possible example is "German". </dl> </td> + </tr> +</table> +<a name="a2" doxytag="SWLocale::getName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWLocale::getName + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This function is used to get the name of the languages which this object is handling. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +The name of the managed language. A possible example is "de". </dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swlocale_8h-source.html">swlocale.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_markup_mgr-members.html b/doc/api-documentation/html/class_s_w_markup_mgr-members.html new file mode 100644 index 0000000..db198f6 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_markup_mgr-members.html @@ -0,0 +1,41 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWMarkupMgr Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_markup_mgr.html">SWMarkupMgr</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_encoding_mgr.html#a4">AddEncodingFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [virtual]</code><li><b>AddGlobalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><b>AddLocalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><b>AddModToConfig</b>(int conffd, const char *fname) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_s_w_encoding_mgr.html#a3">AddRawFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [virtual]</code><li><a class="el" href="class_s_w_markup_mgr.html#a3">AddRenderFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#b10">AddStripFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [protected, virtual]</code><li><b>cipherFilters</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>cleanupFilters</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#m0">config</a> +<li><b>configPath</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<li><b>configType</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>CreateFilters</b>(char markup) (defined in <a class="el" href="class_s_w_markup_mgr.html">SWMarkupMgr</a>)<code> [protected]</code><li><b>CreateMod</b>(string name, string driver, ConfigEntMap &section) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>CreateMods</b>() (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#p0">debug</a> +<code> [static]</code><li><b>DeleteMods</b>() (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_encoding_mgr.html#a2">Encoding</a>(char enc) +<li><b>encoding</b> (defined in <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>)<code> [protected]</code><li><b>findConfig</b>(char *configType, char **prefixPath, char **configPath) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [static]</code><li><b>fromgbf</b> (defined in <a class="el" href="class_s_w_markup_mgr.html">SWMarkupMgr</a>)<code> [protected]</code><li><b>fromosis</b> (defined in <a class="el" href="class_s_w_markup_mgr.html">SWMarkupMgr</a>)<code> [protected]</code><li><b>fromplain</b> (defined in <a class="el" href="class_s_w_markup_mgr.html">SWMarkupMgr</a>)<code> [protected]</code><li><b>fromthml</b> (defined in <a class="el" href="class_s_w_markup_mgr.html">SWMarkupMgr</a>)<code> [protected]</code><li><b>gbfplain</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#a6">getGlobalOption</a>(const char *option) +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a8">getGlobalOptions</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a7">getGlobalOptionTip</a>(const char *option) +<code> [virtual]</code><li><b>getGlobalOptionValues</b>(const char *option) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [virtual]</code><li><b>init</b>() (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_s_w_mgr.html#a3">InstallScan</a>(const char *dir) +<code> [virtual]</code><li><b>latin1utf8</b> (defined in <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#a4">Load</a>() +<code> [virtual]</code><li><b>loadConfigDir</b>(const char *ipath) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><b>markup</b> (defined in <a class="el" href="class_s_w_markup_mgr.html">SWMarkupMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_markup_mgr.html#a2">Markup</a>(char m=FMT_UNKNOWN) +<li><a class="el" href="class_s_w_mgr.html#m2">Modules</a> +<li><b>myconfig</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>mysysconfig</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>optionFilters</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>options</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#m3">prefixPath</a> +<li><b>scsuutf8</b> (defined in <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#a10">setCipherKey</a>(const char *modName, const char *key) +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a5">setGlobalOption</a>(const char *option, const char *value) +<code> [virtual]</code><li><a class="el" href="class_s_w_encoding_mgr.html#a0">SWEncodingMgr</a>(SWConfig *iconfig=0, SWConfig *isysconfig=0, bool autoload=true, char encoding=ENC_UTF8) +<li><a class="el" href="class_s_w_markup_mgr.html#a0">SWMarkupMgr</a>(SWConfig *iconfig=0, SWConfig *isysconfig=0, bool autoload=true, char encoding=ENC_UTF8, char markup=FMT_THML) +<li><a class="el" href="class_s_w_mgr.html#a0">SWMgr</a>(SWConfig *iconfig=0, SWConfig *isysconfig=0, bool autoload=true) +<li><b>SWMgr</b>(const char *iConfigPath, bool autoload=true) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<li><b>sysconfig</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<li><b>targetenc</b> (defined in <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>)<code> [protected]</code><li><b>thmlplain</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#a11">Version</a>() const +<code> [inline]</code><li><a class="el" href="class_s_w_encoding_mgr.html#a1">~SWEncodingMgr</a>() +<li><a class="el" href="class_s_w_markup_mgr.html#a1">~SWMarkupMgr</a>() +<li><a class="el" href="class_s_w_mgr.html#a2">~SWMgr</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Oct 30 16:04:54 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_markup_mgr.gif b/doc/api-documentation/html/class_s_w_markup_mgr.gif Binary files differnew file mode 100644 index 0000000..c09d748 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_markup_mgr.gif diff --git a/doc/api-documentation/html/class_s_w_markup_mgr.html b/doc/api-documentation/html/class_s_w_markup_mgr.html new file mode 100644 index 0000000..65f0311 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_markup_mgr.html @@ -0,0 +1,251 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWMarkupMgr class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWMarkupMgr Class Reference</h1>This class is like a normal <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>, but you can additonally specify which markup you want to use. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swmarkupmgr_8h-source.html">swmarkupmgr.h</a>></code> +<p> +<p>Inheritance diagram for SWMarkupMgr:: +<p><center><img src="class_s_w_markup_mgr.gif" usemap="#SWMarkupMgr_map" border="0"></center> +<map name="SWMarkupMgr_map"> +<area href="class_s_w_encoding_mgr.html" alt="SWEncodingMgr" shape="rect" coords="0,56,107,80"> +<area href="class_s_w_mgr.html" alt="SWMgr" shape="rect" coords="0,0,107,24"> +</map> +<a href="class_s_w_markup_mgr-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_markup_mgr.html#a0">SWMarkupMgr</a> (<a class="el" href="class_s_w_config.html">SWConfig</a> *iconfig=0, <a class="el" href="class_s_w_config.html">SWConfig</a> *isysconfig=0, bool autoload=true, char encoding=ENC_UTF8, char markup=FMT_THML)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor of SWMarkupMgr.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWMarkupMgr::~SWMarkupMgr"></a> + </td><td valign=bottom><a class="el" href="class_s_w_markup_mgr.html#a1">~SWMarkupMgr</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>The destructor of SWMarkupMgr.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="class_s_w_markup_mgr.html#a2">Markup</a> (char m=FMT_UNKNOWN)</td></tr> +<tr><td> </td><td><font size=-1><em>Markup sets/gets the markup after initialization.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_markup_mgr.html#a3">AddRenderFilters</a> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the render filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module".</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="SWMarkupMgr::CreateFilters"></a> +void </td><td valign=bottom><b>CreateFilters</b> (char markup)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWMarkupMgr::fromthml"></a> +<a class="el" href="class_s_w_filter.html">SWFilter</a> * </td><td valign=bottom><b>fromthml</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWMarkupMgr::fromgbf"></a> +<a class="el" href="class_s_w_filter.html">SWFilter</a> * </td><td valign=bottom><b>fromgbf</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWMarkupMgr::fromplain"></a> +<a class="el" href="class_s_w_filter.html">SWFilter</a> * </td><td valign=bottom><b>fromplain</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n3" doxytag="SWMarkupMgr::fromosis"></a> +<a class="el" href="class_s_w_filter.html">SWFilter</a> * </td><td valign=bottom><b>fromosis</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n4" doxytag="SWMarkupMgr::markup"></a> +char </td><td valign=bottom><b>markup</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class is like a normal <a class="el" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a>, but you can additonally specify which markup you want to use. +<p> + +<p> +Definition at line <a class="el" href="swmarkupmgr_8h-source.html#l00031">31</a> of file <a class="el" href="swmarkupmgr_8h-source.html">swmarkupmgr.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWMarkupMgr::SWMarkupMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWMarkupMgr::SWMarkupMgr + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_config.html">SWConfig</a> * </td> + <td class="mdname"> <em>iconfig</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_config.html">SWConfig</a> * </td> + <td class="mdname"> <em>isysconfig</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">bool </td> + <td class="mdname"> <em>autoload</em> = true, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">char </td> + <td class="mdname"> <em>encoding</em> = ENC_UTF8, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">char </td> + <td class="mdname"> <em>markup</em> = FMT_THML </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor of SWMarkupMgr. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iconfig +</em> </td><td> +</td></tr> +<tr><td valign=top><em>isysconfig +</em> </td><td> +</td></tr> +<tr><td valign=top><em>autoload +</em> </td><td> +If this bool is true the constructor starts loading the installed modules. If you reimplemented <a class="el" href="class_s_w_mgr.html">SWMgr</a> you can set autoload=false to load the modules with your own reimplemented function. </td></tr> +<tr><td valign=top><em>encoding +</em> </td><td> +The desired encoding. </td></tr> +<tr><td valign=top><em>markup +</em> </td><td> +The desired markup format. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="SWMarkupMgr::AddRenderFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWMarkupMgr::AddRenderFilters + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> * </td> + <td class="mdname"> <em>module</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">ConfigEntMap & </td> + <td class="mdname"> <em>section</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the render filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module +</em> </td><td> +To this module the render filter(s) are added </td></tr> +<tr><td valign=top><em>section +</em> </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_s_w_mgr.html#b9">SWMgr</a>. </td> + </tr> +</table> +<a name="a2" doxytag="SWMarkupMgr::Markup"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +char SWMarkupMgr::Markup + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>m</em> = FMT_UNKNOWN </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Markup sets/gets the markup after initialization. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>m +</em> </td><td> +The new markup or FMT_UNKNOWN if you just want to get the current markup. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +The current (possibly changed) markup format. </dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swmarkupmgr_8h-source.html">swmarkupmgr.h</a></ul> +<hr><address><small>Generated at Tue Oct 30 16:04:54 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_mgr-members.html b/doc/api-documentation/html/class_s_w_mgr-members.html new file mode 100644 index 0000000..dabc1d7 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_mgr-members.html @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWMgr Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_mgr.html">SWMgr</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_mgr.html#b8">AddEncodingFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [protected, virtual]</code><li><b>AddGlobalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><b>AddLocalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><b>AddModToConfig</b>(int conffd, const char *fname) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_s_w_mgr.html#b11">AddRawFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [protected, virtual]</code><li><a class="el" href="class_s_w_mgr.html#b9">AddRenderFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [protected, virtual]</code><li><a class="el" href="class_s_w_mgr.html#b10">AddStripFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [protected, virtual]</code><li><b>cipherFilters</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>cleanupFilters</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>commonInit</b>(SWConfig *iconfig, SWConfig *isysconfig, bool autoload, SWFilterMgr *filterMgr) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [private]</code><li><a class="el" href="class_s_w_mgr.html#m0">config</a> +<li><b>configPath</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<li><b>configType</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>CreateMod</b>(string name, string driver, ConfigEntMap &section) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>CreateMods</b>() (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#p0">debug</a> +<code> [static]</code><li><b>DeleteMods</b>() (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>filterMgr</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>findConfig</b>(char *configType, char **prefixPath, char **configPath) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [static]</code><li><b>gbfplain</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#a7">getGlobalOption</a>(const char *option) +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a9">getGlobalOptions</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a8">getGlobalOptionTip</a>(const char *option) +<code> [virtual]</code><li><b>getGlobalOptionValues</b>(const char *option) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [virtual]</code><li><b>globalConfPath</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [static]</code><li><b>init</b>() (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_s_w_mgr.html#a4">InstallScan</a>(const char *dir) +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a5">Load</a>() +<code> [virtual]</code><li><b>loadConfigDir</b>(const char *ipath) (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_s_w_mgr.html#m2">Modules</a> +<li><b>myconfig</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>mysysconfig</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>optionFilters</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><b>options</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#m3">prefixPath</a> +<li><a class="el" href="class_s_w_mgr.html#a11">setCipherKey</a>(const char *modName, const char *key) +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a6">setGlobalOption</a>(const char *option, const char *value) +<code> [virtual]</code><li><a class="el" href="class_s_w_mgr.html#a0">SWMgr</a>(SWConfig *iconfig=0, SWConfig *isysconfig=0, bool autoload=true, SWFilterMgr *filterMgr=0) +<li><a class="el" href="class_s_w_mgr.html#a1">SWMgr</a>(SWFilterMgr *filterMgr) +<li><a class="el" href="class_s_w_mgr.html#a2">SWMgr</a>(const char *iConfigPath, bool autoload=true, SWFilterMgr *filterMgr=0) +<li><b>sysconfig</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<li><b>thmlplain</b> (defined in <a class="el" href="class_s_w_mgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_s_w_mgr.html#a3">~SWMgr</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_mgr.gif b/doc/api-documentation/html/class_s_w_mgr.gif Binary files differnew file mode 100644 index 0000000..fc87289 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_mgr.gif diff --git a/doc/api-documentation/html/class_s_w_mgr.html b/doc/api-documentation/html/class_s_w_mgr.html new file mode 100644 index 0000000..90a0a84 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_mgr.html @@ -0,0 +1,996 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWMgr class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWMgr Class Reference</h1>SWMgr is the main class of the Sword library. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swmgr_8h-source.html">swmgr.h</a>></code> +<p> +<a href="class_s_w_mgr-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a0">SWMgr</a> (<a class="el" href="class_s_w_config.html">SWConfig</a> *iconfig=0, <a class="el" href="class_s_w_config.html">SWConfig</a> *isysconfig=0, bool autoload=true, SWFilterMgr *filterMgr=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor of SWMgr.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a1">SWMgr</a> (SWFilterMgr *filterMgr)</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a2">SWMgr</a> (const char *iConfigPath, bool autoload=true, SWFilterMgr *filterMgr=0)</td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a3">~SWMgr</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>The destructor of SWMgr.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a4">InstallScan</a> (const char *dir)</td></tr> +<tr><td> </td><td><font size=-1><em>Installs a scan for modules in the directory givan as parameter.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a5">Load</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Load the modules.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a6">setGlobalOption</a> (const char *option, const char *value)</td></tr> +<tr><td> </td><td><font size=-1><em>Set a global option Set a global option using the parameters.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a7">getGlobalOption</a> (const char *option)</td></tr> +<tr><td> </td><td><font size=-1><em>Gives the value of the given option.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a8">getGlobalOptionTip</a> (const char *option)</td></tr> +<tr><td> </td><td><font size=-1><em>Gives a description for the given option.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a9">getGlobalOptions</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>A list of all availble options with the currently set values.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a10" doxytag="SWMgr::getGlobalOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getGlobalOptionValues</b> (const char *option)</td></tr> +<tr><td nowrap align=right valign=top>virtual signed char </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#a11">setCipherKey</a> (const char *modName, const char *key)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the cipher key for the given module.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="d0" doxytag="SWMgr::findConfig"></a> +void </td><td valign=bottom><b>findConfig</b> (char *configType, char **<a class="el" href="class_s_w_mgr.html#m3">prefixPath</a>, char **configPath)</td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="class_s_w_config.html">SWConfig</a> * </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#m0">config</a></td></tr> +<tr><td> </td><td><font size=-1><em>The global config object.</em> <a href="#m0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="m1" doxytag="SWMgr::sysconfig"></a> +<a class="el" href="class_s_w_config.html">SWConfig</a> * </td><td valign=bottom><b>sysconfig</b></td></tr> +<tr><td nowrap align=right valign=top>ModMap </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#m2">Modules</a></td></tr> +<tr><td> </td><td><font size=-1><em>The map of available modules.</em> <a href="#m2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="m3" doxytag="SWMgr::prefixPath"></a> +char * </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#m3">prefixPath</a></td></tr> +<tr><td> </td><td><font size=-1><em>The path to your Sword directory.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="m4" doxytag="SWMgr::configPath"></a> +char * </td><td valign=bottom><b>configPath</b></td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#p0">debug</a></td></tr> +<tr><td> </td><td><font size=-1><em>Enable / Disable debug output on runtime Set this to true to get more verbose output of SWMgr at runtime.</em> <a href="#p0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="p1" doxytag="SWMgr::globalConfPath"></a> +const char * </td><td valign=bottom><b>globalConfPath</b></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="SWMgr::CreateMods"></a> +void </td><td valign=bottom><b>CreateMods</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="b1" doxytag="SWMgr::CreateMod"></a> +<a class="el" href="class_s_w_module.html">SWModule</a> * </td><td valign=bottom><b>CreateMod</b> (string name, string driver, ConfigEntMap &section)</td></tr> +<tr><td nowrap align=right valign=top><a name="b2" doxytag="SWMgr::DeleteMods"></a> +void </td><td valign=bottom><b>DeleteMods</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="b3" doxytag="SWMgr::init"></a> +virtual void </td><td valign=bottom><b>init</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="b4" doxytag="SWMgr::AddModToConfig"></a> +virtual char </td><td valign=bottom><b>AddModToConfig</b> (int conffd, const char *fname)</td></tr> +<tr><td nowrap align=right valign=top><a name="b5" doxytag="SWMgr::loadConfigDir"></a> +virtual void </td><td valign=bottom><b>loadConfigDir</b> (const char *ipath)</td></tr> +<tr><td nowrap align=right valign=top><a name="b6" doxytag="SWMgr::AddGlobalOptions"></a> +virtual void </td><td valign=bottom><b>AddGlobalOptions</b> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)</td></tr> +<tr><td nowrap align=right valign=top><a name="b7" doxytag="SWMgr::AddLocalOptions"></a> +virtual void </td><td valign=bottom><b>AddLocalOptions</b> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#b8">AddEncodingFilters</a> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the encoding filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module".</em> <a href="#b8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#b9">AddRenderFilters</a> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the render filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module".</em> <a href="#b9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#b10">AddStripFilters</a> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the strip filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module".</em> <a href="#b10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_mgr.html#b11">AddRawFilters</a> (<a class="el" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the raw filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module".</em> <a href="#b11">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWMgr::filterMgr"></a> +SWFilterMgr * </td><td valign=bottom><b>filterMgr</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWMgr::myconfig"></a> +<a class="el" href="class_s_w_config.html">SWConfig</a> * </td><td valign=bottom><b>myconfig</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWMgr::mysysconfig"></a> +<a class="el" href="class_s_w_config.html">SWConfig</a> * </td><td valign=bottom><b>mysysconfig</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n3" doxytag="SWMgr::configType"></a> +char </td><td valign=bottom><b>configType</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n4" doxytag="SWMgr::optionFilters"></a> +FilterMap </td><td valign=bottom><b>optionFilters</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n5" doxytag="SWMgr::cipherFilters"></a> +FilterMap </td><td valign=bottom><b>cipherFilters</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n6" doxytag="SWMgr::gbfplain"></a> +SWFilter * </td><td valign=bottom><b>gbfplain</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n7" doxytag="SWMgr::thmlplain"></a> +SWFilter * </td><td valign=bottom><b>thmlplain</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n8" doxytag="SWMgr::cleanupFilters"></a> +FilterList </td><td valign=bottom><b>cleanupFilters</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n9" doxytag="SWMgr::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="SWMgr::commonInit"></a> +void </td><td valign=bottom><b>commonInit</b> (<a class="el" href="class_s_w_config.html">SWConfig</a> *iconfig, <a class="el" href="class_s_w_config.html">SWConfig</a> *isysconfig, bool autoload, SWFilterMgr *filterMgr)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +SWMgr is the main class of the Sword library. +<p> +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). +<p> +To get the <a class="el" href="class_s_w_module.html">SWModule</a> objects of the instalelled modules use <a class="el" href="class_s_w_mgr.html#m2">Modules</a> for this. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_s_w_mgr.html#b11">AddRawFilters</a>(), <a class="el" href="class_s_w_mgr.html#b9">AddRenderFilters</a>(), <a class="el" href="class_s_w_mgr.html#b10">AddStripFilters</a>() </dl><dl compact><dt> +<b>Version: </b><dd> +</dl><dl compact><dt> +<b>Id: </b><dd> + swmgr.h,v 1.36 2002/01/04 23:36:32 scribe Exp </dl> +<p> + +<p> +Definition at line <a class="el" href="swmgr_8h-source.html#l00069">69</a> of file <a class="el" href="swmgr_8h-source.html">swmgr.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWMgr::SWMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWMgr::SWMgr + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_config.html">SWConfig</a> * </td> + <td class="mdname"> <em>iconfig</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_config.html">SWConfig</a> * </td> + <td class="mdname"> <em>isysconfig</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">bool </td> + <td class="mdname"> <em>autoload</em> = true, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWFilterMgr * </td> + <td class="mdname"> <em>filterMgr</em> = 0 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor of SWMgr. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iconfig +</em> </td><td> +</td></tr> +<tr><td valign=top><em>isysconfig +</em> </td><td> +</td></tr> +<tr><td valign=top><em>autoload +</em> </td><td> +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. </td></tr> +<tr><td valign=top><em>filterMgr +</em> </td><td> +an SWFilterMgr subclass to use to manager filters on modules THIS WILL BE DELETED BY SWMgr </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="SWMgr::SWMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWMgr::SWMgr + </td> + <td class="md">( </td> + <td class="md">SWFilterMgr * </td> + <td class="mdname"> <em>filterMgr</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>filterMgr +</em> </td><td> +an SWFilterMgr subclass to use to manager filters on modules THIS WILL BE DELETED BY SWMgr </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a2" doxytag="SWMgr::SWMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWMgr::SWMgr + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>iConfigPath</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">bool </td> + <td class="mdname"> <em>autoload</em> = true, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWFilterMgr * </td> + <td class="mdname"> <em>filterMgr</em> = 0 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>autoload +</em> </td><td> +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. </td></tr> +<tr><td valign=top><em>filterMgr +</em> </td><td> +an SWFilterMgr subclass to use to manager filters on modules THIS WILL BE DELETED BY SWMgr </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a3" doxytag="SWMgr::~SWMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWMgr::~SWMgr + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The destructor of SWMgr. +<p> +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 <a class="el" href="class_s_w_module.html">SWModule</a> objects become invalid. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="b8" doxytag="SWMgr::AddEncodingFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWMgr::AddEncodingFilters + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> * </td> + <td class="mdname"> <em>module</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">ConfigEntMap & </td> + <td class="mdname"> <em>section</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [protected, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the encoding filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module +</em> </td><td> +To this module the encoding filter(s) are added </td></tr> +<tr><td valign=top><em>section +</em> </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="b11" doxytag="SWMgr::AddRawFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWMgr::AddRawFilters + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> * </td> + <td class="mdname"> <em>module</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">ConfigEntMap & </td> + <td class="mdname"> <em>section</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [protected, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the raw filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module +</em> </td><td> +To this module the raw filter(s) are added </td></tr> +<tr><td valign=top><em>section +</em> </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="b9" doxytag="SWMgr::AddRenderFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWMgr::AddRenderFilters + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> * </td> + <td class="mdname"> <em>module</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">ConfigEntMap & </td> + <td class="mdname"> <em>section</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [protected, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the render filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module +</em> </td><td> +To this module the render filter(s) are added </td></tr> +<tr><td valign=top><em>section +</em> </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="b10" doxytag="SWMgr::AddStripFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWMgr::AddStripFilters + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_module.html">SWModule</a> * </td> + <td class="mdname"> <em>module</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">ConfigEntMap & </td> + <td class="mdname"> <em>section</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [protected, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the strip filters which are defined in "section" to the <a class="el" href="class_s_w_module.html">SWModule</a> object "module". +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module +</em> </td><td> +To this module the strip filter(s) are added </td></tr> +<tr><td valign=top><em>section +</em> </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a4" doxytag="SWMgr::InstallScan"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWMgr::InstallScan + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>dir</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Installs a scan for modules in the directory givan as parameter. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>dir +</em> </td><td> +The directory where new modules should be searched. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a5" doxytag="SWMgr::Load"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWMgr::Load + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Load the modules. +<p> +Reimplement this function to use your own Load function, for example to use your own filters. </td> + </tr> +</table> +<a name="a7" doxytag="SWMgr::getGlobalOption"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWMgr::getGlobalOption + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>option</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gives the value of the given option. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>The +</em> </td><td> +option, which should be used to return the value of it </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +The value of the given option </dl> </td> + </tr> +</table> +<a name="a8" doxytag="SWMgr::getGlobalOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWMgr::getGlobalOptionTip + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>option</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gives a description for the given option. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>option +</em> </td><td> +The option, which should be used </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +A description of the given option </dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_s_w_mgr.html#a6">setGlobalOption</a>, <a class="el" href="class_s_w_mgr.html#a7">getGlobalOption</a>, <a class="el" href="class_s_w_mgr.html#a9">getGlobalOptions</a> </dl> </td> + </tr> +</table> +<a name="a9" doxytag="SWMgr::getGlobalOptions"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual OptionsList SWMgr::getGlobalOptions + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +A list of all availble options with the currently set values. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +This function returns a list of global options. </dl> </td> + </tr> +</table> +<a name="a11" doxytag="SWMgr::setCipherKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual signed char SWMgr::setCipherKey + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>modName</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>key</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the cipher key for the given module. +<p> +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: +<p> +<div class="fragment"><pre> SectionMap::iterator section; + ConfigEntMap::iterator entry; + DIR *dir = opendir(configPath); + <font class="keyword">struct </font>dirent *ent; + <font class="keywordtype">char</font>* modFile; + <font class="keywordflow">if</font> (dir) { <font class="comment">// find and update .conf file</font> + rewinddir(dir); + <font class="keywordflow">while</font> ((ent = readdir(dir))) + { + <font class="keywordflow">if</font> ((strcmp(ent->d_name, <font class="stringliteral">"."</font>)) && (strcmp(ent->d_name, <font class="stringliteral">".."</font>))) + { + modFile = m_backend->configPath; + modFile += <font class="stringliteral">"/"</font>; + modFile += ent->d_name; + <a class="code" href="class_s_w_config.html">SWConfig</a> *myConfig = <font class="keyword">new</font> SWConfig( modFile ); + section = myConfig->Sections.find( m_module->Name() ); + <font class="keywordflow">if</font> ( section != myConfig->Sections.end() ) + { + entry = section->second.find(<font class="stringliteral">"CipherKey"</font>); + <font class="keywordflow">if</font> (entry != section->second.end()) + { + entry->second = unlockKey;<font class="comment">//set cipher key</font> + myConfig-><a class="code" href="class_s_w_config.html#a3">Save</a>();<font class="comment">//save config file</font> + } + } + <font class="keyword">delete</font> myConfig; + } + } + } + closedir(dir);</pre></div><dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>modName +</em> </td><td> +For this module we change the unlockKey </td></tr> +</table> +</dl><dl compact><dt> +<b>an key This is the new unlck key we use for te module.</b><dd> +</dl> </td> + </tr> +</table> +<a name="a6" doxytag="SWMgr::setGlobalOption"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWMgr::setGlobalOption + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>option</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>value</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set a global option Set a global option using the parameters. +<p> +A global option could be for example footnotes. <dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>option +</em> </td><td> +The name of the option, for which you want to change the value. Well known and often used values are "Footnotes" or "Strongs" </td></tr> +<tr><td valign=top><em>value +</em> </td><td> +The value. Common values are "On" and "Off" </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="m2" doxytag="SWMgr::Modules"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +ModMap SWMgr::Modules + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The map of available modules. +<p> +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. +<p> +<div class="fragment"><pre> ModMap::iterator it; + <a class="code" href="class_s_w_module.html">SWModule</a>* curMod = 0; + + <font class="keywordflow">for</font> (it = Modules.begin(); it != Modules.end(); it++) { + curMod = (*it).second; + <font class="keywordflow">if</font> (!strcmp(curMod-><a class="code" href="class_s_w_module.html#a14">Type</a>(), <font class="stringliteral">"Biblical Texts"</font>)) { + <font class="comment">//do something with curMod</font> + } + <font class="keywordflow">else</font> <font class="keywordflow">if</font> (!strcmp(curMod-><a class="code" href="class_s_w_module.html#a14">Type</a>(), <font class="stringliteral">"Commentaries"</font>)) { + <font class="comment">//do something with curMod</font> + } + <font class="keywordflow">else</font> <font class="keywordflow">if</font> (!strcmp(curMod-><a class="code" href="class_s_w_module.html#a14">Type</a>(), <font class="stringliteral">"Lexicons / Dictionaries"</font>)) { + <font class="comment">//do something with curMod</font> + } + }</pre></div> +<p> +Definition at line <a class="el" href="swmgr_8h-source.html#l00170">170</a> of file <a class="el" href="swmgr_8h-source.html">swmgr.h</a>. </td> + </tr> +</table> +<a name="m0" doxytag="SWMgr::config"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +<a class="el" href="class_s_w_config.html">SWConfig</a>* SWMgr::config + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The global config object. +<p> +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(). +<p> +If you want to write to the modules config file read the informtaion of <a class="el" href="class_s_w_mgr.html#a11">setCipherKey</a>() for an example of this. +<p> +Definition at line <a class="el" href="swmgr_8h-source.html#l00143">143</a> of file <a class="el" href="swmgr_8h-source.html">swmgr.h</a>. </td> + </tr> +</table> +<a name="p0" doxytag="SWMgr::debug"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +bool SWMgr::debug<code> [static]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Enable / Disable debug output on runtime Set this to true to get more verbose output of SWMgr at runtime. +<p> +Set it to false to get no debug output. The default is "false". +<p> +Definition at line <a class="el" href="swmgr_8h-source.html#l00128">128</a> of file <a class="el" href="swmgr_8h-source.html">swmgr.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swmgr_8h-source.html">swmgr.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_module-members.html b/doc/api-documentation/html/class_s_w_module-members.html new file mode 100644 index 0000000..8fc973d --- /dev/null +++ b/doc/api-documentation/html/class_s_w_module-members.html @@ -0,0 +1,82 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWModule Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_module.html">SWModule</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_module.html#a42">AddEncodingFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a51">AddOptionFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a48">AddRawFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a38">AddRenderFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a46">AddStripFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a23">CreateKey</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#d1">createModule</a>(const char *) +<code> [inline, static]</code><li><b>createSearchFramework</b>() (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a32">deleteEntry</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a13">Description</a>(const char *imoddesc=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a15">Direction</a>(signed char newdir=-1) +<code> [virtual]</code><li><b>direction</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a11">Disp</a>(SWDisplay *idisp=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#n10">disp</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a10">Display</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a16">Encoding</a>(signed char enc=-1) +<code> [virtual]</code><li><b>encoding</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a45">encodingFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n16">encodingFilters</a> +<code> [protected]</code><li><b>entrybuf</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>entrySize</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a2">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a49">filterBuffer</a>(FilterList *filters, char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a4">getEntrySize</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a25">getRawEntry</a>()=0 +<code> [pure virtual]</code><li><b>hasSearchFramework</b>() (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a22">isSearchOptimallySupported</a>(const char *istr, int searchType, int flags, SWKey *scope) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a3">isUnicode</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a28">isWritable</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n1">key</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a7">Key</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a8">Key</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a9">KeyText</a>(const char *imodtype=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a18">Lang</a>(const char *imodlang=0) +<code> [virtual]</code><li><b>listkey</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a17">Markup</a>(signed char enc=-1) +<code> [virtual]</code><li><b>markup</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>moddesc</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modlang</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modname</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modtype</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a12">Name</a>(const char *imodname=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#d0">nullPercent</a>(char percent, void *userData) +<code> [static]</code><li><a class="el" href="class_s_w_module.html#a24">operator char *</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a26">operator SWKey &</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a27">operator SWKey *</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a35">operator++</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a34">operator+=</a>(int increment) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a36">operator--</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a33">operator-=</a>(int decrement) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a30">operator<<</a>(const char *) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a31">operator<<</a>(const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a37">operator=</a>(SW_POSITION p) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a52">optionFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n15">optionFilters</a> +<code> [protected]</code><li><b>rawdisp</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected, static]</code><li><a class="el" href="class_s_w_module.html#a50">rawFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n13">rawFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a43">RemoveEncodingFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a39">RemoveRenderFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><b>render</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a41">renderFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n14">renderFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a54">RenderText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a56">RenderText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a44">ReplaceEncodingFilter</a>(SWFilter *oldfilter, SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a40">ReplaceRenderFilter</a>(SWFilter *oldfilter, SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a19">Search</a>(const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a29">setentry</a>(const char *inbuf, long len) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a5">SetKey</a>(const SWKey *ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a6">SetKey</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a47">stripFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n12">stripFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a53">StripText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a55">StripText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a0">SWModule</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char *imodtype=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *modlang=0) +<li><a class="el" href="class_s_w_module.html#m0">terminateSearch</a> +<li><a class="el" href="class_s_w_module.html#a14">Type</a>(const char *imodtype=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a1">~SWModule</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_module.gif b/doc/api-documentation/html/class_s_w_module.gif Binary files differnew file mode 100644 index 0000000..19a75fe --- /dev/null +++ b/doc/api-documentation/html/class_s_w_module.gif diff --git a/doc/api-documentation/html/class_s_w_module.html b/doc/api-documentation/html/class_s_w_module.html new file mode 100644 index 0000000..37bfce4 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_module.html @@ -0,0 +1,2862 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWModule class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWModule Class Reference</h1>The class SWModule is the base class for all modules used in Sword. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swmodule_8h-source.html">swmodule.h</a>></code> +<p> +<p>Inheritance diagram for SWModule:: +<p><center><img src="class_s_w_module.gif" usemap="#SWModule_map" border="0"></center> +<map name="SWModule_map"> +<area href="class_s_w_com.html" alt="SWCom" shape="rect" coords="0,56,73,80"> +<area href="class_s_w_l_d.html" alt="SWLD" shape="rect" coords="83,56,156,80"> +<area href="class_s_w_text.html" alt="SWText" shape="rect" coords="166,56,239,80"> +</map> +<a href="class_s_w_module-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_module.html#a0">SWModule</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_s_w_display.html">SWDisplay</a> *idisp=0, char *imodtype=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *modlang=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Initializes data for instance of SWModule.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWModule::~SWModule"></a> +virtual </td><td valign=bottom><a class="el" href="class_s_w_module.html#a1">~SWModule</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Cleans up instance of SWModule.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_module.html#a2">Error</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Gets and clears error status.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const bool </td><td valign=bottom><a class="el" href="class_s_w_module.html#a3">isUnicode</a> () const</td></tr> +<tr><td nowrap align=right valign=top>virtual const int </td><td valign=bottom><a class="el" href="class_s_w_module.html#a4">getEntrySize</a> () const</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_module.html#a5">SetKey</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> *ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets a key to this module for position to a particular record or set of records.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_module.html#a6">SetKey</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the key of this module.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_key.html">SWKey</a> & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a7">Key</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets the current module key.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_module.html#a8">Key</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the current key of the module to ikey, and returns the keytext.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a9">KeyText</a> (const char *imodtype=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module KeyText.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_module.html#a10">Display</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Calls this modules display object and passes itself.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_display.html">SWDisplay</a> * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a11">Disp</a> (<a class="el" href="class_s_w_display.html">SWDisplay</a> *idisp=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets display driver.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a12">Name</a> (const char *imodname=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module name.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a13">Description</a> (const char *imoddesc=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module description.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a14">Type</a> (const char *imodtype=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module type.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_module.html#a15">Direction</a> (signed char newdir=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module direction.</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_module.html#a16">Encoding</a> (signed char enc=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module encoding.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_s_w_module.html#a17">Markup</a> (signed char enc=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module markup.</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a18">Lang</a> (const char *imodlang=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module language.</em> <a href="#a18">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_list_key.html">ListKey</a> & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a19">Search</a> (const char *istr, int searchType=0, int flags=0, <a class="el" href="class_s_w_key.html">SWKey</a> *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Searches a module for a string.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a20" doxytag="SWModule::createSearchFramework"></a> +virtual signed char </td><td valign=bottom><b>createSearchFramework</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a21" doxytag="SWModule::hasSearchFramework"></a> +virtual bool </td><td valign=bottom><b>hasSearchFramework</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="class_s_w_module.html#a22">isSearchOptimallySupported</a> (const char *istr, int searchType, int flags, <a class="el" href="class_s_w_key.html">SWKey</a> *scope)</td></tr> +<tr><td> </td><td><font size=-1><em>Check if the search is optimally supported (e.g.</em> <a href="#a22">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a23">CreateKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Allocates a key of specific type for module The different reimplementatiosn of SWModule (e.g.</em> <a href="#a23">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_s_w_module.html#a24">operator char *</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Renders and returns the current module text.</em> <a href="#a24">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a25">getRawEntry</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>This function is reimplemented by the different kinds of module objects.</em> <a href="#a25">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_s_w_module.html#a26">operator SWKey &</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Cast operator to cast to a <a class="el" href="class_s_w_key.html">SWKey</a> reference.</em> <a href="#a26">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_s_w_module.html#a27">operator SWKey *</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Operator to cast to an <a class="el" href="class_s_w_key.html">SWKey</a> pointer.</em> <a href="#a27">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="class_s_w_module.html#a28">isWritable</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Is the module writable? :).</em> <a href="#a28">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a29">setentry</a> (const char *inbuf, long len)</td></tr> +<tr><td> </td><td><font size=-1><em>Modify the current module entry text only if module <a class="el" href="class_s_w_module.html#a28">isWritable</a>.</em> <a href="#a29">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a30">operator<<</a> (const char *)</td></tr> +<tr><td> </td><td><font size=-1><em>Modify the current module entry text only if module <a class="el" href="class_s_w_module.html#a28">isWritable</a>.</em> <a href="#a30">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a31">operator<<</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> *)</td></tr> +<tr><td> </td><td><font size=-1><em>Link the current module entry to another module entry only if module <a class="el" href="class_s_w_module.html#a28">isWritable</a>.</em> <a href="#a31">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a32" doxytag="SWModule::deleteEntry"></a> +virtual void </td><td valign=bottom><a class="el" href="class_s_w_module.html#a32">deleteEntry</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Delete current module entry - only if module <a class="el" href="class_s_w_module.html#a28">isWritable</a>.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a33">operator-=</a> (int decrement)</td></tr> +<tr><td> </td><td><font size=-1><em>Decrements module key a number of entries.</em> <a href="#a33">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a34">operator+=</a> (int increment)</td></tr> +<tr><td> </td><td><font size=-1><em>Increments module key a number of entries.</em> <a href="#a34">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a35" doxytag="SWModule::operator++"></a> +virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a35">operator++</a> (int)</td></tr> +<tr><td> </td><td><font size=-1><em>Increments module key by 1 entry.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a36" doxytag="SWModule::operator--"></a> +virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a36">operator--</a> (int)</td></tr> +<tr><td> </td><td><font size=-1><em>Decrements module key by 1 entry.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a37">operator=</a> (SW_POSITION p)</td></tr> +<tr><td> </td><td><font size=-1><em>Positions this modules to an entry.</em> <a href="#a37">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a38">AddRenderFilter</a> (SWFilter *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds a RenderFilter to this module's.</em> <a href="#a38">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a39">RemoveRenderFilter</a> (SWFilter *oldfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Removes a RenderFilter from this module's.</em> <a href="#a39">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a40">ReplaceRenderFilter</a> (SWFilter *oldfilter, SWFilter *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Replaces a RenderFilter in this module's.</em> <a href="#a40">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_module.html#a41">renderFilter</a> (char *buf, long size, <a class="el" href="class_s_w_key.html">SWKey</a> *<a class="el" href="class_s_w_module.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>RenderFilter a text buffer.</em> <a href="#a41">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a42">AddEncodingFilter</a> (SWFilter *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds an EncodingFilter to this module's.</em> <a href="#a42">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a43">RemoveEncodingFilter</a> (SWFilter *oldfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Removes an EncodingFilter from this module's.</em> <a href="#a43">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a44">ReplaceEncodingFilter</a> (SWFilter *oldfilter, SWFilter *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Replaces an EncodingFilter in this module's.</em> <a href="#a44">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_module.html#a45">encodingFilter</a> (char *buf, long size, <a class="el" href="class_s_w_key.html">SWKey</a> *<a class="el" href="class_s_w_module.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>encodingFilter a text buffer.</em> <a href="#a45">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a46">AddStripFilter</a> (SWFilter *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds a StripFilter to this module's stripfilters queue.</em> <a href="#a46">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_module.html#a47">stripFilter</a> (char *buf, long size, <a class="el" href="class_s_w_key.html">SWKey</a> *<a class="el" href="class_s_w_module.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>StripFilter a text buffer.</em> <a href="#a47">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a48">AddRawFilter</a> (SWFilter *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds a RawFilter to this module's rawfilters queue.</em> <a href="#a48">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_module.html#a49">filterBuffer</a> (FilterList *filters, char *buf, long size, <a class="el" href="class_s_w_key.html">SWKey</a> *<a class="el" href="class_s_w_module.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>FilterBuffer a text buffer.</em> <a href="#a49">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_module.html#a50">rawFilter</a> (char *buf, long size, <a class="el" href="class_s_w_key.html">SWKey</a> *<a class="el" href="class_s_w_module.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>RawFilter a text buffer.</em> <a href="#a50">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule & </td><td valign=bottom><a class="el" href="class_s_w_module.html#a51">AddOptionFilter</a> (SWFilter *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds an OptionFilter to this module's optionfilters queue.</em> <a href="#a51">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_s_w_module.html#a52">optionFilter</a> (char *buf, long size, <a class="el" href="class_s_w_key.html">SWKey</a> *<a class="el" href="class_s_w_module.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>OptionFilter a text buffer.</em> <a href="#a52">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a53">StripText</a> (char *buf=0, int len=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>calls all StripFilters on buffer or current text.</em> <a href="#a53">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a54">RenderText</a> (char *buf=0, int len=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>calls all RenderFilters on buffer or current text.</em> <a href="#a54">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a55">StripText</a> (<a class="el" href="class_s_w_key.html">SWKey</a> *tmpKey)</td></tr> +<tr><td> </td><td><font size=-1><em>calls all StripFilters on current text.</em> <a href="#a55">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char * </td><td valign=bottom><a class="el" href="class_s_w_module.html#a56">RenderText</a> (<a class="el" href="class_s_w_key.html">SWKey</a> *tmpKey)</td></tr> +<tr><td> </td><td><font size=-1><em>calls all RenderFilters on current text.</em> <a href="#a56">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_s_w_module.html#d0">nullPercent</a> (char percent, void *userData)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the default callback function for searching.</em> <a href="#d0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>signed char </td><td valign=bottom><a class="el" href="class_s_w_module.html#d1">createModule</a> (const char *)</td></tr> +<tr><td> </td><td><font size=-1><em>Creates a new module.</em> <a href="#d1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_s_w_module.html#m0">terminateSearch</a></td></tr> +<tr><td> </td><td><font size=-1><em>Set this bool to false to terminate the search which is executed by this module (<a class="el" href="class_s_w_module.html#a19">Search</a>).</em> <a href="#m0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWModule::error"></a> +char </td><td valign=bottom><b>error</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWModule::key"></a> +<a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_s_w_module.html#n1">key</a></td></tr> +<tr><td> </td><td><font size=-1><em>the current key.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWModule::listkey"></a> +<a class="el" href="class_list_key.html">ListKey</a> </td><td valign=bottom><b>listkey</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n3" doxytag="SWModule::modname"></a> +char * </td><td valign=bottom><b>modname</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n4" doxytag="SWModule::moddesc"></a> +char * </td><td valign=bottom><b>moddesc</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n5" doxytag="SWModule::modtype"></a> +char * </td><td valign=bottom><b>modtype</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n6" doxytag="SWModule::modlang"></a> +char * </td><td valign=bottom><b>modlang</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n7" doxytag="SWModule::direction"></a> +char </td><td valign=bottom><b>direction</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n8" doxytag="SWModule::markup"></a> +char </td><td valign=bottom><b>markup</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n9" doxytag="SWModule::encoding"></a> +char </td><td valign=bottom><b>encoding</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n10" doxytag="SWModule::disp"></a> +<a class="el" href="class_s_w_display.html">SWDisplay</a> * </td><td valign=bottom><a class="el" href="class_s_w_module.html#n10">disp</a></td></tr> +<tr><td> </td><td><font size=-1><em>this module's display object.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n11" doxytag="SWModule::entrybuf"></a> +char * </td><td valign=bottom><b>entrybuf</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n12" doxytag="SWModule::stripFilters"></a> +FilterList * </td><td valign=bottom><a class="el" href="class_s_w_module.html#n12">stripFilters</a></td></tr> +<tr><td> </td><td><font size=-1><em>executed to remove all markup (for searches).</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n13" doxytag="SWModule::rawFilters"></a> +FilterList * </td><td valign=bottom><a class="el" href="class_s_w_module.html#n13">rawFilters</a></td></tr> +<tr><td> </td><td><font size=-1><em>executed immediately upon fileread.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n14" doxytag="SWModule::renderFilters"></a> +FilterList * </td><td valign=bottom><a class="el" href="class_s_w_module.html#n14">renderFilters</a></td></tr> +<tr><td> </td><td><font size=-1><em>executed to format for display.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n15" doxytag="SWModule::optionFilters"></a> +FilterList * </td><td valign=bottom><a class="el" href="class_s_w_module.html#n15">optionFilters</a></td></tr> +<tr><td> </td><td><font size=-1><em>executed to change markup to user prefs.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n16" doxytag="SWModule::encodingFilters"></a> +FilterList * </td><td valign=bottom><a class="el" href="class_s_w_module.html#n16">encodingFilters</a></td></tr> +<tr><td> </td><td><font size=-1><em>executed to decode text for display.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n17" doxytag="SWModule::render"></a> +bool </td><td valign=bottom><b>render</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n18" doxytag="SWModule::entrySize"></a> +int </td><td valign=bottom><b>entrySize</b></td></tr> +<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="q0" doxytag="SWModule::rawdisp"></a> +<a class="el" href="class_s_w_display.html">SWDisplay</a> </td><td valign=bottom><b>rawdisp</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The class SWModule is the base class for all modules used in Sword. +<p> +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. +<p> +SWModule has also functions to write to the data files. This might be useful in future for frontend authors to support user-created modules. +<p> + +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00057">57</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWModule::SWModule"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWModule::SWModule + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>imodname</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>imoddesc</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_display.html">SWDisplay</a> * </td> + <td class="mdname"> <em>idisp</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">char * </td> + <td class="mdname"> <em>imodtype</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextEncoding </td> + <td class="mdname"> <em>encoding</em> = ENC_UNKNOWN, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextDirection </td> + <td class="mdname"> <em>dir</em> = DIRECTION_LTR, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextMarkup </td> + <td class="mdname"> <em>markup</em> = FMT_UNKNOWN, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>modlang</em> = 0 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initializes data for instance of SWModule. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodname +</em> </td><td> +Internal name for module; see also <a class="el" href="class_s_w_module.html#a12">Name</a> </td></tr> +<tr><td valign=top><em>imoddesc +</em> </td><td> +Name to display to user for module; see also <a class="el" href="class_s_w_module.html#a13">Description</a> </td></tr> +<tr><td valign=top><em>idisp +</em> </td><td> +Display object to use for displaying see also <a class="el" href="class_s_w_module.html#a11">Disp</a> </td></tr> +<tr><td valign=top><em>imodtype +</em> </td><td> +Type of Module (All modules will be displayed with others of same type under their modtype heading) see also <a class="el" href="class_s_w_module.html#a14">Type</a> </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a42" doxytag="SWModule::AddEncodingFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::AddEncodingFilter + </td> + <td class="md">( </td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>newfilter</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds an EncodingFilter to this module's. +<p> +<dl compact><dt> +<b>See also: </b><dd> +encodingfilters queue </dl><dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newfilter +</em> </td><td> +the filter to add </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00430">430</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a51" doxytag="SWModule::AddOptionFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::AddOptionFilter + </td> + <td class="md">( </td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>newfilter</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds an OptionFilter to this module's optionfilters queue. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newfilter +</em> </td><td> +the filter to add </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00515">515</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a48" doxytag="SWModule::AddRawFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::AddRawFilter + </td> + <td class="md">( </td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>newfilter</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds a RawFilter to this module's rawfilters queue. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newfilter +</em> </td><td> +the filter to add </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00484">484</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a38" doxytag="SWModule::AddRenderFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::AddRenderFilter + </td> + <td class="md">( </td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>newfilter</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds a RenderFilter to this module's. +<p> +<dl compact><dt> +<b>See also: </b><dd> +renderfilters queue </dl><dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newfilter +</em> </td><td> +the filter to add </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00393">393</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a46" doxytag="SWModule::AddStripFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::AddStripFilter + </td> + <td class="md">( </td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>newfilter</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds a StripFilter to this module's stripfilters queue. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newfilter +</em> </td><td> +the filter to add </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00467">467</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a23" doxytag="SWModule::CreateKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual <a class="el" href="class_s_w_key.html">SWKey</a>* SWModule::CreateKey + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Allocates a key of specific type for module The different reimplementatiosn of SWModule (e.g. +<p> +<a class="el" href="class_s_w_text.html">SWText</a>) support <a class="el" href="class_s_w_key.html">SWKey</a> implementations, which support special. This functions returns a <a class="el" href="class_s_w_key.html">SWKey</a> object which works with the current implementation of SWModule. For example for the <a class="el" href="class_s_w_text.html">SWText</a> class it returns a <a class="el" href="class_verse_key.html">VerseKey</a> object. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_verse_key.html">VerseKey</a>, <a class="el" href="class_list_key.html">ListKey</a>, <a class="el" href="class_s_w_text.html">SWText</a>, <a class="el" href="class_s_w_l_d.html">SWLD</a>, <a class="el" href="class_s_w_com.html">SWCom</a> </dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to allocated key </dl> +<p> +Reimplemented in <a class="el" href="class_s_w_com.html#a2">SWCom</a>, <a class="el" href="class_s_w_l_d.html#a2">SWLD</a>, and <a class="el" href="class_s_w_text.html#a2">SWText</a>. </td> + </tr> +</table> +<a name="a13" doxytag="SWModule::Description"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char* SWModule::Description + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>imoddesc</em> = 0 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module description. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imoddesc +</em> </td><td> +value which to set moddesc; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to moddesc </dl> </td> + </tr> +</table> +<a name="a15" doxytag="SWModule::Direction"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWModule::Direction + </td> + <td class="md">( </td> + <td class="md">signed char </td> + <td class="mdname"> <em>newdir</em> = -1 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module direction. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newdir +</em> </td><td> +value which to set direction; [-1] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +char direction </dl> </td> + </tr> +</table> +<a name="a11" doxytag="SWModule::Disp"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual <a class="el" href="class_s_w_display.html">SWDisplay</a>* SWModule::Disp + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_display.html">SWDisplay</a> * </td> + <td class="mdname"> <em>idisp</em> = 0 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets display driver. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>idisp +</em> </td><td> +value which to set disp; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to disp </dl> </td> + </tr> +</table> +<a name="a10" doxytag="SWModule::Display"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWModule::Display + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Calls this modules display object and passes itself. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +error status </dl> </td> + </tr> +</table> +<a name="a16" doxytag="SWModule::Encoding"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWModule::Encoding + </td> + <td class="md">( </td> + <td class="md">signed char </td> + <td class="mdname"> <em>enc</em> = -1 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module encoding. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newdir +</em> </td><td> +value which to set encoding; [-1] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +char encoding </dl> </td> + </tr> +</table> +<a name="a2" doxytag="SWModule::Error"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWModule::Error + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets and clears error status. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +error status </dl> </td> + </tr> +</table> +<a name="a8" doxytag="SWModule::Key"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWModule::Key + </td> + <td class="md">( </td> + <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the current key of the module to ikey, and returns the keytext. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +new current key for the module </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +the keytext of the current module key </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00168">168</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="SWModule::Key"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual <a class="el" href="class_s_w_key.html">SWKey</a>& SWModule::Key + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets the current module key. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +the current key of this module </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00159">159</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a9" doxytag="SWModule::KeyText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWModule::KeyText + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ikeytext</em> = 0 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module KeyText. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikeytext +</em> </td><td> +value which to set keytext; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to keytext </dl> +<p> +Reimplemented in <a class="el" href="class_s_w_l_d.html#a3">SWLD</a>. </td> + </tr> +</table> +<a name="a18" doxytag="SWModule::Lang"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char* SWModule::Lang + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>imodlang</em> = 0 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module language. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodlang +</em> </td><td> +value which to set modlang; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to modlang </dl> </td> + </tr> +</table> +<a name="a17" doxytag="SWModule::Markup"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWModule::Markup + </td> + <td class="md">( </td> + <td class="md">signed char </td> + <td class="mdname"> <em>enc</em> = -1 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module markup. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newdir +</em> </td><td> +value which to set markup; [-1] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +char markup </dl> </td> + </tr> +</table> +<a name="a12" doxytag="SWModule::Name"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char* SWModule::Name + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>imodname</em> = 0 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module name. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodname +</em> </td><td> +value which to set modname; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to modname </dl> </td> + </tr> +</table> +<a name="a43" doxytag="SWModule::RemoveEncodingFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::RemoveEncodingFilter + </td> + <td class="md">( </td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>oldfilter</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Removes an EncodingFilter from this module's. +<p> +<dl compact><dt> +<b>See also: </b><dd> +encodingfilters queue </dl><dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>oldfilter +</em> </td><td> +the filter to remove </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00438">438</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a39" doxytag="SWModule::RemoveRenderFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::RemoveRenderFilter + </td> + <td class="md">( </td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>oldfilter</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Removes a RenderFilter from this module's. +<p> +<dl compact><dt> +<b>See also: </b><dd> +renderfilters queue </dl><dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>oldfilter +</em> </td><td> +the filter to remove </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00401">401</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a56" doxytag="SWModule::RenderText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWModule::RenderText + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>tmpKey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +calls all RenderFilters on current text. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>tmpKey +</em> </td><td> +key to use to grab text </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +this module's text at specified key location massaged by Render filters </dl> </td> + </tr> +</table> +<a name="a54" doxytag="SWModule::RenderText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWModule::RenderText + </td> + <td class="md">( </td> + <td class="md">char * </td> + <td class="mdname"> <em>buf</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">int </td> + <td class="mdname"> <em>len</em> = -1 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +calls all RenderFilters on buffer or current text. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf +</em> </td><td> +buffer to Render instead of current module position; if buf is NULL, the current text will be used </td></tr> +<tr><td valign=top><em>len +</em> </td><td> +max len of buf OR current text -- will be applied anyway </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +this module's text at specified key location massaged by Render filters </dl> </td> + </tr> +</table> +<a name="a44" doxytag="SWModule::ReplaceEncodingFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::ReplaceEncodingFilter + </td> + <td class="md">( </td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>oldfilter</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>newfilter</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Replaces an EncodingFilter in this module's. +<p> +<dl compact><dt> +<b>See also: </b><dd> +encodingfilters queue </dl><dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>oldfilter +</em> </td><td> +the filter to remove </td></tr> +<tr><td valign=top><em>newfilter +</em> </td><td> +the filter to add in its place </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00447">447</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a40" doxytag="SWModule::ReplaceRenderFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::ReplaceRenderFilter + </td> + <td class="md">( </td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>oldfilter</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWFilter * </td> + <td class="mdname"> <em>newfilter</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Replaces a RenderFilter in this module's. +<p> +<dl compact><dt> +<b>See also: </b><dd> +renderfilters queue </dl><dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>oldfilter +</em> </td><td> +the filter to remove </td></tr> +<tr><td valign=top><em>newfilter +</em> </td><td> +the filter to add in its place </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00410">410</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a19" doxytag="SWModule::Search"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual <a class="el" href="class_list_key.html">ListKey</a>& SWModule::Search + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>istr</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">int </td> + <td class="mdname"> <em>searchType</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">int </td> + <td class="mdname"> <em>flags</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>scope</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">bool * </td> + <td class="mdname"> <em>justCheckIfSupported</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">void(* </td> + <td class="mdname"> <em>percent</em>)(char, void *) = &nullPercent, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">void * </td> + <td class="mdname"> <em>percentUserData</em> = 0 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Searches a module for a string. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>istr +</em> </td><td> +string for which to search </td></tr> +<tr><td valign=top><em>searchType +</em> </td><td> +type of search to perform <=0 ->regex; 1->phrase; 2->multiword; </td></tr> +<tr><td valign=top><em>flags +</em> </td><td> +options flags for search </td></tr> +<tr><td valign=top><em>justCheckIfSupported +</em> </td><td> +if set, don't search, only tell if this function supports requested search. +<p> +</td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +listkey set to verses that contain istr </dl> +<p> +Referenced by <a class="el" href="swmodule_8h-source.html#l00274">isSearchOptimallySupported</a>(). +<p> + </td> + </tr> +</table> +<a name="a6" doxytag="SWModule::SetKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWModule::SetKey + </td> + <td class="md">( </td> + <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the key of this module. +<p> +Similair to <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_s_w_module.html#a5">SetKey</a>(const SWKey*) . </dl><dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +The <a class="el" href="class_s_w_key.html">SWKey</a> which should be used as new key. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Error status </dl> </td> + </tr> +</table> +<a name="a5" doxytag="SWModule::SetKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char SWModule::SetKey + </td> + <td class="md">( </td> + <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets a key to this module for position to a particular record or set of records. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +key with which to set this module </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +error status </dl> +<p> +Referenced by <a class="el" href="swmodule_8h-source.html#l00168">Key</a>(). +<p> + </td> + </tr> +</table> +<a name="a55" doxytag="SWModule::StripText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWModule::StripText + </td> + <td class="md">( </td> + <td class="md"><a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>tmpKey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +calls all StripFilters on current text. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>tmpKey +</em> </td><td> +key to use to grab text </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +this module's text at specified key location massaged by Strip filters </dl> </td> + </tr> +</table> +<a name="a53" doxytag="SWModule::StripText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const char* SWModule::StripText + </td> + <td class="md">( </td> + <td class="md">char * </td> + <td class="mdname"> <em>buf</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">int </td> + <td class="mdname"> <em>len</em> = -1 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +calls all StripFilters on buffer or current text. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf +</em> </td><td> +buf to massage instead of current module position; if buf is NULL, the current text will be used </td></tr> +<tr><td valign=top><em>len +</em> </td><td> +max len of buf OR current text -- will be applied anyway </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +this module's text at specified key location massaged by Strip filters </dl> </td> + </tr> +</table> +<a name="a14" doxytag="SWModule::Type"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char* SWModule::Type + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>imodtype</em> = 0 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module type. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodtype +</em> </td><td> +value which to set modtype; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to modtype </dl> </td> + </tr> +</table> +<a name="d1" doxytag="SWModule::createModule"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +signed char SWModule::createModule + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>path</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, static]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a new module. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>path +</em> </td><td> +The first parameter is path of the new module </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +error </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00328">328</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a45" doxytag="SWModule::encodingFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWModule::encodingFilter + </td> + <td class="md">( </td> + <td class="md">char * </td> + <td class="mdname"> <em>buf</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">long </td> + <td class="mdname"> <em>size</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>key</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +encodingFilter a text buffer. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf +</em> </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size +</em> </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key +</em> </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00460">460</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a49" doxytag="SWModule::filterBuffer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWModule::filterBuffer + </td> + <td class="md">( </td> + <td class="md">FilterList * </td> + <td class="mdname"> <em>filters</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">char * </td> + <td class="mdname"> <em>buf</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">long </td> + <td class="mdname"> <em>size</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>key</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +FilterBuffer a text buffer. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>filters +</em> </td><td> +the FilterList of filters to iterate </td></tr> +<tr><td valign=top><em>buf +</em> </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size +</em> </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key +</em> </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00495">495</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. +<p> +Referenced by <a class="el" href="swmodule_8h-source.html#l00460">encodingFilter</a>(), <a class="el" href="swmodule_8h-source.html#l00525">optionFilter</a>(), <a class="el" href="swmodule_8h-source.html#l00507">rawFilter</a>(), <a class="el" href="swmodule_8h-source.html#l00423">renderFilter</a>(), and <a class="el" href="swmodule_8h-source.html#l00477">stripFilter</a>(). +<p> + </td> + </tr> +</table> +<a name="a4" doxytag="SWModule::getEntrySize"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const int SWModule::getEntrySize + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt> +<b>Returns: </b><dd> +The size of the current entry. </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00141">141</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a25" doxytag="SWModule::getRawEntry"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char* SWModule::getRawEntry + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [pure virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This function is reimplemented by the different kinds of module objects. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +the raw module text of the current entry </dl> </td> + </tr> +</table> +<a name="a22" doxytag="SWModule::isSearchOptimallySupported"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual bool SWModule::isSearchOptimallySupported + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>istr</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">int </td> + <td class="mdname"> <em>searchType</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">int </td> + <td class="mdname"> <em>flags</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>scope</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Check if the search is optimally supported (e.g. +<p> +if index files are presnt and working) This function checks whether the search framework may work in the best way. <dl compact><dt> +<b>Returns: </b><dd> +True if the the search is optimally supported, false if it's not working in the best way. </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00274">274</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a3" doxytag="SWModule::isUnicode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual const bool SWModule::isUnicode + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt> +<b>Returns: </b><dd> +True if this module is encoded in Unicode, otherwise return false. </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00137">137</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a28" doxytag="SWModule::isWritable"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual bool SWModule::isWritable + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Is the module writable? :). +<p> +<dl compact><dt> +<b>Returns: </b><dd> +yes or no </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00321">321</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="d0" doxytag="SWModule::nullPercent"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +void SWModule::nullPercent + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>percent</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">void * </td> + <td class="mdname"> <em>userData</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [static]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the default callback function for searching. +<p> +This function is a placeholder and does nothing. You can define your own function for search progress evaluation, and pass it over to <a class="el" href="class_s_w_module.html#a19">Search</a>. </td> + </tr> +</table> +<a name="a26" doxytag="SWModule::operator SWKey &"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule::operator <a class="el" href="class_s_w_key.html">SWKey</a> & + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Cast operator to cast to a <a class="el" href="class_s_w_key.html">SWKey</a> reference. +<p> +This operator may be used to cast this module to a <a class="el" href="class_s_w_key.html">SWKey</a> object. <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_s_w_key.html">SWKey</a>*() </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00301">301</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a27" doxytag="SWModule::operator SWKey *"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule::operator <a class="el" href="class_s_w_key.html">SWKey</a> * + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Operator to cast to an <a class="el" href="class_s_w_key.html">SWKey</a> pointer. +<p> +This function may be used to cast this object to an <a class="el" href="class_s_w_key.html">SWKey</a> pointer. <div class="fragment"><pre> <font class="comment">//we assume here that SWModule* module is already defined and valid.</font> + <a class="code" href="class_s_w_key.html">SWKey</a>* currentKey = (<a class="code" href="class_s_w_key.html">SWKey</a>*)module; + <font class="comment">// do something with currentKey (e.g. print out on screen)</font></pre></div> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00312">312</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a24" doxytag="SWModule::operator char *"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule::operator char * + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Renders and returns the current module text. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +the rendered current module text </dl> </td> + </tr> +</table> +<a name="a34" doxytag="SWModule::operator+="></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::operator+= + </td> + <td class="md">( </td> + <td class="md">int </td> + <td class="mdname"> <em>increment</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Increments module key a number of entries. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>increment +</em> </td><td> +Number of entries to jump forward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> </td> + </tr> +</table> +<a name="a33" doxytag="SWModule::operator-="></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::operator-= + </td> + <td class="md">( </td> + <td class="md">int </td> + <td class="mdname"> <em>decrement</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Decrements module key a number of entries. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>decrement +</em> </td><td> +Number of entries to jump backward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> </td> + </tr> +</table> +<a name="a31" doxytag="SWModule::operator<<"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::operator<< + </td> + <td class="md">( </td> + <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>linkKey</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Link the current module entry to another module entry only if module <a class="el" href="class_s_w_module.html#a28">isWritable</a>. +<p> +<ul> +<li><dl compact><dt> +<b>Returns: </b><dd> +*this </dl></ul> + +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00349">349</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a30" doxytag="SWModule::operator<<"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::operator<< + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>inbuf</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Modify the current module entry text only if module <a class="el" href="class_s_w_module.html#a28">isWritable</a>. +<p> +<ul> +<li><dl compact><dt> +<b>Returns: </b><dd> +*this </dl></ul> + +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00342">342</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a37" doxytag="SWModule::operator="></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::operator= + </td> + <td class="md">( </td> + <td class="md">SW_POSITION </td> + <td class="mdname"> <em>pos</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Positions this modules to an entry. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>p +</em> </td><td> +position (e.g. TOP, BOTTOM) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> </td> + </tr> +</table> +<a name="a52" doxytag="SWModule::optionFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWModule::optionFilter + </td> + <td class="md">( </td> + <td class="md">char * </td> + <td class="mdname"> <em>buf</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">long </td> + <td class="mdname"> <em>size</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>key</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +OptionFilter a text buffer. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf +</em> </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size +</em> </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key +</em> </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00525">525</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a50" doxytag="SWModule::rawFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWModule::rawFilter + </td> + <td class="md">( </td> + <td class="md">char * </td> + <td class="mdname"> <em>buf</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">long </td> + <td class="mdname"> <em>size</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>key</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +RawFilter a text buffer. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf +</em> </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size +</em> </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key +</em> </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00507">507</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a41" doxytag="SWModule::renderFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWModule::renderFilter + </td> + <td class="md">( </td> + <td class="md">char * </td> + <td class="mdname"> <em>buf</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">long </td> + <td class="mdname"> <em>size</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>key</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +RenderFilter a text buffer. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf +</em> </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size +</em> </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key +</em> </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00423">423</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a29" doxytag="SWModule::setentry"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual SWModule& SWModule::setentry + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>inbuf</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">long </td> + <td class="mdname"> <em>len</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Modify the current module entry text only if module <a class="el" href="class_s_w_module.html#a28">isWritable</a>. +<p> +<ul> +<li><dl compact><dt> +<b>Returns: </b><dd> +*this </dl></ul> + +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00335">335</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a47" doxytag="SWModule::stripFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void SWModule::stripFilter + </td> + <td class="md">( </td> + <td class="md">char * </td> + <td class="mdname"> <em>buf</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">long </td> + <td class="mdname"> <em>size</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>key</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +StripFilter a text buffer. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf +</em> </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size +</em> </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key +</em> </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00477">477</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="m0" doxytag="SWModule::terminateSearch"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +bool SWModule::terminateSearch + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set this bool to false to terminate the search which is executed by this module (<a class="el" href="class_s_w_module.html#a19">Search</a>). +<p> +This is useful for threaded applications to terminate the search in another thread. +<p> +Definition at line <a class="el" href="swmodule_8h-source.html#l00112">112</a> of file <a class="el" href="swmodule_8h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swmodule_8h-source.html">swmodule.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_object-members.html b/doc/api-documentation/html/class_s_w_object-members.html new file mode 100644 index 0000000..548bffc --- /dev/null +++ b/doc/api-documentation/html/class_s_w_object-members.html @@ -0,0 +1,18 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWObject Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_object.html">SWObject</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_object.html#a0">getClass</a>() const +<code> [inline]</code><li><b>myclass</b> (defined in <a class="el" href="class_s_w_object.html">SWObject</a>)<code> [protected]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_object.gif b/doc/api-documentation/html/class_s_w_object.gif Binary files differnew file mode 100644 index 0000000..17d220d --- /dev/null +++ b/doc/api-documentation/html/class_s_w_object.gif diff --git a/doc/api-documentation/html/class_s_w_object.html b/doc/api-documentation/html/class_s_w_object.html new file mode 100644 index 0000000..7ad8223 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_object.html @@ -0,0 +1,82 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWObject class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWObject Class Reference</h1>Base class for major Sword classes. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swobject_8h-source.html">swobject.h</a>></code> +<p> +<p>Inheritance diagram for SWObject:: +<p><center><img src="class_s_w_object.gif" usemap="#SWObject_map" border="0"></center> +<map name="SWObject_map"> +<area href="class_s_w_key.html" alt="SWKey" shape="rect" coords="78,56,146,80"> +<area href="class_list_key.html" alt="ListKey" shape="rect" coords="0,112,68,136"> +<area href="class_str_key.html" alt="StrKey" shape="rect" coords="78,112,146,136"> +<area href="class_verse_key.html" alt="VerseKey" shape="rect" coords="156,112,224,136"> +</map> +<a href="class_s_w_object-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>const <a class="el" href="class_s_w_class.html">SWClass</a> * </td><td valign=bottom><a class="el" href="class_s_w_object.html#a0">getClass</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Use this to get the class definition and inheritance order.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWObject::myclass"></a> +<a class="el" href="class_s_w_class.html">SWClass</a> * </td><td valign=bottom><b>myclass</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Base class for major Sword classes. +<p> +SWObject is the base class for major Sword classes like <a class="el" href="class_s_w_key.html">SWKey</a>. 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). +<p> + +<p> +Definition at line <a class="el" href="swobject_8h-source.html#l00041">41</a> of file <a class="el" href="swobject_8h-source.html">swobject.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a0" doxytag="SWObject::getClass"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +const <a class="el" href="class_s_w_class.html">SWClass</a>* SWObject::getClass + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [inline]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Use this to get the class definition and inheritance order. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +The class definition of this object </dl> +<p> +Definition at line <a class="el" href="swobject_8h-source.html#l00049">49</a> of file <a class="el" href="swobject_8h-source.html">swobject.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swobject_8h-source.html">swobject.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_text-members.html b/doc/api-documentation/html/class_s_w_text-members.html new file mode 100644 index 0000000..d6068ad --- /dev/null +++ b/doc/api-documentation/html/class_s_w_text-members.html @@ -0,0 +1,83 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWText Member List</h1>This is the complete list of members for <a class="el" href="class_s_w_text.html">SWText</a>, including all inherited members.<ul> +<li><a class="el" href="class_s_w_module.html#a42">AddEncodingFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a51">AddOptionFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a48">AddRawFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a38">AddRenderFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a46">AddStripFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_text.html#a2">CreateKey</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#d1">createModule</a>(const char *) +<code> [inline, static]</code><li><b>createSearchFramework</b>() (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a32">deleteEntry</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a13">Description</a>(const char *imoddesc=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a15">Direction</a>(signed char newdir=-1) +<code> [virtual]</code><li><b>direction</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#n10">disp</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a11">Disp</a>(SWDisplay *idisp=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a10">Display</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a16">Encoding</a>(signed char enc=-1) +<code> [virtual]</code><li><b>encoding</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a45">encodingFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n16">encodingFilters</a> +<code> [protected]</code><li><b>entrybuf</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>entrySize</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a2">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a49">filterBuffer</a>(FilterList *filters, char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a4">getEntrySize</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a25">getRawEntry</a>()=0 +<code> [pure virtual]</code><li><b>hasSearchFramework</b>() (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a22">isSearchOptimallySupported</a>(const char *istr, int searchType, int flags, SWKey *scope) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a3">isUnicode</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a28">isWritable</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a7">Key</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a8">Key</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n1">key</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a9">KeyText</a>(const char *imodtype=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a18">Lang</a>(const char *imodlang=0) +<code> [virtual]</code><li><b>listkey</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a17">Markup</a>(signed char enc=-1) +<code> [virtual]</code><li><b>markup</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>moddesc</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modlang</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modname</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><b>modtype</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a12">Name</a>(const char *imodname=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#d0">nullPercent</a>(char percent, void *userData) +<code> [static]</code><li><a class="el" href="class_s_w_module.html#a24">operator char *</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a26">operator SWKey &</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a27">operator SWKey *</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a35">operator++</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a34">operator+=</a>(int increment) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a36">operator--</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a33">operator-=</a>(int decrement) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a30">operator<<</a>(const char *) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a31">operator<<</a>(const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a37">operator=</a>(SW_POSITION p) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a52">optionFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n15">optionFilters</a> +<code> [protected]</code><li><b>rawdisp</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected, static]</code><li><a class="el" href="class_s_w_module.html#a50">rawFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n13">rawFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a43">RemoveEncodingFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a39">RemoveRenderFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><b>render</b> (defined in <a class="el" href="class_s_w_module.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a41">renderFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n14">renderFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a54">RenderText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a56">RenderText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a44">ReplaceEncodingFilter</a>(SWFilter *oldfilter, SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a40">ReplaceRenderFilter</a>(SWFilter *oldfilter, SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a19">Search</a>(const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a29">setentry</a>(const char *inbuf, long len) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#a5">SetKey</a>(const SWKey *ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a6">SetKey</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a47">stripFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_module.html#n12">stripFilters</a> +<code> [protected]</code><li><a class="el" href="class_s_w_module.html#a53">StripText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a55">StripText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a0">SWModule</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char *imodtype=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *modlang=0) +<li><a class="el" href="class_s_w_text.html#a0">SWText</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *ilang=0) +<li><a class="el" href="class_s_w_module.html#m0">terminateSearch</a> +<li><a class="el" href="class_s_w_module.html#a14">Type</a>(const char *imodtype=0) +<code> [virtual]</code><li><a class="el" href="class_s_w_module.html#a1">~SWModule</a>() +<code> [virtual]</code><li><b>~SWText</b>() (defined in <a class="el" href="class_s_w_text.html">SWText</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_s_w_text.gif b/doc/api-documentation/html/class_s_w_text.gif Binary files differnew file mode 100644 index 0000000..5693191 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_text.gif diff --git a/doc/api-documentation/html/class_s_w_text.html b/doc/api-documentation/html/class_s_w_text.html new file mode 100644 index 0000000..bdc0b43 --- /dev/null +++ b/doc/api-documentation/html/class_s_w_text.html @@ -0,0 +1,146 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWText class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWText Class Reference</h1>The basis for all text modules. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swtext_8h-source.html">swtext.h</a>></code> +<p> +<p>Inheritance diagram for SWText:: +<p><center><img src="class_s_w_text.gif" usemap="#SWText_map" border="0"></center> +<map name="SWText_map"> +<area href="class_s_w_module.html" alt="SWModule" shape="rect" coords="0,0,73,24"> +</map> +<a href="class_s_w_text-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_text.html#a0">SWText</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_s_w_display.html">SWDisplay</a> *idisp=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *ilang=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Initializes data for instance of SWText.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWText::~SWText"></a> +virtual </td><td valign=bottom><b>~SWText</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="SWText::CreateKey"></a> +virtual <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_s_w_text.html#a2">CreateKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Create the correct key (<a class="el" href="class_verse_key.html">VerseKey</a>) for use with SWText.</em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The basis for all text modules. +<p> + +<p> +Definition at line <a class="el" href="swtext_8h-source.html#l00034">34</a> of file <a class="el" href="swtext_8h-source.html">swtext.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWText::SWText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +SWText::SWText + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>imodname</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>imoddesc</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md"><a class="el" href="class_s_w_display.html">SWDisplay</a> * </td> + <td class="mdname"> <em>idisp</em> = 0, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextEncoding </td> + <td class="mdname"> <em>encoding</em> = ENC_UNKNOWN, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextDirection </td> + <td class="mdname"> <em>dir</em> = DIRECTION_LTR, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">SWTextMarkup </td> + <td class="mdname"> <em>markup</em> = FMT_UNKNOWN, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>ilang</em> = 0 </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initializes data for instance of SWText. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodname +</em> </td><td> +Internal name for module </td></tr> +<tr><td valign=top><em>imoddesc +</em> </td><td> +Name to display to user for module </td></tr> +<tr><td valign=top><em>idisp +</em> </td><td> +Display object to use for displaying </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swtext_8h-source.html">swtext.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_scsuutf8-members.html b/doc/api-documentation/html/class_scsuutf8-members.html new file mode 100644 index 0000000..171839a --- /dev/null +++ b/doc/api-documentation/html/class_scsuutf8-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SCSUUTF8 Member List</h1>This is the complete list of members for <a class="el" href="class_scsuutf8.html">SCSUUTF8</a>, including all inherited members.<ul> +<li><b>c</b> (defined in <a class="el" href="class_scsuutf8.html">SCSUUTF8</a>)<code> [private]</code><li><b>d</b> (defined in <a class="el" href="class_scsuutf8.html">SCSUUTF8</a>)<code> [private]</code><li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_scsuutf8.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><b>SCSUUTF8</b>() (defined in <a class="el" href="class_scsuutf8.html">SCSUUTF8</a>)<li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>UTF8Output</b>(unsigned long, unsigned char *text) (defined in <a class="el" href="class_scsuutf8.html">SCSUUTF8</a>)<code> [private]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_scsuutf8.gif b/doc/api-documentation/html/class_scsuutf8.gif Binary files differnew file mode 100644 index 0000000..db2a474 --- /dev/null +++ b/doc/api-documentation/html/class_scsuutf8.gif diff --git a/doc/api-documentation/html/class_scsuutf8.html b/doc/api-documentation/html/class_scsuutf8.html new file mode 100644 index 0000000..c58ff31 --- /dev/null +++ b/doc/api-documentation/html/class_scsuutf8.html @@ -0,0 +1,109 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SCSUUTF8 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SCSUUTF8 Class Reference</h1>This filter converts SCSU compressed (encoded) text to UTF-8. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="scsuutf8_h-source.html">scsuutf8.h</a>></code> +<p> +<p>Inheritance diagram for SCSUUTF8:: +<p><center><img src="class_scsuutf8.gif" usemap="#SCSUUTF8_map" border="0"></center> +<map name="SCSUUTF8_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,75,24"> +</map> +<a href="class_scsuutf8-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SCSUUTF8::SCSUUTF8"></a> + </td><td valign=bottom><b>SCSUUTF8</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_scsuutf8.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="SCSUUTF8::UTF8Output"></a> +unsigned char* </td><td valign=bottom><b>UTF8Output</b> (unsigned long, unsigned char *text)</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="SCSUUTF8::c"></a> +unsigned long </td><td valign=bottom><b>c</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="SCSUUTF8::d"></a> +unsigned long </td><td valign=bottom><b>d</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts SCSU compressed (encoded) text to UTF-8. +<p> + +<p> +Definition at line <a class="el" href="scsuutf8_h-source.html#l00029">29</a> of file <a class="el" href="scsuutf8_h-source.html">scsuutf8.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="SCSUUTF8::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char SCSUUTF8::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="scsuutf8_h-source.html">scsuutf8.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_str_key-members.html b/doc/api-documentation/html/class_str_key-members.html new file mode 100644 index 0000000..fa36cf3 --- /dev/null +++ b/doc/api-documentation/html/class_str_key-members.html @@ -0,0 +1,35 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>StrKey Member List</h1>This is the complete list of members for <a class="el" href="class_str_key.html">StrKey</a>, including all inherited members.<ul> +<li><b>classdef</b> (defined in <a class="el" href="class_str_key.html">StrKey</a>)<code> [private, static]</code><li><a class="el" href="class_s_w_key.html#a3">clone</a>() const +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a10">compare</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a8">copyFrom</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a13">decrement</a>(int steps=1) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a11">equals</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_key.html#a6">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_s_w_object.html#a0">getClass</a>() const +<code> [inline]</code><li><a class="el" href="class_s_w_key.html#a9">getText</a>() const +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a14">increment</a>(int steps=1) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a16">Index</a>() const +<code> [inline, virtual]</code><li><b>Index</b>(long iindex) (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [inline, virtual]</code><li><b>init</b>() (defined in <a class="el" href="class_str_key.html">StrKey</a>)<code> [private]</code><li><b>keytext</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><b>myclass</b> (defined in <a class="el" href="class_s_w_object.html">SWObject</a>)<code> [protected]</code><li><a class="el" href="class_s_w_key.html#a4">Persist</a>() const +<li><a class="el" href="class_s_w_key.html#a5">Persist</a>(char ikey) +<li><b>persist</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><b>setPosition</b>(SW_POSITION) (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a7">setText</a>(const char *ikey) +<code> [virtual]</code><li><a class="el" href="class_str_key.html#a0">StrKey</a>(const char *ikey=0) +<li><a class="el" href="class_s_w_key.html#a0">SWKey</a>(const char *ikey=0) +<li><a class="el" href="class_s_w_key.html#a1">SWKey</a>(SWKey const &k) +<li><b>Traversable</b>() (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [inline, virtual]</code><li><a class="el" href="class_str_key.html#a1">~StrKey</a>() +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a2">~SWKey</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_str_key.gif b/doc/api-documentation/html/class_str_key.gif Binary files differnew file mode 100644 index 0000000..88d77a1 --- /dev/null +++ b/doc/api-documentation/html/class_str_key.gif diff --git a/doc/api-documentation/html/class_str_key.html b/doc/api-documentation/html/class_str_key.html new file mode 100644 index 0000000..1b07486 --- /dev/null +++ b/doc/api-documentation/html/class_str_key.html @@ -0,0 +1,90 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>StrKey class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>StrKey Class Reference</h1>a standard string key class (used for modules that index on single strings (eg. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="strkey_8h-source.html">strkey.h</a>></code> +<p> +<p>Inheritance diagram for StrKey:: +<p><center><img src="class_str_key.gif" usemap="#StrKey_map" border="0"></center> +<map name="StrKey_map"> +<area href="class_s_w_key.html" alt="SWKey" shape="rect" coords="0,56,68,80"> +<area href="class_s_w_object.html" alt="SWObject" shape="rect" coords="0,0,68,24"> +</map> +<a href="class_str_key-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_str_key.html#a0">StrKey</a> (const char *ikey=0)</td></tr> +<tr><td> </td><td><font size=-1><em>initializes instance of StrKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="StrKey::~StrKey"></a> +virtual </td><td valign=bottom><a class="el" href="class_str_key.html#a1">~StrKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>cleans up instance of StrKey.</em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="StrKey::init"></a> +void </td><td valign=bottom><b>init</b> ()</td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="StrKey::classdef"></a> +<a class="el" href="class_s_w_class.html">SWClass</a> </td><td valign=bottom><b>classdef</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a standard string key class (used for modules that index on single strings (eg. +<p> +cities, names, words, etc.) +<p> + +<p> +Definition at line <a class="el" href="strkey_8h-source.html#l00035">35</a> of file <a class="el" href="strkey_8h-source.html">strkey.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="StrKey::StrKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +StrKey::StrKey + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ikey</em> = 0 </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +initializes instance of StrKey. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +text key (word, city, name, etc.) </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="strkey_8h-source.html">strkey.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_strkey-members.html b/doc/api-documentation/html/class_strkey-members.html new file mode 100644 index 0000000..2f0de65 --- /dev/null +++ b/doc/api-documentation/html/class_strkey-members.html @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>StrKey Member List</h1>This is the complete list of members for <a class="el" href="class_strkey.html">StrKey</a>, including all inherited members.<ul> +<li><b>classdef</b> (defined in <a class="el" href="class_strkey.html">StrKey</a>)<code> [private, static]</code><li><a class="el" href="class_swkey.html#a3">clone</a>() const +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a10">compare</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a8">copyFrom</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a13">decrement</a>(int steps=1) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a11">equals</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_swkey.html#a6">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_swobject.html#a0">getClass</a>() const +<code> [inline]</code><li><a class="el" href="class_swkey.html#a9">getText</a>() const +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a14">increment</a>(int steps=1) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a16">Index</a>() const +<code> [inline, virtual]</code><li><b>Index</b>(long iindex) (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [inline, virtual]</code><li><b>init</b>() (defined in <a class="el" href="class_strkey.html">StrKey</a>)<code> [private]</code><li><b>keytext</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><b>myclass</b> (defined in <a class="el" href="class_swobject.html">SWObject</a>)<code> [protected]</code><li><a class="el" href="class_swkey.html#a4">Persist</a>() const +<li><a class="el" href="class_swkey.html#a5">Persist</a>(char ikey) +<li><b>persist</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><b>setPosition</b>(SW_POSITION) (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [virtual]</code><li><a class="el" href="class_swkey.html#a7">setText</a>(const char *ikey) +<code> [virtual]</code><li><a class="el" href="class_strkey.html#a0">StrKey</a>(const char *ikey=0) +<li><a class="el" href="class_swkey.html#a0">SWKey</a>(const char *ikey=0) +<li><a class="el" href="class_swkey.html#a1">SWKey</a>(SWKey const &k) +<li><b>Traversable</b>() (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [inline, virtual]</code><li><a class="el" href="class_strkey.html#a1">~StrKey</a>() +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a2">~SWKey</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_strkey.gif b/doc/api-documentation/html/class_strkey.gif Binary files differnew file mode 100644 index 0000000..88d77a1 --- /dev/null +++ b/doc/api-documentation/html/class_strkey.gif diff --git a/doc/api-documentation/html/class_strkey.html b/doc/api-documentation/html/class_strkey.html new file mode 100644 index 0000000..0e3f154 --- /dev/null +++ b/doc/api-documentation/html/class_strkey.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>StrKey class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>StrKey Class Reference</h1>a standard string key class (used for modules that index on single strings (eg. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="strkey_h-source.html">strkey.h</a>></code> +<p> +<p>Inheritance diagram for StrKey:: +<p><center><img src="class_strkey.gif" usemap="#StrKey_map" border="0"></center> +<map name="StrKey_map"> +<area href="class_swkey.html" alt="SWKey" shape="rect" coords="0,56,68,80"> +<area href="class_swobject.html" alt="SWObject" shape="rect" coords="0,0,68,24"> +</map> +<a href="class_strkey-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_strkey.html#a0">StrKey</a> (const char *ikey=0)</td></tr> +<tr><td> </td><td><font size=-1><em>initializes instance of StrKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="StrKey::~StrKey"></a> +virtual </td><td valign=bottom><a class="el" href="class_strkey.html#a1">~StrKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>cleans up instance of StrKey.</em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="StrKey::init"></a> +void </td><td valign=bottom><b>init</b> ()</td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="StrKey::classdef"></a> +<a class="el" href="class_swclass.html">SWClass</a> </td><td valign=bottom><b>classdef</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +a standard string key class (used for modules that index on single strings (eg. +<p> +cities, names, words, etc.) +<p> + +<p> +Definition at line <a class="el" href="strkey_h-source.html#l00035">35</a> of file <a class="el" href="strkey_h-source.html">strkey.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="StrKey::StrKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +StrKey::StrKey ( + </b></td> + <td valign="bottom"><b> +const char * <em>ikey</em> = 0 ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +initializes instance of StrKey. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +text key (word, city, name, etc.) </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="strkey_h-source.html">strkey.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swclass-members.html b/doc/api-documentation/html/class_swclass-members.html new file mode 100644 index 0000000..6d5f09c --- /dev/null +++ b/doc/api-documentation/html/class_swclass-members.html @@ -0,0 +1,18 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWClass Member List</h1>This is the complete list of members for <a class="el" href="class_swclass.html">SWClass</a>, including all inherited members.<ul> +<li><b>descends</b> (defined in <a class="el" href="class_swclass.html">SWClass</a>)<code> [private]</code><li><b>isAssignableFrom</b>(const char *className) const (defined in <a class="el" href="class_swclass.html">SWClass</a>)<code> [inline]</code><li><b>SWClass</b>(const char **descends) (defined in <a class="el" href="class_swclass.html">SWClass</a>)<code> [inline]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swclass.html b/doc/api-documentation/html/class_swclass.html new file mode 100644 index 0000000..30b89d5 --- /dev/null +++ b/doc/api-documentation/html/class_swclass.html @@ -0,0 +1,38 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWClass class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWClass Class Reference</h1>Class used for SWDYNAMIC_CAST to save the inheritance order. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swobject_h-source.html">swobject.h</a>></code> +<p> +<a href="class_swclass-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SWClass::SWClass"></a> + </td><td valign=bottom><b>SWClass</b> (const char **descends)</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWClass::isAssignableFrom"></a> +bool </td><td valign=bottom><b>isAssignableFrom</b> (const char *className) const</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="SWClass::descends"></a> +const char** </td><td valign=bottom><b>descends</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Class used for SWDYNAMIC_CAST to save the inheritance order. +<p> + +<p> +Definition at line <a class="el" href="swobject_h-source.html#l00018">18</a> of file <a class="el" href="swobject_h-source.html">swobject.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swobject_h-source.html">swobject.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swcom-members.html b/doc/api-documentation/html/class_swcom-members.html new file mode 100644 index 0000000..9a1e26b --- /dev/null +++ b/doc/api-documentation/html/class_swcom-members.html @@ -0,0 +1,70 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWCom Member List</h1>This is the complete list of members for <a class="el" href="class_swcom.html">SWCom</a>, including all inherited members.<ul> +<li><a class="el" href="class_swmodule.html#a41">AddOptionFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a38">AddRawFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a33">AddRenderFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a36">AddStripFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swcom.html#a2">CreateKey</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#d1">createModule</a>(const char *) +<code> [inline, static]</code><li><b>createSearchFramework</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a27">deleteEntry</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a13">Description</a>(const char *imoddesc=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a11">Disp</a>(SWDisplay *idisp=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#n6">disp</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a10">Display</a>() +<code> [virtual]</code><li><b>entrybuf</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>entrySize</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a2">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a39">filterBuffer</a>(FilterList *filters, char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a4">getEntrySize</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a21">getRawEntry</a>()=0 +<code> [pure virtual]</code><li><b>hasSearchFramework</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><b>isSearchOptimallySupported</b>(const char *istr, int searchType, int flags, SWKey *scope) (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a3">isUnicode</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a24">isWritable</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a7">Key</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a8">Key</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n1">key</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a9">KeyText</a>(const char *imodtype=0) +<code> [virtual]</code><li><b>listkey</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>moddesc</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>modname</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>modtype</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a12">Name</a>(const char *imodname=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#d0">nullPercent</a>(char percent, void *userData) +<code> [static]</code><li><a class="el" href="class_swmodule.html#a20">operator char *</a>() +<code> [virtual]</code><li><b>operator SWKey &</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><b>operator SWKey *</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a30">operator++</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a29">operator+=</a>(int increment) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a31">operator--</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a28">operator-=</a>(int decrement) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a25">operator<<</a>(const char *) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a26">operator<<</a>(const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a32">operator=</a>(SW_POSITION p) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a42">optionFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n11">optionFilters</a> +<code> [protected]</code><li><b>rawdisp</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected, static]</code><li><a class="el" href="class_swmodule.html#a40">rawFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n9">rawFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a34">RemoveRenderFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><b>render</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a35">renderFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n10">renderFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a44">RenderText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a46">RenderText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a15">Search</a>(const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a5">SetKey</a>(const SWKey *ikey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a6">SetKey</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a37">stripFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n8">stripFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a43">StripText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a45">StripText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_swcom.html#a0">SWCom</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, bool unicode=false) +<li><a class="el" href="class_swmodule.html#a0">SWModule</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char *imodtype=0, bool unicode=false) +<li><a class="el" href="class_swmodule.html#m0">terminateSearch</a> +<li><a class="el" href="class_swmodule.html#a14">Type</a>(const char *imodtype=0) +<code> [virtual]</code><li><b>unicode</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>~SWCom</b>() (defined in <a class="el" href="class_swcom.html">SWCom</a>)<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a1">~SWModule</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swcom.gif b/doc/api-documentation/html/class_swcom.gif Binary files differnew file mode 100644 index 0000000..a8cee96 --- /dev/null +++ b/doc/api-documentation/html/class_swcom.gif diff --git a/doc/api-documentation/html/class_swcom.html b/doc/api-documentation/html/class_swcom.html new file mode 100644 index 0000000..d7e6d8e --- /dev/null +++ b/doc/api-documentation/html/class_swcom.html @@ -0,0 +1,143 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWCom class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWCom Class Reference</h1>The basis for all commentary modules. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swcom_h-source.html">swcom.h</a>></code> +<p> +<p>Inheritance diagram for SWCom:: +<p><center><img src="class_swcom.gif" usemap="#SWCom_map" border="0"></center> +<map name="SWCom_map"> +<area href="class_swmodule.html" alt="SWModule" shape="rect" coords="0,0,73,24"> +</map> +<a href="class_swcom-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_swcom.html#a0">SWCom</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_swdisplay.html">SWDisplay</a> *idisp=0, bool unicode=false)</td></tr> +<tr><td> </td><td><font size=-1><em>Initializes data for instance of SWCom.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWCom::~SWCom"></a> +virtual </td><td valign=bottom><b>~SWCom</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_swcom.html#a2">CreateKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Allocates a key of specific type for module.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The basis for all commentary modules. +<p> + +<p> +Definition at line <a class="el" href="swcom_h-source.html#l00033">33</a> of file <a class="el" href="swcom_h-source.html">swcom.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWCom::SWCom"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWCom::SWCom ( + </b></td> + <td valign="bottom"><b> +const char * <em>imodname</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const char * <em>imoddesc</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swdisplay.html">SWDisplay</a> * <em>idisp</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +bool <em>unicode</em> = false ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initializes data for instance of SWCom. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodname</em> + </td><td> +Internal name for module </td></tr> +<tr><td valign=top><em>imoddesc</em> + </td><td> +Name to display to user for module </td></tr> +<tr><td valign=top><em>idisp</em> + </td><td> +Display object to use for displaying </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="SWCom::CreateKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="class_swkey.html">SWKey</a> * SWCom::CreateKey ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Allocates a key of specific type for module. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +pointer to allocated key </dl> +<p> +Reimplemented from <a class="el" href="class_swmodule.html#a19">SWModule</a>. +<p> +Definition at line <a class="el" href="swcom_h-source.html#l00044">44</a> of file <a class="el" href="swcom_h-source.html">swcom.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swcom_h-source.html">swcom.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swconfig-members.html b/doc/api-documentation/html/class_swconfig-members.html new file mode 100644 index 0000000..b0f1dab --- /dev/null +++ b/doc/api-documentation/html/class_swconfig-members.html @@ -0,0 +1,25 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWConfig Member List</h1>This is the complete list of members for <a class="el" href="class_swconfig.html">SWConfig</a>, including all inherited members.<ul> +<li><a class="el" href="class_swconfig.html#m0">filename</a> +<li><b>getline</b>(FILE *fp, string &line) (defined in <a class="el" href="class_swconfig.html">SWConfig</a>)<code> [private]</code><li><a class="el" href="class_swconfig.html#a2">Load</a>() +<code> [virtual]</code><li><a class="el" href="class_swconfig.html#a4">operator+=</a>(SWConfig &addFrom) +<code> [virtual]</code><li><a class="el" href="class_swconfig.html#a5">operator[]</a>(const char *section) +<code> [virtual]</code><li><a class="el" href="class_swconfig.html#a3">Save</a>() +<code> [virtual]</code><li><a class="el" href="class_swconfig.html#m1">Sections</a> +<li><a class="el" href="class_swconfig.html#a0">SWConfig</a>(const char *ifilename) +<li><b>~SWConfig</b>() (defined in <a class="el" href="class_swconfig.html">SWConfig</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swconfig.html b/doc/api-documentation/html/class_swconfig.html new file mode 100644 index 0000000..c299f95 --- /dev/null +++ b/doc/api-documentation/html/class_swconfig.html @@ -0,0 +1,168 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWConfig class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWConfig Class Reference</h1>The class to read and save settings using a file on disk. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swconfig_h-source.html">swconfig.h</a>></code> +<p> +<a href="class_swconfig-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_swconfig.html#a0">SWConfig</a> (const char *ifilename)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor of SWConfig.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWConfig::~SWConfig"></a> +virtual </td><td valign=bottom><b>~SWConfig</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="SWConfig::Load"></a> +virtual void </td><td valign=bottom><a class="el" href="class_swconfig.html#a2">Load</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Load from disk Load the contzent from disk.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="SWConfig::Save"></a> +virtual void </td><td valign=bottom><a class="el" href="class_swconfig.html#a3">Save</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Save to disk Save the content of this config object to disk.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWConfig& </td><td valign=bottom><a class="el" href="class_swconfig.html#a4">operator+=</a> (SWConfig &addFrom)</td></tr> +<tr><td> </td><td><font size=-1><em>Merges the values of addFrom.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual ConfigEntMap& </td><td valign=bottom><a class="el" href="class_swconfig.html#a5">operator[]</a> (const char *section)</td></tr> +<tr><td> </td><td><font size=-1><em>Get a section This is an easy way to get and store config values.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="m0" doxytag="SWConfig::filename"></a> +string </td><td valign=bottom><a class="el" href="class_swconfig.html#m0">filename</a></td></tr> +<tr><td> </td><td><font size=-1><em>The filename used by this SWConfig object.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="m1" doxytag="SWConfig::Sections"></a> +SectionMap </td><td valign=bottom><a class="el" href="class_swconfig.html#m1">Sections</a></td></tr> +<tr><td> </td><td><font size=-1><em>Map of available sections The map of available sections.</em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="SWConfig::getline"></a> +char </td><td valign=bottom><b>getline</b> (FILE *fp, string &line)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The class to read and save settings using a file on disk. +<p> + +<p> +Definition at line <a class="el" href="swconfig_h-source.html#l00056">56</a> of file <a class="el" href="swconfig_h-source.html">swconfig.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWConfig::SWConfig"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWConfig::SWConfig ( + </b></td> + <td valign="bottom"><b> +const char * <em>ifilename</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor of SWConfig. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ifilename</em> + </td><td> +The file, which should be used for this config. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a4" doxytag="SWConfig::operator+="></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWConfig & SWConfig::operator+= ( + </b></td> + <td valign="bottom"><b> +SWConfig & <em>addFrom</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Merges the values of addFrom. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>The</em> + </td><td> +config which values should be merged to this config object. Already existing values will be overwritten. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a5" doxytag="SWConfig::operator[]"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +ConfigEntMap & SWConfig::operator[] ( + </b></td> + <td valign="bottom"><b> +const char * <em>section</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get a section This is an easy way to get and store config values. +<p> +The following will work:<br> + +<p> +<div class="fragment"><pre> <a class="code" href="class_swconfig.html">SWConfig</a> config(<font class="stringliteral">"/home/user/.setttings"</font>); + config[<font class="stringliteral">"Colors"</font>][<font class="stringliteral">"Background"</font>] = <font class="stringliteral">"red"</font>;</pre></div> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swconfig_h-source.html">swconfig.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swdisplay-members.html b/doc/api-documentation/html/class_swdisplay-members.html new file mode 100644 index 0000000..e05e0f2 --- /dev/null +++ b/doc/api-documentation/html/class_swdisplay-members.html @@ -0,0 +1,19 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWDisplay Member List</h1>This is the complete list of members for <a class="el" href="class_swdisplay.html">SWDisplay</a>, including all inherited members.<ul> +<li><a class="el" href="class_swdisplay.html#a1">Display</a>(SWModule &imodule) +<code> [virtual]</code><li><b>SWDisplay</b>() (defined in <a class="el" href="class_swdisplay.html">SWDisplay</a>)<code> [inline]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swdisplay.html b/doc/api-documentation/html/class_swdisplay.html new file mode 100644 index 0000000..4f9ce52 --- /dev/null +++ b/doc/api-documentation/html/class_swdisplay.html @@ -0,0 +1,78 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWDisplay class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWDisplay Class Reference</h1>swdisp is the basis for all types of displays (e.g. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swdisp_h-source.html">swdisp.h</a>></code> +<p> +<a href="class_swdisplay-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SWDisplay::SWDisplay"></a> + </td><td valign=bottom><b>SWDisplay</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swdisplay.html#a1">Display</a> (<a class="el" href="class_swmodule.html">SWModule</a> &imodule)</td></tr> +<tr><td> </td><td><font size=-1><em>casts a module to a character pointer and displays it to raw output (overriden for different display types and module types if necessary).</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +swdisp is the basis for all types of displays (e.g. +<p> +raw textout, curses, xwindow, etc.) +<p> + +<p> +Definition at line <a class="el" href="swdisp_h-source.html#l00033">33</a> of file <a class="el" href="swdisp_h-source.html">swdisp.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="SWDisplay::Display"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWDisplay::Display ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swmodule.html">SWModule</a> & <em>imodule</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +casts a module to a character pointer and displays it to raw output (overriden for different display types and module types if necessary). +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodule</em> + </td><td> +module to display </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +error status </dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swdisp_h-source.html">swdisp.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swfilter-members.html b/doc/api-documentation/html/class_swfilter-members.html new file mode 100644 index 0000000..589169b --- /dev/null +++ b/doc/api-documentation/html/class_swfilter-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWFilter Member List</h1>This is the complete list of members for <a class="el" href="class_swfilter.html">SWFilter</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a6">ProcessText</a>(char *text, int maxlen, const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a7">ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swfilter.gif b/doc/api-documentation/html/class_swfilter.gif Binary files differnew file mode 100644 index 0000000..24973c8 --- /dev/null +++ b/doc/api-documentation/html/class_swfilter.gif diff --git a/doc/api-documentation/html/class_swfilter.html b/doc/api-documentation/html/class_swfilter.html new file mode 100644 index 0000000..d131e37 --- /dev/null +++ b/doc/api-documentation/html/class_swfilter.html @@ -0,0 +1,350 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWFilter class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWFilter Class Reference</h1>Base class for all filters in sword. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swfilter_h-source.html">swfilter.h</a>></code> +<p> +<p>Inheritance diagram for SWFilter:: +<p><center><img src="class_swfilter.gif" usemap="#SWFilter_map" border="0"></center> +<map name="SWFilter_map"> +<area href="class_gbffootnotes.html" alt="GBFFootnotes" shape="rect" coords="132,56,254,80"> +<area href="class_gbfheadings.html" alt="GBFHeadings" shape="rect" coords="132,112,254,136"> +<area href="class_gbfhtml.html" alt="GBFHTML" shape="rect" coords="132,168,254,192"> +<area href="class_gbfmorph.html" alt="GBFMorph" shape="rect" coords="132,224,254,248"> +<area href="class_gbfplain.html" alt="GBFPlain" shape="rect" coords="132,280,254,304"> +<area href="class_gbfrtf.html" alt="GBFRTF" shape="rect" coords="132,336,254,360"> +<area href="class_gbfstrongs.html" alt="GBFStrongs" shape="rect" coords="132,392,254,416"> +<area href="class_gbfthml.html" alt="GBFThML" shape="rect" coords="132,448,254,472"> +<area href="class_latin1utf16.html" alt="Latin1UTF16" shape="rect" coords="132,504,254,528"> +<area href="class_latin1utf8.html" alt="Latin1UTF8" shape="rect" coords="132,560,254,584"> +<area href="class_plainfootnotes.html" alt="PLAINFootnotes" shape="rect" coords="132,616,254,640"> +<area href="class_plainhtml.html" alt="PLAINHTML" shape="rect" coords="132,672,254,696"> +<area href="class_rtfhtml.html" alt="RTFHTML" shape="rect" coords="132,728,254,752"> +<area href="class_rwphtml.html" alt="RWPHTML" shape="rect" coords="132,784,254,808"> +<area href="class_rwprtf.html" alt="RWPRTF" shape="rect" coords="132,840,254,864"> +<area href="class_scsuutf8.html" alt="SCSUUTF8" shape="rect" coords="132,896,254,920"> +<area href="class_thmlgbf.html" alt="ThMLGBF" shape="rect" coords="132,952,254,976"> +<area href="class_thmlolb.html" alt="ThMLOLB" shape="rect" coords="132,1008,254,1032"> +<area href="class_thmlplain.html" alt="ThMLPlain" shape="rect" coords="132,1064,254,1088"> +<area href="class_thmlrtf.html" alt="ThMLRTF" shape="rect" coords="132,1120,254,1144"> +<area href="class_unicodertf.html" alt="UnicodeRTF" shape="rect" coords="132,1176,254,1200"> +<area href="class_utf16utf8.html" alt="UTF16UTF8" shape="rect" coords="132,1232,254,1256"> +<area href="class_utf8cantillation.html" alt="UTF8Cantillation" shape="rect" coords="132,1288,254,1312"> +<area href="class_utf8greekaccents.html" alt="UTF8GreekAccents" shape="rect" coords="132,1344,254,1368"> +<area href="class_utf8hebrewpoints.html" alt="UTF8HebrewPoints" shape="rect" coords="132,1400,254,1424"> +<area href="class_utf8utf16.html" alt="UTF8UTF16" shape="rect" coords="132,1456,254,1480"> +</map> +<a href="class_swfilter-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SWFilter::~SWFilter"></a> +virtual </td><td valign=bottom><b>~SWFilter</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swfilter.html#a1">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swfilter.html#a2">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_swfilter.html#a3">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swfilter.html#a4">setOptionValue</a> (const char *)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_swfilter.html#a3">getOptionValues</a>.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="SWFilter::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swfilter.html#a6">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swfilter.html#a7">ProcessText</a> (char *text, int maxlen=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function without the 3rd parameter.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Base class for all filters in sword. +<p> +Filters are used to filter/convert text between different formats like GBF, HTML, RTF ... +<p> + +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00041">41</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a7" doxytag="SWFilter::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWFilter::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em> = -1 )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function without the 3rd parameter. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented in <a class="el" href="class_gbfthml.html#a1">GBFThML</a>, <a class="el" href="class_thmlgbf.html#a1">ThMLGBF</a>, <a class="el" href="class_thmlolb.html#a1">ThMLOLB</a>, <a class="el" href="class_thmlplain.html#a1">ThMLPlain</a>, and <a class="el" href="class_thmlrtf.html#a1">ThMLRTF</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00100">100</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a6" doxytag="SWFilter::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWFilter::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented in <a class="el" href="class_gbffootnotes.html#a2">GBFFootnotes</a>, <a class="el" href="class_gbfheadings.html#a2">GBFHeadings</a>, <a class="el" href="class_gbfhtml.html#a1">GBFHTML</a>, <a class="el" href="class_gbfmorph.html#a2">GBFMorph</a>, <a class="el" href="class_gbfplain.html#a1">GBFPlain</a>, <a class="el" href="class_gbfrtf.html#a1">GBFRTF</a>, <a class="el" href="class_gbfstrongs.html#a2">GBFStrongs</a>, <a class="el" href="class_latin1utf16.html#a1">Latin1UTF16</a>, <a class="el" href="class_latin1utf8.html#a1">Latin1UTF8</a>, <a class="el" href="class_plainfootnotes.html#a2">PLAINFootnotes</a>, <a class="el" href="class_plainhtml.html#a1">PLAINHTML</a>, <a class="el" href="class_rtfhtml.html#a1">RTFHTML</a>, <a class="el" href="class_rwphtml.html#a1">RWPHTML</a>, <a class="el" href="class_rwprtf.html#a1">RWPRTF</a>, <a class="el" href="class_scsuutf8.html#a1">SCSUUTF8</a>, <a class="el" href="class_unicodertf.html#a1">UnicodeRTF</a>, <a class="el" href="class_utf16utf8.html#a1">UTF16UTF8</a>, <a class="el" href="class_utf8cantillation.html#a2">UTF8Cantillation</a>, <a class="el" href="class_utf8greekaccents.html#a2">UTF8GreekAccents</a>, <a class="el" href="class_utf8hebrewpoints.html#a2">UTF8HebrewPoints</a>, and <a class="el" href="class_utf8utf16.html#a1">UTF8UTF16</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00091">91</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. +<p> +Referenced by <a class="el" href="swfilter_h-source.html#l00100">ProcessText</a>(). </td> + </tr> +</table> +<a name="a1" doxytag="SWFilter::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWFilter::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented in <a class="el" href="class_gbffootnotes.html#a3">GBFFootnotes</a>, <a class="el" href="class_gbfheadings.html#a3">GBFHeadings</a>, <a class="el" href="class_gbfmorph.html#a3">GBFMorph</a>, <a class="el" href="class_gbfstrongs.html#a3">GBFStrongs</a>, <a class="el" href="class_plainfootnotes.html#a3">PLAINFootnotes</a>, <a class="el" href="class_utf8cantillation.html#a3">UTF8Cantillation</a>, <a class="el" href="class_utf8greekaccents.html#a3">UTF8GreekAccents</a>, and <a class="el" href="class_utf8hebrewpoints.html#a3">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00051">51</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a2" doxytag="SWFilter::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWFilter::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented in <a class="el" href="class_gbffootnotes.html#a4">GBFFootnotes</a>, <a class="el" href="class_gbfheadings.html#a4">GBFHeadings</a>, <a class="el" href="class_gbfmorph.html#a4">GBFMorph</a>, <a class="el" href="class_gbfstrongs.html#a4">GBFStrongs</a>, <a class="el" href="class_plainfootnotes.html#a4">PLAINFootnotes</a>, <a class="el" href="class_utf8cantillation.html#a4">UTF8Cantillation</a>, <a class="el" href="class_utf8greekaccents.html#a4">UTF8GreekAccents</a>, and <a class="el" href="class_utf8hebrewpoints.html#a4">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00059">59</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a3" doxytag="SWFilter::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList SWFilter::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented in <a class="el" href="class_gbffootnotes.html#a7">GBFFootnotes</a>, <a class="el" href="class_gbfheadings.html#a7">GBFHeadings</a>, <a class="el" href="class_gbfmorph.html#a7">GBFMorph</a>, <a class="el" href="class_gbfstrongs.html#a7">GBFStrongs</a>, <a class="el" href="class_plainfootnotes.html#a7">PLAINFootnotes</a>, <a class="el" href="class_utf8cantillation.html#a7">UTF8Cantillation</a>, <a class="el" href="class_utf8greekaccents.html#a7">UTF8GreekAccents</a>, and <a class="el" href="class_utf8hebrewpoints.html#a7">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00067">67</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="SWFilter::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWFilter::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_swfilter.html#a3">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented in <a class="el" href="class_gbffootnotes.html#a5">GBFFootnotes</a>, <a class="el" href="class_gbfheadings.html#a5">GBFHeadings</a>, <a class="el" href="class_gbfmorph.html#a5">GBFMorph</a>, <a class="el" href="class_gbfstrongs.html#a5">GBFStrongs</a>, <a class="el" href="class_plainfootnotes.html#a5">PLAINFootnotes</a>, <a class="el" href="class_utf8cantillation.html#a5">UTF8Cantillation</a>, <a class="el" href="class_utf8greekaccents.html#a5">UTF8GreekAccents</a>, and <a class="el" href="class_utf8hebrewpoints.html#a5">UTF8HebrewPoints</a>. +<p> +Definition at line <a class="el" href="swfilter_h-source.html#l00078">78</a> of file <a class="el" href="swfilter_h-source.html">swfilter.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swfilter_h-source.html">swfilter.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swkey-members.html b/doc/api-documentation/html/class_swkey-members.html new file mode 100644 index 0000000..c26f771 --- /dev/null +++ b/doc/api-documentation/html/class_swkey-members.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWKey Member List</h1>This is the complete list of members for <a class="el" href="class_swkey.html">SWKey</a>, including all inherited members.<ul> +<li><b>classdef</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [private, static]</code><li><a class="el" href="class_swkey.html#a3">clone</a>() const +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a10">compare</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a8">copyFrom</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a13">decrement</a>(int steps=1) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a11">equals</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><b>error</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_swkey.html#a6">Error</a>() +<code> [virtual]</code><li><a class="el" href="class_swobject.html#a0">getClass</a>() const +<code> [inline]</code><li><a class="el" href="class_swkey.html#a9">getText</a>() const +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a14">increment</a>(int steps=1) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a16">Index</a>() const +<code> [inline, virtual]</code><li><b>Index</b>(long iindex) (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [inline, virtual]</code><li><b>index</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [private]</code><li><b>init</b>() (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [private]</code><li><b>keytext</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><b>myclass</b> (defined in <a class="el" href="class_swobject.html">SWObject</a>)<code> [protected]</code><li><b>persist</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_swkey.html#a4">Persist</a>() const +<li><a class="el" href="class_swkey.html#a5">Persist</a>(char ikey) +<li><b>setPosition</b>(SW_POSITION) (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [virtual]</code><li><a class="el" href="class_swkey.html#a7">setText</a>(const char *ikey) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a0">SWKey</a>(const char *ikey=0) +<li><a class="el" href="class_swkey.html#a1">SWKey</a>(SWKey const &k) +<li><b>Traversable</b>() (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swkey.html#a2">~SWKey</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swkey.gif b/doc/api-documentation/html/class_swkey.gif Binary files differnew file mode 100644 index 0000000..bb80a6c --- /dev/null +++ b/doc/api-documentation/html/class_swkey.gif diff --git a/doc/api-documentation/html/class_swkey.html b/doc/api-documentation/html/class_swkey.html new file mode 100644 index 0000000..f3b5359 --- /dev/null +++ b/doc/api-documentation/html/class_swkey.html @@ -0,0 +1,620 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWKey class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWKey Class Reference</h1>SWKey is the basis for all types of keys for indexing into modules (e.g. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swkey_h-source.html">swkey.h</a>></code> +<p> +<p>Inheritance diagram for SWKey:: +<p><center><img src="class_swkey.gif" usemap="#SWKey_map" border="0"></center> +<map name="SWKey_map"> +<area href="class_swobject.html" alt="SWObject" shape="rect" coords="78,0,146,24"> +<area href="class_listkey.html" alt="ListKey" shape="rect" coords="0,112,68,136"> +<area href="class_strkey.html" alt="StrKey" shape="rect" coords="78,112,146,136"> +<area href="class_versekey.html" alt="VerseKey" shape="rect" coords="156,112,224,136"> +</map> +<a href="class_swkey-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_swkey.html#a0">SWKey</a> (const char *ikey=0)</td></tr> +<tr><td> </td><td><font size=-1><em>initializes instance of SWKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_swkey.html#a1">SWKey</a> (SWKey const &k)</td></tr> +<tr><td> </td><td><font size=-1><em>Copy Constructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="SWKey::~SWKey"></a> +virtual </td><td valign=bottom><a class="el" href="class_swkey.html#a2">~SWKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Destructor, cleans up this instance of SWKey.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWKey* </td><td valign=bottom><a class="el" href="class_swkey.html#a3">clone</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Returns a copy of this SWKey object.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="class_swkey.html#a4">Persist</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets whether this object itself persists within a module that it was used to SetKey or just a copy.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="class_swkey.html#a5">Persist</a> (char ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swkey.html#a6">Error</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Gets and clears error status.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swkey.html#a7">setText</a> (const char *ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this SWKey to a character string.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swkey.html#a8">copyFrom</a> (const SWKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this SWKey to another SWKey object.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a9" doxytag="SWKey::getText"></a> +virtual const char* </td><td valign=bottom><a class="el" href="class_swkey.html#a9">getText</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>returns text key if (char *) cast is requested.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_swkey.html#a10">compare</a> (const SWKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Compares another <a class="el" href="class_versekey.html">VerseKey</a> object.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="class_swkey.html#a11">equals</a> (const SWKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Compares another <a class="el" href="class_versekey.html">VerseKey</a> object.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a12" doxytag="SWKey::setPosition"></a> +virtual void </td><td valign=bottom><b>setPosition</b> (SW_POSITION)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swkey.html#a13">decrement</a> (int steps=1)</td></tr> +<tr><td> </td><td><font size=-1><em>Decrements key a number of entries.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swkey.html#a14">increment</a> (int steps=1)</td></tr> +<tr><td> </td><td><font size=-1><em>Increments key a number of entries.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a15" doxytag="SWKey::Traversable"></a> +virtual char </td><td valign=bottom><b>Traversable</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_swkey.html#a16">Index</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Use this function to get te current position withing a module.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a17" doxytag="SWKey::Index"></a> +virtual long </td><td valign=bottom><b>Index</b> (long iindex)</td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWKey::keytext"></a> +char* </td><td valign=bottom><b>keytext</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWKey::persist"></a> +char </td><td valign=bottom><b>persist</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWKey::error"></a> +char </td><td valign=bottom><b>error</b></td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="SWKey::init"></a> +void </td><td valign=bottom><b>init</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="SWKey::index"></a> +long </td><td valign=bottom><b>index</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="SWKey::classdef"></a> +<a class="el" href="class_swclass.html">SWClass</a> </td><td valign=bottom><b>classdef</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +SWKey is the basis for all types of keys for indexing into modules (e.g. +<p> +verse, word, place, etc.) +<p> + +<p> +Definition at line <a class="el" href="swkey_h-source.html#l00076">76</a> of file <a class="el" href="swkey_h-source.html">swkey.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWKey::SWKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWKey::SWKey ( + </b></td> + <td valign="bottom"><b> +const char * <em>ikey</em> = 0 ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +initializes instance of SWKey. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +text key </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="SWKey::SWKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWKey::SWKey ( + </b></td> + <td valign="bottom"><b> +SWKey const & <em>k</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Copy Constructor. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>The</em> + </td><td> +SWKey object to copy. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a6" doxytag="SWKey::Error"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWKey::Error ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets and clears error status. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +error status </dl> </td> + </tr> +</table> +<a name="a16" doxytag="SWKey::Index"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +long SWKey::Index ( + </b></td> + <td valign="bottom"><b> +) const<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Use this function to get te current position withing a module. +<p> +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. <div class="fragment"><pre> <font class="keyword">const</font> <font class="keywordtype">char</font>* randomVerse()<font class="keyword"> </font>{ + <a class="code" href="class_versekey.html">VerseKey</a> vk; + <a class="code" href="class_swmgr.html">SWMgr</a> mgr; + LocaleMgr::systemLocaleMgr.<a class="code" href="class_localemgr.html#a6">setDefaultLocaleName</a>(<font class="stringliteral">"de"</font>); + + <a class="code" href="class_swmodule.html">SWModule</a>* module = mgr-><a class="code" href="class_swmgr.html#m2">Modules</a>(<font class="stringliteral">"GerLut"</font>); + srand( time(0) ); + <font class="keyword">const</font> <font class="keywordtype">double</font> newIndex = (double(rand())/RAND_MAX)*(24108+8224); + vk.<a class="code" href="class_versekey.html#a31">Index</a>(newIndex); + module-><a class="code" href="class_swmodule.html#a5">SetKey</a>(vk); + + <font class="keywordtype">char</font>* text; + sprintf(text, <font class="stringliteral">"%s: %s"</font>,(<font class="keyword">const</font> <font class="keywordtype">char</font>*)vk ,module-><a class="code" href="class_swmodule.html#a43">StripText</a>(&vk)); + <font class="keywordflow">return</font> text;</pre></div> +<p> +Reimplemented in <a class="el" href="class_listkey.html#a17">ListKey</a>, and <a class="el" href="class_versekey.html#a31">VerseKey</a>. +<p> +Definition at line <a class="el" href="swkey_h-source.html#l00204">204</a> of file <a class="el" href="swkey_h-source.html">swkey.h</a>. +<p> +Referenced by <a class="el" href="listkey_h-source.html#l00112">ListKey::Index</a>(). </td> + </tr> +</table> +<a name="a5" doxytag="SWKey::Persist"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWKey::Persist ( + </b></td> + <td valign="bottom"><b> +char <em>ikey</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set/gets whether this object itself persists within a module that it was used to SetKey or just a copy. +<p> +(1 - persists in module; 0 - a copy is attempted<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ipersist</em> + </td><td> +value which to set persist; [-1] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +value of persist </dl> </td> + </tr> +</table> +<a name="a4" doxytag="SWKey::Persist"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWKey::Persist ( + </b></td> + <td valign="bottom"><b> +) const + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets whether this object itself persists within a module that it was used to SetKey or just a copy. +<p> +(1 - persists in module; 0 - a copy is attempted +<p> +<dl compact><dt> +<b>Returns: </b><dd> +value of persist </dl> </td> + </tr> +</table> +<a name="a3" doxytag="SWKey::clone"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWKey * SWKey::clone ( + </b></td> + <td valign="bottom"><b> +) const<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns a copy of this SWKey object. +<p> +This is useful to get a 1:1 copy of an SWKey based object. <dl compact><dt> +<b>Returns: </b><dd> +SWKey </dl> +<p> +Reimplemented in <a class="el" href="class_listkey.html#a3">ListKey</a>, and <a class="el" href="class_versekey.html#a10">VerseKey</a>. </td> + </tr> +</table> +<a name="a10" doxytag="SWKey::compare"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int SWKey::compare ( + </b></td> + <td valign="bottom"><b> +const SWKey & <em>ikey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compares another <a class="el" href="class_versekey.html">VerseKey</a> object. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +key to compare with this one </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +>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 </dl> +<p> +Reimplemented in <a class="el" href="class_versekey.html#a34">VerseKey</a>. +<p> +Referenced by <a class="el" href="swkey_h-source.html#l00163">equals</a>(). </td> + </tr> +</table> +<a name="a8" doxytag="SWKey::copyFrom"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWKey::copyFrom ( + </b></td> + <td valign="bottom"><b> +const SWKey & <em>ikey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this SWKey to another SWKey object. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +other swkey object </td></tr> +</table> +</dl> +<p> +Reimplemented in <a class="el" href="class_listkey.html#a12">ListKey</a>, and <a class="el" href="class_versekey.html#a13">VerseKey</a>. +<p> +Referenced by <a class="el" href="listkey_h-source.html#l00090">ListKey::copyFrom</a>(). </td> + </tr> +</table> +<a name="a13" doxytag="SWKey::decrement"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWKey::decrement ( + </b></td> + <td valign="bottom"><b> +int <em>step</em> = 1 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Decrements key a number of entries. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>steps</em> + </td><td> +Number of entries to jump backward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented in <a class="el" href="class_listkey.html#a14">ListKey</a>, and <a class="el" href="class_versekey.html#a16">VerseKey</a>. </td> + </tr> +</table> +<a name="a11" doxytag="SWKey::equals"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +bool SWKey::equals ( + </b></td> + <td valign="bottom"><b> +const SWKey & <em>ikey</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compares another <a class="el" href="class_versekey.html">VerseKey</a> object. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +key to compare with this one </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +true if the keys are the same </dl> +<p> +Definition at line <a class="el" href="swkey_h-source.html#l00163">163</a> of file <a class="el" href="swkey_h-source.html">swkey.h</a>. </td> + </tr> +</table> +<a name="a14" doxytag="SWKey::increment"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWKey::increment ( + </b></td> + <td valign="bottom"><b> +int <em>step</em> = 1 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Increments key a number of entries. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>increment</em> + </td><td> +Number of entries to jump forward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented in <a class="el" href="class_listkey.html#a15">ListKey</a>, and <a class="el" href="class_versekey.html#a17">VerseKey</a>. </td> + </tr> +</table> +<a name="a7" doxytag="SWKey::setText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWKey::setText ( + </b></td> + <td valign="bottom"><b> +const char * <em>ikey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this SWKey to a character string. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +string to set this key to </td></tr> +</table> +</dl> +<p> +Reimplemented in <a class="el" href="class_versekey.html#a12">VerseKey</a>. +<p> +Referenced by <a class="el" href="versekey_h-source.html#l00228">VerseKey::setText</a>(). </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swkey_h-source.html">swkey.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swld-members.html b/doc/api-documentation/html/class_swld-members.html new file mode 100644 index 0000000..ae820f2 --- /dev/null +++ b/doc/api-documentation/html/class_swld-members.html @@ -0,0 +1,70 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWLD Member List</h1>This is the complete list of members for <a class="el" href="class_swld.html">SWLD</a>, including all inherited members.<ul> +<li><a class="el" href="class_swmodule.html#a41">AddOptionFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a38">AddRawFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a33">AddRenderFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a36">AddStripFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swld.html#a2">CreateKey</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#d1">createModule</a>(const char *) +<code> [inline, static]</code><li><b>createSearchFramework</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a27">deleteEntry</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a13">Description</a>(const char *imoddesc=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a11">Disp</a>(SWDisplay *idisp=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#n6">disp</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a10">Display</a>() +<code> [virtual]</code><li><b>entkeytxt</b> (defined in <a class="el" href="class_swld.html">SWLD</a>)<code> [protected]</code><li><b>entrybuf</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>entrySize</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a2">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a39">filterBuffer</a>(FilterList *filters, char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a4">getEntrySize</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a21">getRawEntry</a>()=0 +<code> [pure virtual]</code><li><b>hasSearchFramework</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><b>isSearchOptimallySupported</b>(const char *istr, int searchType, int flags, SWKey *scope) (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a3">isUnicode</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a24">isWritable</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a7">Key</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a8">Key</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n1">key</a> +<code> [protected]</code><li><a class="el" href="class_swld.html#a3">KeyText</a>(const char *ikeytext) +<code> [virtual]</code><li><b>listkey</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>moddesc</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>modname</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>modtype</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a12">Name</a>(const char *imodname=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#d0">nullPercent</a>(char percent, void *userData) +<code> [static]</code><li><a class="el" href="class_swmodule.html#a20">operator char *</a>() +<code> [virtual]</code><li><b>operator SWKey &</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><b>operator SWKey *</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a30">operator++</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a29">operator+=</a>(int increment) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a31">operator--</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a28">operator-=</a>(int decrement) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a25">operator<<</a>(const char *) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a26">operator<<</a>(const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a32">operator=</a>(SW_POSITION p) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a42">optionFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n11">optionFilters</a> +<code> [protected]</code><li><b>rawdisp</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected, static]</code><li><a class="el" href="class_swmodule.html#a40">rawFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n9">rawFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a34">RemoveRenderFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><b>render</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a35">renderFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n10">renderFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a44">RenderText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a46">RenderText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a15">Search</a>(const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a5">SetKey</a>(const SWKey *ikey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a6">SetKey</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a37">stripFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n8">stripFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a43">StripText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a45">StripText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_swld.html#a0">SWLD</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, bool unicode=false) +<li><a class="el" href="class_swmodule.html#a0">SWModule</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char *imodtype=0, bool unicode=false) +<li><a class="el" href="class_swmodule.html#m0">terminateSearch</a> +<li><a class="el" href="class_swmodule.html#a14">Type</a>(const char *imodtype=0) +<code> [virtual]</code><li><b>unicode</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>~SWLD</b>() (defined in <a class="el" href="class_swld.html">SWLD</a>)<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a1">~SWModule</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swld.gif b/doc/api-documentation/html/class_swld.gif Binary files differnew file mode 100644 index 0000000..510eb20 --- /dev/null +++ b/doc/api-documentation/html/class_swld.gif diff --git a/doc/api-documentation/html/class_swld.html b/doc/api-documentation/html/class_swld.html new file mode 100644 index 0000000..4dfb715 --- /dev/null +++ b/doc/api-documentation/html/class_swld.html @@ -0,0 +1,190 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWLD class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWLD Class Reference</h1>the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swld_h-source.html">swld.h</a>></code> +<p> +<p>Inheritance diagram for SWLD:: +<p><center><img src="class_swld.gif" usemap="#SWLD_map" border="0"></center> +<map name="SWLD_map"> +<area href="class_swmodule.html" alt="SWModule" shape="rect" coords="0,0,73,24"> +</map> +<a href="class_swld-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_swld.html#a0">SWLD</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_swdisplay.html">SWDisplay</a> *idisp=0, bool unicode=false)</td></tr> +<tr><td> </td><td><font size=-1><em>Initializes data for instance of SWLD.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWLD::~SWLD"></a> +virtual </td><td valign=bottom><b>~SWLD</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_swld.html#a2">CreateKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Allocates a key of specific type for module.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swld.html#a3">KeyText</a> (const char *ikeytext)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module KeyText, getting from saved text if key is persistent.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWLD::entkeytxt"></a> +char* </td><td valign=bottom><b>entkeytxt</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). +<p> + +<p> +Definition at line <a class="el" href="swld_h-source.html#l00034">34</a> of file <a class="el" href="swld_h-source.html">swld.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWLD::SWLD"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWLD::SWLD ( + </b></td> + <td valign="bottom"><b> +const char * <em>imodname</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const char * <em>imoddesc</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swdisplay.html">SWDisplay</a> * <em>idisp</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +bool <em>unicode</em> = false ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initializes data for instance of SWLD. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodname</em> + </td><td> +Internal name for module </td></tr> +<tr><td valign=top><em>imoddesc</em> + </td><td> +Name to display to user for module </td></tr> +<tr><td valign=top><em>idisp</em> + </td><td> +Display object to use for displaying </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="SWLD::CreateKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="class_swkey.html">SWKey</a> * SWLD::CreateKey ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Allocates a key of specific type for module. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +pointer to allocated key </dl> +<p> +Reimplemented from <a class="el" href="class_swmodule.html#a19">SWModule</a>. +<p> +Definition at line <a class="el" href="swld_h-source.html#l00047">47</a> of file <a class="el" href="swld_h-source.html">swld.h</a>. </td> + </tr> +</table> +<a name="a3" doxytag="SWLD::KeyText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWLD::KeyText ( + </b></td> + <td valign="bottom"><b> +const char * <em>ikeytext</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module KeyText, getting from saved text if key is persistent. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikeytext</em> + </td><td> +value which to set keytext; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to keytext </dl> +<p> +Reimplemented from <a class="el" href="class_swmodule.html#a9">SWModule</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swld_h-source.html">swld.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swlocale-members.html b/doc/api-documentation/html/class_swlocale-members.html new file mode 100644 index 0000000..e4f259f --- /dev/null +++ b/doc/api-documentation/html/class_swlocale-members.html @@ -0,0 +1,20 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWLocale Member List</h1>This is the complete list of members for <a class="el" href="class_swlocale.html">SWLocale</a>, including all inherited members.<ul> +<li><b>BMAX</b> (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [private]</code><li><b>bookAbbrevs</b> (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [private]</code><li><b>books</b> (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [private]</code><li><b>description</b> (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [private]</code><li><b>getBookAbbrevs</b>() (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [virtual]</code><li><b>getBooks</b>(char **iBMAX, struct sbook ***ibooks) (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [virtual]</code><li><a class="el" href="class_swlocale.html#a3">getDescription</a>() +<code> [virtual]</code><li><a class="el" href="class_swlocale.html#a2">getName</a>() +<code> [virtual]</code><li><b>localeSource</b> (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [private]</code><li><b>lookupTable</b> (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [private]</code><li><b>name</b> (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [private]</code><li><b>operator+=</b>(SWLocale &addFrom) (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [virtual]</code><li><b>SWLocale</b>(const char *ifilename) (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<li><b>translate</b>(const char *text) (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [virtual]</code><li><b>~SWLocale</b>() (defined in <a class="el" href="class_swlocale.html">SWLocale</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swlocale.html b/doc/api-documentation/html/class_swlocale.html new file mode 100644 index 0000000..e5d4852 --- /dev/null +++ b/doc/api-documentation/html/class_swlocale.html @@ -0,0 +1,130 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWLocale class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWLocale Class Reference</h1>SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swlocale_h-source.html">swlocale.h</a>></code> +<p> +<a href="class_swlocale-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="SWLocale::SWLocale"></a> + </td><td valign=bottom><b>SWLocale</b> (const char *ifilename)</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWLocale::~SWLocale"></a> +virtual </td><td valign=bottom><b>~SWLocale</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swlocale.html#a2">getName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>This function is used to get the name of the languages which this object is handling.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swlocale.html#a3">getDescription</a> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="SWLocale::translate"></a> +virtual const char* </td><td valign=bottom><b>translate</b> (const char *text)</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="SWLocale::operator+="></a> +virtual SWLocale& </td><td valign=bottom><b>operator+=</b> (SWLocale &addFrom)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="SWLocale::getBookAbbrevs"></a> +virtual const struct abbrev* </td><td valign=bottom><b>getBookAbbrevs</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="SWLocale::getBooks"></a> +virtual void </td><td valign=bottom><b>getBooks</b> (char **iBMAX, struct sbook ***ibooks)</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="SWLocale::lookupTable"></a> +LookupMap </td><td valign=bottom><b>lookupTable</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="SWLocale::localeSource"></a> +<a class="el" href="class_swconfig.html">SWConfig</a>* </td><td valign=bottom><b>localeSource</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o2" doxytag="SWLocale::name"></a> +char* </td><td valign=bottom><b>name</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o3" doxytag="SWLocale::description"></a> +char* </td><td valign=bottom><b>description</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o4" doxytag="SWLocale::bookAbbrevs"></a> +struct abbrev* </td><td valign=bottom><b>bookAbbrevs</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o5" doxytag="SWLocale::BMAX"></a> +char* </td><td valign=bottom><b>BMAX</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o6" doxytag="SWLocale::books"></a> +struct sbook** </td><td valign=bottom><b>books</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language. +<p> +Every language supported by Sword has one SWLocale object, get the name of the Language using <dl compact><dt> +<b>See also: </b><dd> +getname of this class. Another functions useful for frontend developers is , <a class="el" href="class_swlocale.html#a3">getDescription</a>. </dl> +<p> + +<p> +Definition at line <a class="el" href="swlocale_h-source.html#l00044">44</a> of file <a class="el" href="swlocale_h-source.html">swlocale.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="SWLocale::getDescription"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWLocale::getDescription ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt> +<b>Returns: </b><dd> +The description. A possible example is "German". </dl> </td> + </tr> +</table> +<a name="a2" doxytag="SWLocale::getName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWLocale::getName ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This function is used to get the name of the languages which this object is handling. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +The name of the managed language. A possible example is "de". </dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swlocale_h-source.html">swlocale.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:36 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swmgr-members.html b/doc/api-documentation/html/class_swmgr-members.html new file mode 100644 index 0000000..5b0134b --- /dev/null +++ b/doc/api-documentation/html/class_swmgr-members.html @@ -0,0 +1,35 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWMgr Member List</h1>This is the complete list of members for <a class="el" href="class_swmgr.html">SWMgr</a>, including all inherited members.<ul> +<li><b>AddGlobalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><b>AddLocalOptions</b>(SWModule *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end) (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><b>AddModToConfig</b>(int conffd, const char *fname) (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_swmgr.html#b10">AddRawFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [protected, virtual]</code><li><a class="el" href="class_swmgr.html#b8">AddRenderFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [protected, virtual]</code><li><a class="el" href="class_swmgr.html#b9">AddStripFilters</a>(SWModule *module, ConfigEntMap &section) +<code> [protected, virtual]</code><li><b>cipherFilters</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><b>cleanupFilters</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_swmgr.html#m0">config</a> +<li><b>configPath</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<li><b>configType</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><b>CreateMod</b>(string name, string driver, ConfigEntMap &section) (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><b>CreateMods</b>() (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_swmgr.html#p0">debug</a> +<code> [static]</code><li><b>DeleteMods</b>() (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><b>findConfig</b>(char *configType, char **prefixPath, char **configPath) (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [static]</code><li><b>gbfplain</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_swmgr.html#a6">getGlobalOption</a>(const char *option) +<code> [virtual]</code><li><a class="el" href="class_swmgr.html#a8">getGlobalOptions</a>() +<code> [virtual]</code><li><a class="el" href="class_swmgr.html#a7">getGlobalOptionTip</a>(const char *option) +<code> [virtual]</code><li><b>getGlobalOptionValues</b>(const char *option) (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [virtual]</code><li><b>init</b>() (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_swmgr.html#a3">InstallScan</a>(const char *dir) +<code> [virtual]</code><li><a class="el" href="class_swmgr.html#a4">Load</a>() +<code> [virtual]</code><li><b>loadConfigDir</b>(const char *ipath) (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected, virtual]</code><li><a class="el" href="class_swmgr.html#m2">Modules</a> +<li><b>myconfig</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><b>mysysconfig</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><b>optionFilters</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><b>options</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_swmgr.html#m3">prefixPath</a> +<li><a class="el" href="class_swmgr.html#a10">setCipherKey</a>(const char *modName, const char *key) +<code> [virtual]</code><li><a class="el" href="class_swmgr.html#a5">setGlobalOption</a>(const char *option, const char *value) +<code> [virtual]</code><li><a class="el" href="class_swmgr.html#a0">SWMgr</a>(SWConfig *iconfig=0, SWConfig *isysconfig=0, bool autoload=true) +<li><b>SWMgr</b>(const char *iConfigPath, bool autoload=true) (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<li><b>sysconfig</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<li><b>thmlplain</b> (defined in <a class="el" href="class_swmgr.html">SWMgr</a>)<code> [protected]</code><li><a class="el" href="class_swmgr.html#a11">Version</a>() const +<code> [inline]</code><li><a class="el" href="class_swmgr.html#a2">~SWMgr</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swmgr.html b/doc/api-documentation/html/class_swmgr.html new file mode 100644 index 0000000..4fe27e0 --- /dev/null +++ b/doc/api-documentation/html/class_swmgr.html @@ -0,0 +1,731 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWMgr class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWMgr Class Reference</h1>The main class of Sword to handle all other things. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swmgr_h-source.html">swmgr.h</a>></code> +<p> +<a href="class_swmgr-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_swmgr.html#a0">SWMgr</a> (<a class="el" href="class_swconfig.html">SWConfig</a> *iconfig=0, <a class="el" href="class_swconfig.html">SWConfig</a> *isysconfig=0, bool autoload=true)</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor of SWMgr.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWMgr::SWMgr"></a> + </td><td valign=bottom><b>SWMgr</b> (const char *iConfigPath, bool autoload=true)</td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_swmgr.html#a2">~SWMgr</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>The destructor of SWMgr.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#a3">InstallScan</a> (const char *dir)</td></tr> +<tr><td> </td><td><font size=-1><em>Installs a scan for modules in the directory givan as parameter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#a4">Load</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Load the modules.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#a5">setGlobalOption</a> (const char *option, const char *value)</td></tr> +<tr><td> </td><td><font size=-1><em>Set a global option Set a global option using the parameters.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swmgr.html#a6">getGlobalOption</a> (const char *option)</td></tr> +<tr><td> </td><td><font size=-1><em>Gives the value of the given option.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swmgr.html#a7">getGlobalOptionTip</a> (const char *option)</td></tr> +<tr><td> </td><td><font size=-1><em>Gives a description for the given option.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_swmgr.html#a8">getGlobalOptions</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>A list of all availble options with the currently set values.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a9" doxytag="SWMgr::getGlobalOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getGlobalOptionValues</b> (const char *option)</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swmgr.html#a10">setCipherKey</a> (const char *modName, const char *key)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the cipher key for the given module.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>const float </td><td valign=bottom><a class="el" href="class_swmgr.html#a11">Version</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the Sword version.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="class_swconfig.html">SWConfig</a>* </td><td valign=bottom><a class="el" href="class_swmgr.html#m0">config</a></td></tr> +<tr><td> </td><td><font size=-1><em>The global config object.</em> <a href="#m0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="m1" doxytag="SWMgr::sysconfig"></a> +<a class="el" href="class_swconfig.html">SWConfig</a>* </td><td valign=bottom><b>sysconfig</b></td></tr> +<tr><td nowrap align=right valign=top><a name="m2" doxytag="SWMgr::Modules"></a> +ModMap </td><td valign=bottom><a class="el" href="class_swmgr.html#m2">Modules</a></td></tr> +<tr><td> </td><td><font size=-1><em>A map of all modules This map contains the list of installed modules we use.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="m3" doxytag="SWMgr::prefixPath"></a> +char* </td><td valign=bottom><a class="el" href="class_swmgr.html#m3">prefixPath</a></td></tr> +<tr><td> </td><td><font size=-1><em>The path to your Sword directory.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="m4" doxytag="SWMgr::configPath"></a> +char* </td><td valign=bottom><b>configPath</b></td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="d0" doxytag="SWMgr::findConfig"></a> +void </td><td valign=bottom><b>findConfig</b> (char *configType, char **<a class="el" href="class_swmgr.html#m3">prefixPath</a>, char **configPath)</td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="p0" doxytag="SWMgr::debug"></a> +bool </td><td valign=bottom><a class="el" href="class_swmgr.html#p0">debug</a></td></tr> +<tr><td> </td><td><font size=-1><em>Enable / Disable debug output Set this static bool to true to get more verbose debug messages from SWMgr.</em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="SWMgr::CreateMods"></a> +void </td><td valign=bottom><b>CreateMods</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="b1" doxytag="SWMgr::CreateMod"></a> +<a class="el" href="class_swmodule.html">SWModule</a>* </td><td valign=bottom><b>CreateMod</b> (string name, string driver, ConfigEntMap &section)</td></tr> +<tr><td nowrap align=right valign=top><a name="b2" doxytag="SWMgr::DeleteMods"></a> +void </td><td valign=bottom><b>DeleteMods</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="b3" doxytag="SWMgr::init"></a> +virtual void </td><td valign=bottom><b>init</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="b4" doxytag="SWMgr::AddModToConfig"></a> +virtual char </td><td valign=bottom><b>AddModToConfig</b> (int conffd, const char *fname)</td></tr> +<tr><td nowrap align=right valign=top><a name="b5" doxytag="SWMgr::loadConfigDir"></a> +virtual void </td><td valign=bottom><b>loadConfigDir</b> (const char *ipath)</td></tr> +<tr><td nowrap align=right valign=top><a name="b6" doxytag="SWMgr::AddGlobalOptions"></a> +virtual void </td><td valign=bottom><b>AddGlobalOptions</b> (<a class="el" href="class_swmodule.html">SWModule</a> *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)</td></tr> +<tr><td nowrap align=right valign=top><a name="b7" doxytag="SWMgr::AddLocalOptions"></a> +virtual void </td><td valign=bottom><b>AddLocalOptions</b> (<a class="el" href="class_swmodule.html">SWModule</a> *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)</td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#b8">AddRenderFilters</a> (<a class="el" href="class_swmodule.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the render filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module".</em> <a href="#b8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#b9">AddStripFilters</a> (<a class="el" href="class_swmodule.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the strip filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module".</em> <a href="#b9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#b10">AddRawFilters</a> (<a class="el" href="class_swmodule.html">SWModule</a> *module, ConfigEntMap &section)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds the raw filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module".</em> <a href="#b10">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWMgr::myconfig"></a> +<a class="el" href="class_swconfig.html">SWConfig</a>* </td><td valign=bottom><b>myconfig</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWMgr::mysysconfig"></a> +<a class="el" href="class_swconfig.html">SWConfig</a>* </td><td valign=bottom><b>mysysconfig</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWMgr::configType"></a> +char </td><td valign=bottom><b>configType</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n3" doxytag="SWMgr::optionFilters"></a> +FilterMap </td><td valign=bottom><b>optionFilters</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n4" doxytag="SWMgr::cipherFilters"></a> +FilterMap </td><td valign=bottom><b>cipherFilters</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n5" doxytag="SWMgr::gbfplain"></a> +<a class="el" href="class_swfilter.html">SWFilter</a>* </td><td valign=bottom><b>gbfplain</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n6" doxytag="SWMgr::thmlplain"></a> +<a class="el" href="class_swfilter.html">SWFilter</a>* </td><td valign=bottom><b>thmlplain</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n7" doxytag="SWMgr::cleanupFilters"></a> +FilterList </td><td valign=bottom><b>cleanupFilters</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n8" doxytag="SWMgr::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The main class of Sword to handle all other things. +<p> +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). +<p> +<dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_swmgr.html#b10">AddRawFilters</a>(), <a class="el" href="class_swmgr.html#b8">AddRenderFilters</a>(), <a class="el" href="class_swmgr.html#b9">AddStripFilters</a>() </dl><dl compact><dt> +<b>Version: </b><dd> +</dl><dl compact><dt> +<b>Id: </b><dd> + swmgr.h,v 1.27 2001/10/05 20:37:00 mgruner Exp </dl> +<p> + +<p> +Definition at line <a class="el" href="swmgr_h-source.html#l00063">63</a> of file <a class="el" href="swmgr_h-source.html">swmgr.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWMgr::SWMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWMgr::SWMgr ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swconfig.html">SWConfig</a> * <em>iconfig</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swconfig.html">SWConfig</a> * <em>isysconfig</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +bool <em>autoload</em> = true ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor of SWMgr. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iconfig</em> + </td><td> +</td></tr> +<tr><td valign=top><em>isysconfig</em> + </td><td> +</td></tr> +<tr><td valign=top><em>autoload</em> + </td><td> +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. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a2" doxytag="SWMgr::~SWMgr"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWMgr::~SWMgr ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The destructor of SWMgr. +<p> +This destrutcot cleans up the modules and deletes the created object. Destroy the SWMgr at last in your application. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="b10" doxytag="SWMgr::AddRawFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWMgr::AddRawFilters ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swmodule.html">SWModule</a> * <em>module</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +ConfigEntMap & <em>section</em> )<code> [protected, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the raw filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module". +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module</em> + </td><td> +To this module the raw filter(s) are added </td></tr> +<tr><td valign=top><em>section</em> + </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="b8" doxytag="SWMgr::AddRenderFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWMgr::AddRenderFilters ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swmodule.html">SWModule</a> * <em>module</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +ConfigEntMap & <em>section</em> )<code> [protected, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the render filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module". +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module</em> + </td><td> +To this module the render filter(s) are added </td></tr> +<tr><td valign=top><em>section</em> + </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="b9" doxytag="SWMgr::AddStripFilters"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWMgr::AddStripFilters ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swmodule.html">SWModule</a> * <em>module</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +ConfigEntMap & <em>section</em> )<code> [protected, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds the strip filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module". +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>module</em> + </td><td> +To this module the strip filter(s) are added </td></tr> +<tr><td valign=top><em>section</em> + </td><td> +We use this section to get a list of filters we should apply to the module </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a3" doxytag="SWMgr::InstallScan"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWMgr::InstallScan ( + </b></td> + <td valign="bottom"><b> +const char * <em>dir</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Installs a scan for modules in the directory givan as parameter. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>dir</em> + </td><td> +The directory where new modules should be searched. </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a4" doxytag="SWMgr::Load"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWMgr::Load ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Load the modules. +<p> +Reimplement this function to use your own Load function, for example to use your own filters. </td> + </tr> +</table> +<a name="a11" doxytag="SWMgr::Version"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const float SWMgr::Version ( + </b></td> + <td valign="bottom"><b> +) const<code> [inline]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the Sword version. +<p> +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. <dl compact><dt> +<b>Returns: </b><dd> +The version of the Sword library as a float (e.g. 1.52). </dl> +<p> +Definition at line <a class="el" href="swmgr_h-source.html#l00239">239</a> of file <a class="el" href="swmgr_h-source.html">swmgr.h</a>. </td> + </tr> +</table> +<a name="a6" doxytag="SWMgr::getGlobalOption"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWMgr::getGlobalOption ( + </b></td> + <td valign="bottom"><b> +const char * <em>option</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gives the value of the given option. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>The</em> + </td><td> +option, which should be used to return the value of it </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +The value of the given option </dl> </td> + </tr> +</table> +<a name="a7" doxytag="SWMgr::getGlobalOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWMgr::getGlobalOptionTip ( + </b></td> + <td valign="bottom"><b> +const char * <em>option</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gives a description for the given option. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>option</em> + </td><td> +The option, which should be used </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +A description of the given option </dl><dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_swmgr.html#a5">setGlobalOption</a>, <a class="el" href="class_swmgr.html#a6">getGlobalOption</a>, <a class="el" href="class_swmgr.html#a8">getGlobalOptions</a> </dl> </td> + </tr> +</table> +<a name="a8" doxytag="SWMgr::getGlobalOptions"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList SWMgr::getGlobalOptions ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +A list of all availble options with the currently set values. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +This function returns a list of global options. </dl> </td> + </tr> +</table> +<a name="a10" doxytag="SWMgr::setCipherKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWMgr::setCipherKey ( + </b></td> + <td valign="bottom"><b> +const char * <em>modName</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const char * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the cipher key for the given module. +<p> +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: +<p> +<div class="fragment"><pre> SectionMap::iterator section; + ConfigEntMap::iterator entry; + DIR *dir = opendir(configPath); + <font class="keyword">struct </font>dirent *ent; + <font class="keywordtype">char</font>* modFile; + <font class="keywordflow">if</font> (dir) { <font class="comment">// find and update .conf file</font> + rewinddir(dir); + <font class="keywordflow">while</font> ((ent = readdir(dir))) + { + <font class="keywordflow">if</font> ((strcmp(ent->d_name, <font class="stringliteral">"."</font>)) && (strcmp(ent->d_name, <font class="stringliteral">".."</font>))) + { + modFile = m_backend->configPath; + modFile += <font class="stringliteral">"/"</font>; + modFile += ent->d_name; + <a class="code" href="class_swconfig.html">SWConfig</a> *myConfig = <font class="keyword">new</font> SWConfig( modFile ); + section = myConfig->Sections.find( m_module->Name() ); + <font class="keywordflow">if</font> ( section != myConfig->Sections.end() ) + { + entry = section->second.find(<font class="stringliteral">"CipherKey"</font>); + <font class="keywordflow">if</font> (entry != section->second.end()) + { + entry->second = unlockKey;<font class="comment">//set cipher key</font> + myConfig-><a class="code" href="class_swconfig.html#a3">Save</a>();<font class="comment">//save config file</font> + } + } + <font class="keyword">delete</font> myConfig; + } + } + } + closedir(dir);</pre></div><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>modName</em> + </td><td> +For this module we change the unlockKey </td></tr> +</table> +</dl><dl compact><dt> +<b>an key This is the new unlck key we use for te module.</b><dd> +</dl> </td> + </tr> +</table> +<a name="a5" doxytag="SWMgr::setGlobalOption"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWMgr::setGlobalOption ( + </b></td> + <td valign="bottom"><b> +const char * <em>option</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const char * <em>value</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set a global option Set a global option using the parameters. +<p> +A global option could be for example footnotes. <dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>option</em> + </td><td> +The name of the option, for which you want to change the value. Well known and often used values are "Footnotes" or "Strongs" </td></tr> +<tr><td valign=top><em>value</em> + </td><td> +The value. Common values are "On" and "Off" </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="m0" doxytag="SWMgr::config"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="class_swconfig.html">SWConfig</a> * SWMgr::config + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The global config object. +<p> +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(). +<p> +Definition at line <a class="el" href="swmgr_h-source.html#l00122">122</a> of file <a class="el" href="swmgr_h-source.html">swmgr.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swmgr_h-source.html">swmgr.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swmodule-members.html b/doc/api-documentation/html/class_swmodule-members.html new file mode 100644 index 0000000..8ee6662 --- /dev/null +++ b/doc/api-documentation/html/class_swmodule-members.html @@ -0,0 +1,69 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWModule Member List</h1>This is the complete list of members for <a class="el" href="class_swmodule.html">SWModule</a>, including all inherited members.<ul> +<li><a class="el" href="class_swmodule.html#a41">AddOptionFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a38">AddRawFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a33">AddRenderFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a36">AddStripFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a19">CreateKey</a>() +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#d1">createModule</a>(const char *) +<code> [inline, static]</code><li><b>createSearchFramework</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a27">deleteEntry</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a13">Description</a>(const char *imoddesc=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a11">Disp</a>(SWDisplay *idisp=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#n6">disp</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a10">Display</a>() +<code> [virtual]</code><li><b>entrybuf</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>entrySize</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>error</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a2">Error</a>() +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a39">filterBuffer</a>(FilterList *filters, char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a4">getEntrySize</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a21">getRawEntry</a>()=0 +<code> [pure virtual]</code><li><b>hasSearchFramework</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><b>isSearchOptimallySupported</b>(const char *istr, int searchType, int flags, SWKey *scope) (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a3">isUnicode</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a24">isWritable</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a7">Key</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a8">Key</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n1">key</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a9">KeyText</a>(const char *imodtype=0) +<code> [virtual]</code><li><b>listkey</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>moddesc</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>modname</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>modtype</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a12">Name</a>(const char *imodname=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#d0">nullPercent</a>(char percent, void *userData) +<code> [static]</code><li><a class="el" href="class_swmodule.html#a20">operator char *</a>() +<code> [virtual]</code><li><b>operator SWKey &</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><b>operator SWKey *</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a30">operator++</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a29">operator+=</a>(int increment) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a31">operator--</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a28">operator-=</a>(int decrement) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a25">operator<<</a>(const char *) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a26">operator<<</a>(const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a32">operator=</a>(SW_POSITION p) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a42">optionFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n11">optionFilters</a> +<code> [protected]</code><li><b>rawdisp</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected, static]</code><li><a class="el" href="class_swmodule.html#a40">rawFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n9">rawFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a34">RemoveRenderFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><b>render</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a35">renderFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n10">renderFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a44">RenderText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a46">RenderText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a15">Search</a>(const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a5">SetKey</a>(const SWKey *ikey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a6">SetKey</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a37">stripFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n8">stripFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a43">StripText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a45">StripText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a0">SWModule</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char *imodtype=0, bool unicode=false) +<li><a class="el" href="class_swmodule.html#m0">terminateSearch</a> +<li><a class="el" href="class_swmodule.html#a14">Type</a>(const char *imodtype=0) +<code> [virtual]</code><li><b>unicode</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a1">~SWModule</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swmodule.gif b/doc/api-documentation/html/class_swmodule.gif Binary files differnew file mode 100644 index 0000000..19a75fe --- /dev/null +++ b/doc/api-documentation/html/class_swmodule.gif diff --git a/doc/api-documentation/html/class_swmodule.html b/doc/api-documentation/html/class_swmodule.html new file mode 100644 index 0000000..6be5d93 --- /dev/null +++ b/doc/api-documentation/html/class_swmodule.html @@ -0,0 +1,1980 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWModule class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWModule Class Reference</h1>The class SWModule is the base class for all modules used in Sword. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swmodule_h-source.html">swmodule.h</a>></code> +<p> +<p>Inheritance diagram for SWModule:: +<p><center><img src="class_swmodule.gif" usemap="#SWModule_map" border="0"></center> +<map name="SWModule_map"> +<area href="class_swcom.html" alt="SWCom" shape="rect" coords="0,56,73,80"> +<area href="class_swld.html" alt="SWLD" shape="rect" coords="83,56,156,80"> +<area href="class_swtext.html" alt="SWText" shape="rect" coords="166,56,239,80"> +</map> +<a href="class_swmodule-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_swmodule.html#a0">SWModule</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_swdisplay.html">SWDisplay</a> *idisp=0, char *imodtype=0, bool unicode=false)</td></tr> +<tr><td> </td><td><font size=-1><em>Initializes data for instance of SWModule.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWModule::~SWModule"></a> +virtual </td><td valign=bottom><a class="el" href="class_swmodule.html#a1">~SWModule</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Cleans up instance of SWModule.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swmodule.html#a2">Error</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Gets and clears error status.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const bool </td><td valign=bottom><a class="el" href="class_swmodule.html#a3">isUnicode</a> () const</td></tr> +<tr><td nowrap align=right valign=top>virtual const int </td><td valign=bottom><a class="el" href="class_swmodule.html#a4">getEntrySize</a> () const</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swmodule.html#a5">SetKey</a> (const <a class="el" href="class_swkey.html">SWKey</a> *ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets a key to this module for position to a particular record or set of records.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swmodule.html#a6">SetKey</a> (const <a class="el" href="class_swkey.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the key of this module.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_swkey.html">SWKey</a>& </td><td valign=bottom><a class="el" href="class_swmodule.html#a7">Key</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets the current module key.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swmodule.html#a8">Key</a> (const <a class="el" href="class_swkey.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets the current key of the module to ikey, and returns the keytext.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swmodule.html#a9">KeyText</a> (const char *imodtype=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module KeyText.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swmodule.html#a10">Display</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Calls this modules display object and passes itself.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_swdisplay.html">SWDisplay</a>* </td><td valign=bottom><a class="el" href="class_swmodule.html#a11">Disp</a> (<a class="el" href="class_swdisplay.html">SWDisplay</a> *idisp=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets display driver.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char* </td><td valign=bottom><a class="el" href="class_swmodule.html#a12">Name</a> (const char *imodname=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module name.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char* </td><td valign=bottom><a class="el" href="class_swmodule.html#a13">Description</a> (const char *imoddesc=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module description.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char* </td><td valign=bottom><a class="el" href="class_swmodule.html#a14">Type</a> (const char *imodtype=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets module type.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_listkey.html">ListKey</a>& </td><td valign=bottom><a class="el" href="class_swmodule.html#a15">Search</a> (const char *istr, int searchType=0, int flags=0, <a class="el" href="class_swkey.html">SWKey</a> *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0)</td></tr> +<tr><td> </td><td><font size=-1><em>Searches a module for a string.</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a16" doxytag="SWModule::createSearchFramework"></a> +virtual char </td><td valign=bottom><b>createSearchFramework</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a17" doxytag="SWModule::hasSearchFramework"></a> +virtual bool </td><td valign=bottom><b>hasSearchFramework</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a18" doxytag="SWModule::isSearchOptimallySupported"></a> +virtual bool </td><td valign=bottom><b>isSearchOptimallySupported</b> (const char *istr, int searchType, int flags, <a class="el" href="class_swkey.html">SWKey</a> *scope)</td></tr> +<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_swmodule.html#a19">CreateKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Allocates a key of specific type for module.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_swmodule.html#a20">operator char *</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Renders and returns the current module text.</em> <a href="#a20">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char* </td><td valign=bottom><a class="el" href="class_swmodule.html#a21">getRawEntry</a> ()=0</td></tr> +<tr><td> </td><td><font size=-1><em>This function is reimplemented by the different kinds of module objects.</em> <a href="#a21">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a22" doxytag="SWModule::operator SWKey &"></a> +virtual </td><td valign=bottom><b>operator SWKey &</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a23" doxytag="SWModule::operator SWKey *"></a> +virtual </td><td valign=bottom><b>operator SWKey *</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="class_swmodule.html#a24">isWritable</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Is the module writable? :).</em> <a href="#a24">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a25">operator<<</a> (const char *)</td></tr> +<tr><td> </td><td><font size=-1><em>Modify the current module entry text only if module <a class="el" href="class_swmodule.html#a24">isWritable</a>.</em> <a href="#a25">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a26">operator<<</a> (const <a class="el" href="class_swkey.html">SWKey</a> *)</td></tr> +<tr><td> </td><td><font size=-1><em>Link the current module entry to another module entry only if module <a class="el" href="class_swmodule.html#a24">isWritable</a>.</em> <a href="#a26">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a27" doxytag="SWModule::deleteEntry"></a> +virtual void </td><td valign=bottom><a class="el" href="class_swmodule.html#a27">deleteEntry</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Delete current module entry - only if module <a class="el" href="class_swmodule.html#a24">isWritable</a>.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a28">operator-=</a> (int decrement)</td></tr> +<tr><td> </td><td><font size=-1><em>Decrements module key a number of entries.</em> <a href="#a28">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a29">operator+=</a> (int increment)</td></tr> +<tr><td> </td><td><font size=-1><em>Increments module key a number of entries.</em> <a href="#a29">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a30" doxytag="SWModule::operator++"></a> +virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a30">operator++</a> (int)</td></tr> +<tr><td> </td><td><font size=-1><em>Increments module key by 1 entry.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a31" doxytag="SWModule::operator--"></a> +virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a31">operator--</a> (int)</td></tr> +<tr><td> </td><td><font size=-1><em>Decrements module key by 1 entry.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a32">operator=</a> (SW_POSITION p)</td></tr> +<tr><td> </td><td><font size=-1><em>Positions this modules to an entry.</em> <a href="#a32">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a33">AddRenderFilter</a> (<a class="el" href="class_swfilter.html">SWFilter</a> *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds a RenderFilter to this module's.</em> <a href="#a33">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a34">RemoveRenderFilter</a> (<a class="el" href="class_swfilter.html">SWFilter</a> *oldfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Removes a RenderFilter to this module's.</em> <a href="#a34">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmodule.html#a35">renderFilter</a> (char *buf, long size, <a class="el" href="class_swkey.html">SWKey</a> *<a class="el" href="class_swmodule.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>RenderFilter a text buffer.</em> <a href="#a35">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a36">AddStripFilter</a> (<a class="el" href="class_swfilter.html">SWFilter</a> *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds a StripFilter to this module's stripfilters queue.</em> <a href="#a36">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmodule.html#a37">stripFilter</a> (char *buf, long size, <a class="el" href="class_swkey.html">SWKey</a> *<a class="el" href="class_swmodule.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>StripFilter a text buffer.</em> <a href="#a37">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a38">AddRawFilter</a> (<a class="el" href="class_swfilter.html">SWFilter</a> *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds a RawFilter to this module's rawfilters queue.</em> <a href="#a38">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmodule.html#a39">filterBuffer</a> (FilterList *filters, char *buf, long size, <a class="el" href="class_swkey.html">SWKey</a> *<a class="el" href="class_swmodule.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>FilterBuffer a text buffer.</em> <a href="#a39">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmodule.html#a40">rawFilter</a> (char *buf, long size, <a class="el" href="class_swkey.html">SWKey</a> *<a class="el" href="class_swmodule.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>RawFilter a text buffer.</em> <a href="#a40">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual SWModule& </td><td valign=bottom><a class="el" href="class_swmodule.html#a41">AddOptionFilter</a> (<a class="el" href="class_swfilter.html">SWFilter</a> *newfilter)</td></tr> +<tr><td> </td><td><font size=-1><em>Adds an OptionFilter to this module's optionfilters queue.</em> <a href="#a41">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmodule.html#a42">optionFilter</a> (char *buf, long size, <a class="el" href="class_swkey.html">SWKey</a> *<a class="el" href="class_swmodule.html#n1">key</a>)</td></tr> +<tr><td> </td><td><font size=-1><em>OptionFilter a text buffer.</em> <a href="#a42">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swmodule.html#a43">StripText</a> (char *buf=0, int len=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>calls all StripFilters on buffer or current text.</em> <a href="#a43">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swmodule.html#a44">RenderText</a> (char *buf=0, int len=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>calls all RenderFilters on buffer or current text.</em> <a href="#a44">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swmodule.html#a45">StripText</a> (<a class="el" href="class_swkey.html">SWKey</a> *tmpKey)</td></tr> +<tr><td> </td><td><font size=-1><em>calls all StripFilters on current text.</em> <a href="#a45">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swmodule.html#a46">RenderText</a> (<a class="el" href="class_swkey.html">SWKey</a> *tmpKey)</td></tr> +<tr><td> </td><td><font size=-1><em>calls all RenderFilters on current text.</em> <a href="#a46">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_swmodule.html#m0">terminateSearch</a></td></tr> +<tr><td> </td><td><font size=-1><em>Set this bool to false to terminate the search which is executed by this module (<a class="el" href="class_swmodule.html#a15">Search</a>).</em> <a href="#m0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_swmodule.html#d0">nullPercent</a> (char percent, void *userData)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the default callback function for searching.</em> <a href="#d0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="class_swmodule.html#d1">createModule</a> (const char *)</td></tr> +<tr><td> </td><td><font size=-1><em>Creates a new module.</em> <a href="#d1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWModule::error"></a> +char </td><td valign=bottom><b>error</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWModule::key"></a> +<a class="el" href="class_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_swmodule.html#n1">key</a></td></tr> +<tr><td> </td><td><font size=-1><em>the current key.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWModule::listkey"></a> +<a class="el" href="class_listkey.html">ListKey</a> </td><td valign=bottom><b>listkey</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n3" doxytag="SWModule::modname"></a> +char* </td><td valign=bottom><b>modname</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n4" doxytag="SWModule::moddesc"></a> +char* </td><td valign=bottom><b>moddesc</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n5" doxytag="SWModule::modtype"></a> +char* </td><td valign=bottom><b>modtype</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n6" doxytag="SWModule::disp"></a> +<a class="el" href="class_swdisplay.html">SWDisplay</a>* </td><td valign=bottom><a class="el" href="class_swmodule.html#n6">disp</a></td></tr> +<tr><td> </td><td><font size=-1><em>this module's display object.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n7" doxytag="SWModule::entrybuf"></a> +char* </td><td valign=bottom><b>entrybuf</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n8" doxytag="SWModule::stripFilters"></a> +FilterList* </td><td valign=bottom><a class="el" href="class_swmodule.html#n8">stripFilters</a></td></tr> +<tr><td> </td><td><font size=-1><em>executed to remove all markup (for searches).</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n9" doxytag="SWModule::rawFilters"></a> +FilterList* </td><td valign=bottom><a class="el" href="class_swmodule.html#n9">rawFilters</a></td></tr> +<tr><td> </td><td><font size=-1><em>executed immediately upon fileread.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n10" doxytag="SWModule::renderFilters"></a> +FilterList* </td><td valign=bottom><a class="el" href="class_swmodule.html#n10">renderFilters</a></td></tr> +<tr><td> </td><td><font size=-1><em>executed to format for display.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n11" doxytag="SWModule::optionFilters"></a> +FilterList* </td><td valign=bottom><a class="el" href="class_swmodule.html#n11">optionFilters</a></td></tr> +<tr><td> </td><td><font size=-1><em>executed to change markup to user prefs.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="n12" doxytag="SWModule::render"></a> +bool </td><td valign=bottom><b>render</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n13" doxytag="SWModule::unicode"></a> +bool </td><td valign=bottom><b>unicode</b></td></tr> +<tr><td nowrap align=right valign=top><a name="n14" doxytag="SWModule::entrySize"></a> +int </td><td valign=bottom><b>entrySize</b></td></tr> +<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="q0" doxytag="SWModule::rawdisp"></a> +<a class="el" href="class_swdisplay.html">SWDisplay</a> </td><td valign=bottom><b>rawdisp</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The class SWModule is the base class for all modules used in Sword. +<p> + +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00047">47</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWModule::SWModule"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule::SWModule ( + </b></td> + <td valign="bottom"><b> +const char * <em>imodname</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const char * <em>imoddesc</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swdisplay.html">SWDisplay</a> * <em>idisp</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>imodtype</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +bool <em>unicode</em> = false ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initializes data for instance of SWModule. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodname</em> + </td><td> +Internal name for module; see also <a class="el" href="class_swmodule.html#a12">Name</a> </td></tr> +<tr><td valign=top><em>imoddesc</em> + </td><td> +Name to display to user for module; see also <a class="el" href="class_swmodule.html#a13">Description</a> </td></tr> +<tr><td valign=top><em>idisp</em> + </td><td> +Display object to use for displaying see also <a class="el" href="class_swmodule.html#a11">Disp</a> </td></tr> +<tr><td valign=top><em>imodtype</em> + </td><td> +Type of Module (All modules will be displayed with others of same type under their modtype heading) see also <a class="el" href="class_swmodule.html#a14">Type</a> </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a41" doxytag="SWModule::AddOptionFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule & SWModule::AddOptionFilter ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swfilter.html">SWFilter</a> * <em>newfilter</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds an OptionFilter to this module's optionfilters queue. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newfilter</em> + </td><td> +the filter to add </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00443">443</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a38" doxytag="SWModule::AddRawFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule & SWModule::AddRawFilter ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swfilter.html">SWFilter</a> * <em>newfilter</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds a RawFilter to this module's rawfilters queue. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newfilter</em> + </td><td> +the filter to add </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00410">410</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a33" doxytag="SWModule::AddRenderFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule & SWModule::AddRenderFilter ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swfilter.html">SWFilter</a> * <em>newfilter</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds a RenderFilter to this module's. +<p> +<dl compact><dt> +<b>See also: </b><dd> +renderfilters queue </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newfilter</em> + </td><td> +the filter to add </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00363">363</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a36" doxytag="SWModule::AddStripFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule & SWModule::AddStripFilter ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swfilter.html">SWFilter</a> * <em>newfilter</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Adds a StripFilter to this module's stripfilters queue. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>newfilter</em> + </td><td> +the filter to add </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00391">391</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a19" doxytag="SWModule::CreateKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="class_swkey.html">SWKey</a> * SWModule::CreateKey ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Allocates a key of specific type for module. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +pointer to allocated key </dl> +<p> +Reimplemented in <a class="el" href="class_swcom.html#a2">SWCom</a>, <a class="el" href="class_swld.html#a2">SWLD</a>, and <a class="el" href="class_swtext.html#a2">SWText</a>. </td> + </tr> +</table> +<a name="a13" doxytag="SWModule::Description"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char * SWModule::Description ( + </b></td> + <td valign="bottom"><b> +const char * <em>imoddesc</em> = 0 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module description. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imoddesc</em> + </td><td> +value which to set moddesc; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to moddesc </dl> </td> + </tr> +</table> +<a name="a11" doxytag="SWModule::Disp"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="class_swdisplay.html">SWDisplay</a> * SWModule::Disp ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swdisplay.html">SWDisplay</a> * <em>idisp</em> = 0 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets display driver. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>idisp</em> + </td><td> +value which to set disp; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to disp </dl> </td> + </tr> +</table> +<a name="a10" doxytag="SWModule::Display"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWModule::Display ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Calls this modules display object and passes itself. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +error status </dl> </td> + </tr> +</table> +<a name="a2" doxytag="SWModule::Error"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWModule::Error ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets and clears error status. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +error status </dl> </td> + </tr> +</table> +<a name="a8" doxytag="SWModule::Key"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWModule::Key ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="class_swkey.html">SWKey</a> & <em>ikey</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the current key of the module to ikey, and returns the keytext. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +new current key for the module </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +the keytext of the current module key </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00161">161</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="SWModule::Key"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="class_swkey.html">SWKey</a> & SWModule::Key ( + </b></td> + <td valign="bottom"><b> +) const<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets the current module key. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +the current key of this module </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00151">151</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a9" doxytag="SWModule::KeyText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWModule::KeyText ( + </b></td> + <td valign="bottom"><b> +const char * <em>ikeytext</em> = 0 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module KeyText. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikeytext</em> + </td><td> +value which to set keytext; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to keytext </dl> +<p> +Reimplemented in <a class="el" href="class_swld.html#a3">SWLD</a>. </td> + </tr> +</table> +<a name="a12" doxytag="SWModule::Name"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char * SWModule::Name ( + </b></td> + <td valign="bottom"><b> +const char * <em>imodname</em> = 0 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module name. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodname</em> + </td><td> +value which to set modname; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to modname </dl> </td> + </tr> +</table> +<a name="a34" doxytag="SWModule::RemoveRenderFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule & SWModule::RemoveRenderFilter ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swfilter.html">SWFilter</a> * <em>oldfilter</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Removes a RenderFilter to this module's. +<p> +<dl compact><dt> +<b>See also: </b><dd> +renderfilters queue </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>oldfilter</em> + </td><td> +the filter to remove </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00372">372</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a46" doxytag="SWModule::RenderText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWModule::RenderText ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swkey.html">SWKey</a> * <em>tmpKey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +calls all RenderFilters on current text. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>tmpKey</em> + </td><td> +key to use to grab text </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +this module's text at specified key location massaged by Render filters </dl> </td> + </tr> +</table> +<a name="a44" doxytag="SWModule::RenderText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWModule::RenderText ( + </b></td> + <td valign="bottom"><b> +char * <em>buf</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>len</em> = -1 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +calls all RenderFilters on buffer or current text. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf</em> + </td><td> +buffer to Render instead of current module position; if buf is NULL, the current text will be used </td></tr> +<tr><td valign=top><em>len</em> + </td><td> +max len of buf OR current text -- will be applied anyway </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +this module's text at specified key location massaged by Render filters </dl> </td> + </tr> +</table> +<a name="a15" doxytag="SWModule::Search"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +<a class="el" href="class_listkey.html">ListKey</a> & SWModule::Search ( + </b></td> + <td valign="bottom"><b> +const char * <em>istr</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>searchType</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>flags</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swkey.html">SWKey</a> * <em>scope</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +bool * <em>justCheckIfSupported</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +void(* <em>percent</em>)(char, void *) = &nullPercent, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +void * <em>percentUserData</em> = 0 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Searches a module for a string. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>istr</em> + </td><td> +string for which to search </td></tr> +<tr><td valign=top><em>searchType</em> + </td><td> +type of search to perform >=0 ->regex; 1->phrase; 2->multiword; </td></tr> +<tr><td valign=top><em>flags</em> + </td><td> +options flags for search </td></tr> +<tr><td valign=top><em>justCheckIfSupported</em> + </td><td> +if set, don't search, only tell if this function supports requested search. +<p> +</td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +listkey set to verses that contain istr </dl> </td> + </tr> +</table> +<a name="a6" doxytag="SWModule::SetKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWModule::SetKey ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="class_swkey.html">SWKey</a> & <em>ikey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets the key of this module. +<p> +Similair to <dl compact><dt> +<b>See also: </b><dd> +<a class="el" href="class_swmodule.html#a5">SetKey</a>(const SWKey*) . </dl><dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +The <a class="el" href="class_swkey.html">SWKey</a> which should be used as new key. </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +Error status </dl> </td> + </tr> +</table> +<a name="a5" doxytag="SWModule::SetKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWModule::SetKey ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>ikey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets a key to this module for position to a particular record or set of records. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +key with which to set this module </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +error status </dl> +<p> +Referenced by <a class="el" href="swmodule_h-source.html#l00161">Key</a>(). </td> + </tr> +</table> +<a name="a45" doxytag="SWModule::StripText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWModule::StripText ( + </b></td> + <td valign="bottom"><b> +<a class="el" href="class_swkey.html">SWKey</a> * <em>tmpKey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +calls all StripFilters on current text. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>tmpKey</em> + </td><td> +key to use to grab text </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +this module's text at specified key location massaged by Strip filters </dl> </td> + </tr> +</table> +<a name="a43" doxytag="SWModule::StripText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * SWModule::StripText ( + </b></td> + <td valign="bottom"><b> +char * <em>buf</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>len</em> = -1 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +calls all StripFilters on buffer or current text. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf</em> + </td><td> +buf to massage instead of current module position; if buf is NULL, the current text will be used </td></tr> +<tr><td valign=top><em>len</em> + </td><td> +max len of buf OR current text -- will be applied anyway </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +this module's text at specified key location massaged by Strip filters </dl> </td> + </tr> +</table> +<a name="a14" doxytag="SWModule::Type"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char * SWModule::Type ( + </b></td> + <td valign="bottom"><b> +const char * <em>imodtype</em> = 0 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets module type. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodtype</em> + </td><td> +value which to set modtype; [0] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +pointer to modtype </dl> </td> + </tr> +</table> +<a name="d1" doxytag="SWModule::createModule"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char SWModule::createModule ( + </b></td> + <td valign="bottom"><b> +const char * <em>path</em> )<code> [inline, static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a new module. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>path</em> + </td><td> +The first parameter is path of the new module </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +error </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00296">296</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a39" doxytag="SWModule::filterBuffer"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWModule::filterBuffer ( + </b></td> + <td valign="bottom"><b> +FilterList * <em>filters</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +char * <em>buf</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +long <em>size</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +FilterBuffer a text buffer. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>filters</em> + </td><td> +the FilterList of filters to iterate </td></tr> +<tr><td valign=top><em>buf</em> + </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size</em> + </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00422">422</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. +<p> +Referenced by <a class="el" href="swmodule_h-source.html#l00454">optionFilter</a>(), <a class="el" href="swmodule_h-source.html#l00435">rawFilter</a>(), <a class="el" href="swmodule_h-source.html#l00383">renderFilter</a>(), and <a class="el" href="swmodule_h-source.html#l00402">stripFilter</a>(). </td> + </tr> +</table> +<a name="a4" doxytag="SWModule::getEntrySize"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const int SWModule::getEntrySize ( + </b></td> + <td valign="bottom"><b> +) const<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt> +<b>Returns: </b><dd> +The size of the current entry. </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00130">130</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a21" doxytag="SWModule::getRawEntry"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char * SWModule::getRawEntry ( + </b></td> + <td valign="bottom"><b> +)<code> [pure virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This function is reimplemented by the different kinds of module objects. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +the raw module text of the current entry </dl> </td> + </tr> +</table> +<a name="a3" doxytag="SWModule::isUnicode"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const bool SWModule::isUnicode ( + </b></td> + <td valign="bottom"><b> +) const<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +<dl compact><dt> +<b>Returns: </b><dd> +True if this module is encoded in Unicode, otherwise return false. </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00126">126</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a24" doxytag="SWModule::isWritable"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +bool SWModule::isWritable ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Is the module writable? :). +<p> +<dl compact><dt> +<b>Returns: </b><dd> +yes or no </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00288">288</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="d0" doxytag="SWModule::nullPercent"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWModule::nullPercent ( + </b></td> + <td valign="bottom"><b> +char <em>percent</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +void * <em>userData</em> )<code> [static]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the default callback function for searching. +<p> +This function is a placeholder and does nothing. You can define your own function for search progress evaluation, and pass it over to <a class="el" href="class_swmodule.html#a15">Search</a>. </td> + </tr> +</table> +<a name="a20" doxytag="SWModule::operator char *"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule::operator char * ( + </b></td> + <td valign="bottom"><b> +)<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Renders and returns the current module text. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +the rendered current module text </dl> </td> + </tr> +</table> +<a name="a29" doxytag="SWModule::operator+="></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule & SWModule::operator+= ( + </b></td> + <td valign="bottom"><b> +int <em>increment</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Increments module key a number of entries. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>increment</em> + </td><td> +Number of entries to jump forward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> </td> + </tr> +</table> +<a name="a28" doxytag="SWModule::operator-="></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule & SWModule::operator-= ( + </b></td> + <td valign="bottom"><b> +int <em>decrement</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Decrements module key a number of entries. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>decrement</em> + </td><td> +Number of entries to jump backward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> </td> + </tr> +</table> +<a name="a26" doxytag="SWModule::operator<<"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule & SWModule::operator<< ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>linkKey</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Link the current module entry to another module entry only if module <a class="el" href="class_swmodule.html#a24">isWritable</a>. +<p> +<ul> +<li><dl compact><dt> +<b>Returns: </b><dd> +*this </dl></ul> + +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00312">312</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a25" doxytag="SWModule::operator<<"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule & SWModule::operator<< ( + </b></td> + <td valign="bottom"><b> +const char * <em>inbuf</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Modify the current module entry text only if module <a class="el" href="class_swmodule.html#a24">isWritable</a>. +<p> +<ul> +<li><dl compact><dt> +<b>Returns: </b><dd> +*this </dl></ul> + +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00304">304</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a32" doxytag="SWModule::operator="></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWModule & SWModule::operator= ( + </b></td> + <td valign="bottom"><b> +SW_POSITION <em>pos</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Positions this modules to an entry. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>p</em> + </td><td> +position (e.g. TOP, BOTTOM) </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> </td> + </tr> +</table> +<a name="a42" doxytag="SWModule::optionFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWModule::optionFilter ( + </b></td> + <td valign="bottom"><b> +char * <em>buf</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +long <em>size</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +OptionFilter a text buffer. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf</em> + </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size</em> + </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00454">454</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a40" doxytag="SWModule::rawFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWModule::rawFilter ( + </b></td> + <td valign="bottom"><b> +char * <em>buf</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +long <em>size</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +RawFilter a text buffer. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf</em> + </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size</em> + </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00435">435</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a35" doxytag="SWModule::renderFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWModule::renderFilter ( + </b></td> + <td valign="bottom"><b> +char * <em>buf</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +long <em>size</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +RenderFilter a text buffer. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf</em> + </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size</em> + </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00383">383</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<a name="a37" doxytag="SWModule::stripFilter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void SWModule::stripFilter ( + </b></td> + <td valign="bottom"><b> +char * <em>buf</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +long <em>size</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +StripFilter a text buffer. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>buf</em> + </td><td> +the buffer to filter </td></tr> +<tr><td valign=top><em>size</em> + </td><td> +the allocated size of the buffer </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +key location from where this buffer was extracted </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00402">402</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="m0" doxytag="SWModule::terminateSearch"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +bool SWModule::terminateSearch + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set this bool to false to terminate the search which is executed by this module (<a class="el" href="class_swmodule.html#a15">Search</a>). +<p> +This is useful for threaded applications to terminate the search in another thread. +<p> +Definition at line <a class="el" href="swmodule_h-source.html#l00097">97</a> of file <a class="el" href="swmodule_h-source.html">swmodule.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swmodule_h-source.html">swmodule.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swobject-members.html b/doc/api-documentation/html/class_swobject-members.html new file mode 100644 index 0000000..d6a7af2 --- /dev/null +++ b/doc/api-documentation/html/class_swobject-members.html @@ -0,0 +1,19 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWObject Member List</h1>This is the complete list of members for <a class="el" href="class_swobject.html">SWObject</a>, including all inherited members.<ul> +<li><a class="el" href="class_swobject.html#a0">getClass</a>() const +<code> [inline]</code><li><b>myclass</b> (defined in <a class="el" href="class_swobject.html">SWObject</a>)<code> [protected]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swobject.gif b/doc/api-documentation/html/class_swobject.gif Binary files differnew file mode 100644 index 0000000..17d220d --- /dev/null +++ b/doc/api-documentation/html/class_swobject.gif diff --git a/doc/api-documentation/html/class_swobject.html b/doc/api-documentation/html/class_swobject.html new file mode 100644 index 0000000..73cdc4e --- /dev/null +++ b/doc/api-documentation/html/class_swobject.html @@ -0,0 +1,82 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWObject class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWObject Class Reference</h1>Base class for major Sword classes. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swobject_h-source.html">swobject.h</a>></code> +<p> +<p>Inheritance diagram for SWObject:: +<p><center><img src="class_swobject.gif" usemap="#SWObject_map" border="0"></center> +<map name="SWObject_map"> +<area href="class_swkey.html" alt="SWKey" shape="rect" coords="78,56,146,80"> +<area href="class_listkey.html" alt="ListKey" shape="rect" coords="0,112,68,136"> +<area href="class_strkey.html" alt="StrKey" shape="rect" coords="78,112,146,136"> +<area href="class_versekey.html" alt="VerseKey" shape="rect" coords="156,112,224,136"> +</map> +<a href="class_swobject-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>const <a class="el" href="class_swclass.html">SWClass</a>* </td><td valign=bottom><a class="el" href="class_swobject.html#a0">getClass</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Use this to get the class definition and inheritance order.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWObject::myclass"></a> +<a class="el" href="class_swclass.html">SWClass</a>* </td><td valign=bottom><b>myclass</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Base class for major Sword classes. +<p> +SWObject is the base class for major Sword classes like <a class="el" href="class_swkey.html">SWKey</a>. 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). +<p> + +<p> +Definition at line <a class="el" href="swobject_h-source.html#l00041">41</a> of file <a class="el" href="swobject_h-source.html">swobject.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a0" doxytag="SWObject::getClass"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const <a class="el" href="class_swclass.html">SWClass</a> * SWObject::getClass ( + </b></td> + <td valign="bottom"><b> +) const<code> [inline]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Use this to get the class definition and inheritance order. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +The class definition of this object </dl> +<p> +Definition at line <a class="el" href="swobject_h-source.html#l00049">49</a> of file <a class="el" href="swobject_h-source.html">swobject.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swobject_h-source.html">swobject.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swtext-members.html b/doc/api-documentation/html/class_swtext-members.html new file mode 100644 index 0000000..8c36322 --- /dev/null +++ b/doc/api-documentation/html/class_swtext-members.html @@ -0,0 +1,70 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWText Member List</h1>This is the complete list of members for <a class="el" href="class_swtext.html">SWText</a>, including all inherited members.<ul> +<li><a class="el" href="class_swmodule.html#a41">AddOptionFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a38">AddRawFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a33">AddRenderFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a36">AddStripFilter</a>(SWFilter *newfilter) +<code> [inline, virtual]</code><li><a class="el" href="class_swtext.html#a2">CreateKey</a>() +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#d1">createModule</a>(const char *) +<code> [inline, static]</code><li><b>createSearchFramework</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a27">deleteEntry</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a13">Description</a>(const char *imoddesc=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a11">Disp</a>(SWDisplay *idisp=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#n6">disp</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a10">Display</a>() +<code> [virtual]</code><li><b>entrybuf</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>entrySize</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a2">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a39">filterBuffer</a>(FilterList *filters, char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a4">getEntrySize</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a21">getRawEntry</a>()=0 +<code> [pure virtual]</code><li><b>hasSearchFramework</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><b>isSearchOptimallySupported</b>(const char *istr, int searchType, int flags, SWKey *scope) (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a3">isUnicode</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a24">isWritable</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a7">Key</a>() const +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a8">Key</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n1">key</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a9">KeyText</a>(const char *imodtype=0) +<code> [virtual]</code><li><b>listkey</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>moddesc</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>modname</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><b>modtype</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a12">Name</a>(const char *imodname=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#d0">nullPercent</a>(char percent, void *userData) +<code> [static]</code><li><a class="el" href="class_swmodule.html#a20">operator char *</a>() +<code> [virtual]</code><li><b>operator SWKey &</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><b>operator SWKey *</b>() (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a30">operator++</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a29">operator+=</a>(int increment) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a31">operator--</a>(int) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a28">operator-=</a>(int decrement) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a25">operator<<</a>(const char *) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a26">operator<<</a>(const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#a32">operator=</a>(SW_POSITION p) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a42">optionFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n11">optionFilters</a> +<code> [protected]</code><li><b>rawdisp</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected, static]</code><li><a class="el" href="class_swmodule.html#a40">rawFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n9">rawFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a34">RemoveRenderFilter</a>(SWFilter *oldfilter) +<code> [inline, virtual]</code><li><b>render</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a35">renderFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n10">renderFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a44">RenderText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a46">RenderText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a15">Search</a>(const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a5">SetKey</a>(const SWKey *ikey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a6">SetKey</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a37">stripFilter</a>(char *buf, long size, SWKey *key) +<code> [inline, virtual]</code><li><a class="el" href="class_swmodule.html#n8">stripFilters</a> +<code> [protected]</code><li><a class="el" href="class_swmodule.html#a43">StripText</a>(char *buf=0, int len=-1) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a45">StripText</a>(SWKey *tmpKey) +<code> [virtual]</code><li><a class="el" href="class_swmodule.html#a0">SWModule</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, char *imodtype=0, bool unicode=false) +<li><a class="el" href="class_swtext.html#a0">SWText</a>(const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, bool unicode=false) +<li><a class="el" href="class_swmodule.html#m0">terminateSearch</a> +<li><a class="el" href="class_swmodule.html#a14">Type</a>(const char *imodtype=0) +<code> [virtual]</code><li><b>unicode</b> (defined in <a class="el" href="class_swmodule.html">SWModule</a>)<code> [protected]</code><li><a class="el" href="class_swmodule.html#a1">~SWModule</a>() +<code> [virtual]</code><li><b>~SWText</b>() (defined in <a class="el" href="class_swtext.html">SWText</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_swtext.gif b/doc/api-documentation/html/class_swtext.gif Binary files differnew file mode 100644 index 0000000..5693191 --- /dev/null +++ b/doc/api-documentation/html/class_swtext.gif diff --git a/doc/api-documentation/html/class_swtext.html b/doc/api-documentation/html/class_swtext.html new file mode 100644 index 0000000..d075c6b --- /dev/null +++ b/doc/api-documentation/html/class_swtext.html @@ -0,0 +1,106 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SWText class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>SWText Class Reference</h1>The basis for all text modules. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="swtext_h-source.html">swtext.h</a>></code> +<p> +<p>Inheritance diagram for SWText:: +<p><center><img src="class_swtext.gif" usemap="#SWText_map" border="0"></center> +<map name="SWText_map"> +<area href="class_swmodule.html" alt="SWModule" shape="rect" coords="0,0,73,24"> +</map> +<a href="class_swtext-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_swtext.html#a0">SWText</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_swdisplay.html">SWDisplay</a> *idisp=0, bool unicode=false)</td></tr> +<tr><td> </td><td><font size=-1><em>Initializes data for instance of SWText.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWText::~SWText"></a> +virtual </td><td valign=bottom><b>~SWText</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="SWText::CreateKey"></a> +virtual <a class="el" href="class_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_swtext.html#a2">CreateKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Create the correct key (<a class="el" href="class_versekey.html">VerseKey</a>) for use with SWText.</em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The basis for all text modules. +<p> + +<p> +Definition at line <a class="el" href="swtext_h-source.html#l00034">34</a> of file <a class="el" href="swtext_h-source.html">swtext.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="SWText::SWText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +SWText::SWText ( + </b></td> + <td valign="bottom"><b> +const char * <em>imodname</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const char * <em>imoddesc</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +<a class="el" href="class_swdisplay.html">SWDisplay</a> * <em>idisp</em> = 0, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +bool <em>unicode</em> = false ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Initializes data for instance of SWText. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>imodname</em> + </td><td> +Internal name for module </td></tr> +<tr><td valign=top><em>imoddesc</em> + </td><td> +Name to display to user for module </td></tr> +<tr><td valign=top><em>idisp</em> + </td><td> +Display object to use for displaying </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="swtext_h-source.html">swtext.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_footnotes-members.html b/doc/api-documentation/html/class_th_m_l_footnotes-members.html new file mode 100644 index 0000000..2a2a183 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_footnotes-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLFootnotes Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [virtual]</code><li><b>ThMLFootnotes</b>() (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~ThMLFootnotes</b>() (defined in <a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_footnotes.gif b/doc/api-documentation/html/class_th_m_l_footnotes.gif Binary files differnew file mode 100644 index 0000000..25b5687 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_footnotes.gif diff --git a/doc/api-documentation/html/class_th_m_l_footnotes.html b/doc/api-documentation/html/class_th_m_l_footnotes.html new file mode 100644 index 0000000..534a09e --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_footnotes.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLFootnotes class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLFootnotes Class Reference</h1>This Filter shows/hides footnotes in a ThML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlfootnotes_8h-source.html">thmlfootnotes.h</a>></code> +<p> +<a href="class_th_m_l_footnotes-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLFootnotes::ThMLFootnotes"></a> + </td><td valign=bottom><b>ThMLFootnotes</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ThMLFootnotes::~ThMLFootnotes"></a> +virtual </td><td valign=bottom><b>~ThMLFootnotes</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="ThMLFootnotes::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="ThMLFootnotes::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="ThMLFootnotes::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="ThMLFootnotes::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="ThMLFootnotes::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="ThMLFootnotes::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="ThMLFootnotes::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="ThMLFootnotes::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="ThMLFootnotes::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="ThMLFootnotes::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="ThMLFootnotes::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="ThMLFootnotes::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides footnotes in a ThML text. +<p> + +<p> +Definition at line <a class="el" href="thmlfootnotes_8h-source.html#l00030">30</a> of file <a class="el" href="thmlfootnotes_8h-source.html">thmlfootnotes.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlfootnotes_8h-source.html">thmlfootnotes.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_g_b_f-members.html b/doc/api-documentation/html/class_th_m_l_g_b_f-members.html new file mode 100644 index 0000000..29608c3 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_g_b_f-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLGBF Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_g_b_f.html">ThMLGBF</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <a class="el" href="class_th_m_l_g_b_f.html">ThMLGBF</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *, const SWModule *=0) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ThMLGBF</b>() (defined in <a class="el" href="class_th_m_l_g_b_f.html">ThMLGBF</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_g_b_f.gif b/doc/api-documentation/html/class_th_m_l_g_b_f.gif Binary files differnew file mode 100644 index 0000000..0a3fba0 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_g_b_f.gif diff --git a/doc/api-documentation/html/class_th_m_l_g_b_f.html b/doc/api-documentation/html/class_th_m_l_g_b_f.html new file mode 100644 index 0000000..bfc2372 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_g_b_f.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLGBF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLGBF Class Reference</h1>this filter converts ThML text to GBF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlgbf_8h-source.html">thmlgbf.h</a>></code> +<p> +<a href="class_th_m_l_g_b_f-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLGBF::ThMLGBF"></a> + </td><td valign=bottom><b>ThMLGBF</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ThMLGBF::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen=-1)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to GBF text. +<p> + +<p> +Definition at line <a class="el" href="thmlgbf_8h-source.html#l00030">30</a> of file <a class="el" href="thmlgbf_8h-source.html">thmlgbf.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlgbf_8h-source.html">thmlgbf.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_h_t_m_l-members.html b/doc/api-documentation/html/class_th_m_l_h_t_m_l-members.html new file mode 100644 index 0000000..7ab3399 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_h_t_m_l-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLHTML Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_h_t_m_l.html">ThMLHTML</a>, including all inherited members.<ul> +<li><b>addEscapeStringSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>addTokenSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>DualStringMap</b> typedef (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>escSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>handleEscapeString</b>(char **buf, const char *escString, DualStringMap &userData) (defined in <b>SWBasicFilter</b>)<code> [protected, virtual]</code><li><b>handleToken</b>(char **buf, const char *token, DualStringMap &userData) (defined in <a class="el" href="class_th_m_l_h_t_m_l.html">ThMLHTML</a>)<code> [protected, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *, const SWModule *=0) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>pushString</b>(char **buf, const char *format,...) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeEnd</b>(const char *escEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStart</b>(const char *escStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStringCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setPassThruUnknownEscapeString</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setPassThruUnknownToken</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenEnd</b>(const char *tokenEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenStart</b>(const char *tokenStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteEscapeString</b>(char **buf, const char *escString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteToken</b>(char **buf, const char *token) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<li><b>ThMLHTML</b>() (defined in <a class="el" href="class_th_m_l_h_t_m_l.html">ThMLHTML</a>)<li><b>tokenSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>~SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_h_t_m_l.html b/doc/api-documentation/html/class_th_m_l_h_t_m_l.html new file mode 100644 index 0000000..f37044c --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_h_t_m_l.html @@ -0,0 +1,35 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLHTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLHTML Class Reference</h1>this filter converts ThML text to HTML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlhtml_8h-source.html">thmlhtml.h</a>></code> +<p> +<a href="class_th_m_l_h_t_m_l-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLHTML::ThMLHTML"></a> + </td><td valign=bottom><b>ThMLHTML</b> ()</td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="ThMLHTML::handleToken"></a> +virtual bool </td><td valign=bottom><b>handleToken</b> (char **buf, const char *token, DualStringMap &userData)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to HTML text. +<p> + +<p> +Definition at line <a class="el" href="thmlhtml_8h-source.html#l00028">28</a> of file <a class="el" href="thmlhtml_8h-source.html">thmlhtml.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlhtml_8h-source.html">thmlhtml.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_h_t_m_l_h_r_e_f-members.html b/doc/api-documentation/html/class_th_m_l_h_t_m_l_h_r_e_f-members.html new file mode 100644 index 0000000..9686c86 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_h_t_m_l_h_r_e_f-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLHTMLHREF Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_h_t_m_l_h_r_e_f.html">ThMLHTMLHREF</a>, including all inherited members.<ul> +<li><b>addEscapeStringSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>addTokenSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>DualStringMap</b> typedef (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>escSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>handleEscapeString</b>(char **buf, const char *escString, DualStringMap &userData) (defined in <b>SWBasicFilter</b>)<code> [protected, virtual]</code><li><b>handleToken</b>(char **buf, const char *token, DualStringMap &userData) (defined in <a class="el" href="class_th_m_l_h_t_m_l_h_r_e_f.html">ThMLHTMLHREF</a>)<code> [protected, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *, const SWModule *=0) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>pushString</b>(char **buf, const char *format,...) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeEnd</b>(const char *escEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStart</b>(const char *escStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStringCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setPassThruUnknownEscapeString</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setPassThruUnknownToken</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenEnd</b>(const char *tokenEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenStart</b>(const char *tokenStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteEscapeString</b>(char **buf, const char *escString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteToken</b>(char **buf, const char *token) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<li><b>ThMLHTMLHREF</b>() (defined in <a class="el" href="class_th_m_l_h_t_m_l_h_r_e_f.html">ThMLHTMLHREF</a>)<li><b>tokenSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>~SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_h_t_m_l_h_r_e_f.html b/doc/api-documentation/html/class_th_m_l_h_t_m_l_h_r_e_f.html new file mode 100644 index 0000000..3f73831 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_h_t_m_l_h_r_e_f.html @@ -0,0 +1,35 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLHTMLHREF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLHTMLHREF Class Reference</h1>this filter converts ThML text to HTML text with hrefs. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlhtmlhref_8h-source.html">thmlhtmlhref.h</a>></code> +<p> +<a href="class_th_m_l_h_t_m_l_h_r_e_f-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLHTMLHREF::ThMLHTMLHREF"></a> + </td><td valign=bottom><b>ThMLHTMLHREF</b> ()</td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="ThMLHTMLHREF::handleToken"></a> +virtual bool </td><td valign=bottom><b>handleToken</b> (char **buf, const char *token, DualStringMap &userData)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to HTML text with hrefs. +<p> + +<p> +Definition at line <a class="el" href="thmlhtmlhref_8h-source.html#l00026">26</a> of file <a class="el" href="thmlhtmlhref_8h-source.html">thmlhtmlhref.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlhtmlhref_8h-source.html">thmlhtmlhref.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_headings-members.html b/doc/api-documentation/html/class_th_m_l_headings-members.html new file mode 100644 index 0000000..81682af --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_headings-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLHeadings Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [virtual]</code><li><b>ThMLHeadings</b>() (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~ThMLHeadings</b>() (defined in <a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_headings.gif b/doc/api-documentation/html/class_th_m_l_headings.gif Binary files differnew file mode 100644 index 0000000..86b82bb --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_headings.gif diff --git a/doc/api-documentation/html/class_th_m_l_headings.html b/doc/api-documentation/html/class_th_m_l_headings.html new file mode 100644 index 0000000..b373796 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_headings.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLHeadings class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLHeadings Class Reference</h1>This Filter shows/hides headings in a ThML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlheadings_8h-source.html">thmlheadings.h</a>></code> +<p> +<a href="class_th_m_l_headings-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLHeadings::ThMLHeadings"></a> + </td><td valign=bottom><b>ThMLHeadings</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ThMLHeadings::~ThMLHeadings"></a> +virtual </td><td valign=bottom><b>~ThMLHeadings</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="ThMLHeadings::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="ThMLHeadings::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="ThMLHeadings::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="ThMLHeadings::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="ThMLHeadings::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="ThMLHeadings::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="ThMLHeadings::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="ThMLHeadings::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="ThMLHeadings::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="ThMLHeadings::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="ThMLHeadings::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="ThMLHeadings::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides headings in a ThML text. +<p> + +<p> +Definition at line <a class="el" href="thmlheadings_8h-source.html#l00030">30</a> of file <a class="el" href="thmlheadings_8h-source.html">thmlheadings.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlheadings_8h-source.html">thmlheadings.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_lemma-members.html b/doc/api-documentation/html/class_th_m_l_lemma-members.html new file mode 100644 index 0000000..d40e927 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_lemma-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLLemma Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [virtual]</code><li><b>ThMLLemma</b>() (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~ThMLLemma</b>() (defined in <a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_lemma.gif b/doc/api-documentation/html/class_th_m_l_lemma.gif Binary files differnew file mode 100644 index 0000000..2fc4121 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_lemma.gif diff --git a/doc/api-documentation/html/class_th_m_l_lemma.html b/doc/api-documentation/html/class_th_m_l_lemma.html new file mode 100644 index 0000000..abd5d44 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_lemma.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLLemma class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLLemma Class Reference</h1>This Filter shows/hides lemmas in a ThML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmllemma_8h-source.html">thmllemma.h</a>></code> +<p> +<a href="class_th_m_l_lemma-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLLemma::ThMLLemma"></a> + </td><td valign=bottom><b>ThMLLemma</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ThMLLemma::~ThMLLemma"></a> +virtual </td><td valign=bottom><b>~ThMLLemma</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="ThMLLemma::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="ThMLLemma::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="ThMLLemma::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="ThMLLemma::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="ThMLLemma::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="ThMLLemma::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="ThMLLemma::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="ThMLLemma::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="ThMLLemma::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="ThMLLemma::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="ThMLLemma::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="ThMLLemma::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides lemmas in a ThML text. +<p> + +<p> +Definition at line <a class="el" href="thmllemma_8h-source.html#l00030">30</a> of file <a class="el" href="thmllemma_8h-source.html">thmllemma.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmllemma_8h-source.html">thmllemma.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_morph-members.html b/doc/api-documentation/html/class_th_m_l_morph-members.html new file mode 100644 index 0000000..2ac768c --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_morph-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLMorph Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [virtual]</code><li><b>ThMLMorph</b>() (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~ThMLMorph</b>() (defined in <a class="el" href="class_th_m_l_morph.html">ThMLMorph</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_morph.gif b/doc/api-documentation/html/class_th_m_l_morph.gif Binary files differnew file mode 100644 index 0000000..9704919 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_morph.gif diff --git a/doc/api-documentation/html/class_th_m_l_morph.html b/doc/api-documentation/html/class_th_m_l_morph.html new file mode 100644 index 0000000..6e3c7e3 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_morph.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLMorph class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLMorph Class Reference</h1>This Filter shows/hides morph tags in a ThML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlmorph_8h-source.html">thmlmorph.h</a>></code> +<p> +<a href="class_th_m_l_morph-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLMorph::ThMLMorph"></a> + </td><td valign=bottom><b>ThMLMorph</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ThMLMorph::~ThMLMorph"></a> +virtual </td><td valign=bottom><b>~ThMLMorph</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="ThMLMorph::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="ThMLMorph::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="ThMLMorph::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="ThMLMorph::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="ThMLMorph::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="ThMLMorph::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="ThMLMorph::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="ThMLMorph::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="ThMLMorph::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="ThMLMorph::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="ThMLMorph::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="ThMLMorph::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides morph tags in a ThML text. +<p> + +<p> +Definition at line <a class="el" href="thmlmorph_8h-source.html#l00029">29</a> of file <a class="el" href="thmlmorph_8h-source.html">thmlmorph.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlmorph_8h-source.html">thmlmorph.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_o_l_b-members.html b/doc/api-documentation/html/class_th_m_l_o_l_b-members.html new file mode 100644 index 0000000..85950e3 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_o_l_b-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLOLB Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_o_l_b.html">ThMLOLB</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <a class="el" href="class_th_m_l_o_l_b.html">ThMLOLB</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *, const SWModule *=0) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ThMLOLB</b>() (defined in <a class="el" href="class_th_m_l_o_l_b.html">ThMLOLB</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_o_l_b.gif b/doc/api-documentation/html/class_th_m_l_o_l_b.gif Binary files differnew file mode 100644 index 0000000..1e223d5 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_o_l_b.gif diff --git a/doc/api-documentation/html/class_th_m_l_o_l_b.html b/doc/api-documentation/html/class_th_m_l_o_l_b.html new file mode 100644 index 0000000..7addf56 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_o_l_b.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLOLB class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLOLB Class Reference</h1>this filter converts ThML text to OLB text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlolb_8h-source.html">thmlolb.h</a>></code> +<p> +<a href="class_th_m_l_o_l_b-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLOLB::ThMLOLB"></a> + </td><td valign=bottom><b>ThMLOLB</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ThMLOLB::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen=-1)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to OLB text. +<p> + +<p> +Definition at line <a class="el" href="thmlolb_8h-source.html#l00030">30</a> of file <a class="el" href="thmlolb_8h-source.html">thmlolb.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlolb_8h-source.html">thmlolb.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_plain-members.html b/doc/api-documentation/html/class_th_m_l_plain-members.html new file mode 100644 index 0000000..2774b93 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_plain-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLPlain Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_plain.html">ThMLPlain</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <a class="el" href="class_th_m_l_plain.html">ThMLPlain</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *, const SWModule *=0) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ThMLPlain</b>() (defined in <a class="el" href="class_th_m_l_plain.html">ThMLPlain</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_plain.gif b/doc/api-documentation/html/class_th_m_l_plain.gif Binary files differnew file mode 100644 index 0000000..00d6ae3 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_plain.gif diff --git a/doc/api-documentation/html/class_th_m_l_plain.html b/doc/api-documentation/html/class_th_m_l_plain.html new file mode 100644 index 0000000..fa02eb9 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_plain.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLPlain class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLPlain Class Reference</h1>this filter converts ThML text to plain text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlplain_8h-source.html">thmlplain.h</a>></code> +<p> +<a href="class_th_m_l_plain-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLPlain::ThMLPlain"></a> + </td><td valign=bottom><b>ThMLPlain</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ThMLPlain::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen=-1)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to plain text. +<p> + +<p> +Definition at line <a class="el" href="thmlplain_8h-source.html#l00030">30</a> of file <a class="el" href="thmlplain_8h-source.html">thmlplain.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlplain_8h-source.html">thmlplain.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_r_t_f-members.html b/doc/api-documentation/html/class_th_m_l_r_t_f-members.html new file mode 100644 index 0000000..4be1705 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_r_t_f-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLRTF Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_r_t_f.html">ThMLRTF</a>, including all inherited members.<ul> +<li><b>addEscapeStringSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>addTokenSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>DualStringMap</b> typedef (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>escSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>handleEscapeString</b>(char **buf, const char *escString, DualStringMap &userData) (defined in <b>SWBasicFilter</b>)<code> [protected, virtual]</code><li><b>handleToken</b>(char **buf, const char *token, DualStringMap &userData) (defined in <a class="el" href="class_th_m_l_r_t_f.html">ThMLRTF</a>)<code> [protected, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *, const SWModule *=0) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>pushString</b>(char **buf, const char *format,...) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeEnd</b>(const char *escEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStart</b>(const char *escStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStringCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setPassThruUnknownEscapeString</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setPassThruUnknownToken</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenEnd</b>(const char *tokenEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenStart</b>(const char *tokenStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteEscapeString</b>(char **buf, const char *escString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteToken</b>(char **buf, const char *token) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<li><b>ThMLRTF</b>() (defined in <a class="el" href="class_th_m_l_r_t_f.html">ThMLRTF</a>)<li><b>tokenSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>~SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_r_t_f.gif b/doc/api-documentation/html/class_th_m_l_r_t_f.gif Binary files differnew file mode 100644 index 0000000..d575937 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_r_t_f.gif diff --git a/doc/api-documentation/html/class_th_m_l_r_t_f.html b/doc/api-documentation/html/class_th_m_l_r_t_f.html new file mode 100644 index 0000000..55ca89b --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_r_t_f.html @@ -0,0 +1,35 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLRTF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLRTF Class Reference</h1>this filter converts ThML text to RTF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlrtf_8h-source.html">thmlrtf.h</a>></code> +<p> +<a href="class_th_m_l_r_t_f-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLRTF::ThMLRTF"></a> + </td><td valign=bottom><b>ThMLRTF</b> ()</td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="ThMLRTF::handleToken"></a> +virtual bool </td><td valign=bottom><b>handleToken</b> (char **buf, const char *token, DualStringMap &userData)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to RTF text. +<p> + +<p> +Definition at line <a class="el" href="thmlrtf_8h-source.html#l00030">30</a> of file <a class="el" href="thmlrtf_8h-source.html">thmlrtf.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlrtf_8h-source.html">thmlrtf.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_scripref-members.html b/doc/api-documentation/html/class_th_m_l_scripref-members.html new file mode 100644 index 0000000..b1e509f --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_scripref-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLScripref Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [virtual]</code><li><b>ThMLScripref</b>() (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~ThMLScripref</b>() (defined in <a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_scripref.gif b/doc/api-documentation/html/class_th_m_l_scripref.gif Binary files differnew file mode 100644 index 0000000..f43b785 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_scripref.gif diff --git a/doc/api-documentation/html/class_th_m_l_scripref.html b/doc/api-documentation/html/class_th_m_l_scripref.html new file mode 100644 index 0000000..b7b1680 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_scripref.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLScripref class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLScripref Class Reference</h1>This Filter shows/hides scripture references in a ThML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlscripref_8h-source.html">thmlscripref.h</a>></code> +<p> +<a href="class_th_m_l_scripref-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLScripref::ThMLScripref"></a> + </td><td valign=bottom><b>ThMLScripref</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ThMLScripref::~ThMLScripref"></a> +virtual </td><td valign=bottom><b>~ThMLScripref</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="ThMLScripref::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="ThMLScripref::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="ThMLScripref::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="ThMLScripref::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="ThMLScripref::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="ThMLScripref::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="ThMLScripref::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="ThMLScripref::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="ThMLScripref::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="ThMLScripref::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="ThMLScripref::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="ThMLScripref::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides scripture references in a ThML text. +<p> + +<p> +Definition at line <a class="el" href="thmlscripref_8h-source.html#l00030">30</a> of file <a class="el" href="thmlscripref_8h-source.html">thmlscripref.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlscripref_8h-source.html">thmlscripref.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_strongs-members.html b/doc/api-documentation/html/class_th_m_l_strongs-members.html new file mode 100644 index 0000000..90f9807 --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_strongs-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLStrongs Member List</h1>This is the complete list of members for <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [virtual]</code><li><b>ThMLStrongs</b>() (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~ThMLStrongs</b>() (defined in <a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_th_m_l_strongs.gif b/doc/api-documentation/html/class_th_m_l_strongs.gif Binary files differnew file mode 100644 index 0000000..eacf91a --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_strongs.gif diff --git a/doc/api-documentation/html/class_th_m_l_strongs.html b/doc/api-documentation/html/class_th_m_l_strongs.html new file mode 100644 index 0000000..5c5d90c --- /dev/null +++ b/doc/api-documentation/html/class_th_m_l_strongs.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLStrongs class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLStrongs Class Reference</h1>This Filter shows/hides strong's numbers in a ThML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlstrongs_8h-source.html">thmlstrongs.h</a>></code> +<p> +<a href="class_th_m_l_strongs-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLStrongs::ThMLStrongs"></a> + </td><td valign=bottom><b>ThMLStrongs</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="ThMLStrongs::~ThMLStrongs"></a> +virtual </td><td valign=bottom><b>~ThMLStrongs</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="ThMLStrongs::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="ThMLStrongs::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="ThMLStrongs::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="ThMLStrongs::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="ThMLStrongs::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="ThMLStrongs::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="ThMLStrongs::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="ThMLStrongs::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="ThMLStrongs::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="ThMLStrongs::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="ThMLStrongs::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="ThMLStrongs::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides strong's numbers in a ThML text. +<p> + +<p> +Definition at line <a class="el" href="thmlstrongs_8h-source.html#l00030">30</a> of file <a class="el" href="thmlstrongs_8h-source.html">thmlstrongs.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlstrongs_8h-source.html">thmlstrongs.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlgbf-members.html b/doc/api-documentation/html/class_thmlgbf-members.html new file mode 100644 index 0000000..04e3136 --- /dev/null +++ b/doc/api-documentation/html/class_thmlgbf-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLGBF Member List</h1>This is the complete list of members for <a class="el" href="class_thmlgbf.html">ThMLGBF</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_thmlgbf.html#a1">ProcessText</a>(char *text, int maxlen=-1) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a6">SWFilter::ProcessText</a>(char *text, int maxlen, const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>ThMLGBF</b>() (defined in <a class="el" href="class_thmlgbf.html">ThMLGBF</a>)<li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlgbf.gif b/doc/api-documentation/html/class_thmlgbf.gif Binary files differnew file mode 100644 index 0000000..0a3fba0 --- /dev/null +++ b/doc/api-documentation/html/class_thmlgbf.gif diff --git a/doc/api-documentation/html/class_thmlgbf.html b/doc/api-documentation/html/class_thmlgbf.html new file mode 100644 index 0000000..b2e911a --- /dev/null +++ b/doc/api-documentation/html/class_thmlgbf.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLGBF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLGBF Class Reference</h1>this filter converts ThML text to GBF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlgbf_h-source.html">thmlgbf.h</a>></code> +<p> +<p>Inheritance diagram for ThMLGBF:: +<p><center><img src="class_thmlgbf.gif" usemap="#ThMLGBF_map" border="0"></center> +<map name="ThMLGBF_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,69,24"> +</map> +<a href="class_thmlgbf-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLGBF::ThMLGBF"></a> + </td><td valign=bottom><b>ThMLGBF</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_thmlgbf.html#a1">ProcessText</a> (char *text, int maxlen=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function without the 3rd parameter.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to GBF text. +<p> + +<p> +Definition at line <a class="el" href="thmlgbf_h-source.html#l00030">30</a> of file <a class="el" href="thmlgbf_h-source.html">thmlgbf.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="ThMLGBF::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char ThMLGBF::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em> = -1 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function without the 3rd parameter. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a7">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlgbf_h-source.html">thmlgbf.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlhtml-members.html b/doc/api-documentation/html/class_thmlhtml-members.html new file mode 100644 index 0000000..8b4c8ab --- /dev/null +++ b/doc/api-documentation/html/class_thmlhtml-members.html @@ -0,0 +1,23 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLHTML Member List</h1>This is the complete list of members for <a class="el" href="class_thmlhtml.html">ThMLHTML</a>, including all inherited members.<ul> +<li><b>addEscapeStringSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>addTokenSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>DualStringMap</b> typedef (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>escSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>handleEscapeString</b>(char **buf, const char *escString, DualStringMap &userData) (defined in <b>SWBasicFilter</b>)<code> [protected, virtual]</code><li><b>handleToken</b>(char **buf, const char *token, DualStringMap &userData) (defined in <a class="el" href="class_thmlhtml.html">ThMLHTML</a>)<code> [protected, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a6">SWFilter::ProcessText</a>(char *text, int maxlen, const SWKey *) +<code> [inline, virtual]</code><li><b>pushString</b>(char **buf, const char *fragToPush) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeEnd</b>(const char *escEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStart</b>(const char *escStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStringCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>setPassThruUnknownEscapeString</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setPassThruUnknownToken</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenEnd</b>(const char *tokenEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenStart</b>(const char *tokenStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteEscapeString</b>(char **buf, const char *escString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteToken</b>(char **buf, const char *token) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<li><b>ThMLHTML</b>() (defined in <a class="el" href="class_thmlhtml.html">ThMLHTML</a>)<li><b>tokenSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>~SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlhtml.gif b/doc/api-documentation/html/class_thmlhtml.gif Binary files differnew file mode 100644 index 0000000..4dc595a --- /dev/null +++ b/doc/api-documentation/html/class_thmlhtml.gif diff --git a/doc/api-documentation/html/class_thmlhtml.html b/doc/api-documentation/html/class_thmlhtml.html new file mode 100644 index 0000000..e6bb3ab --- /dev/null +++ b/doc/api-documentation/html/class_thmlhtml.html @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLHTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLHTML Class Reference</h1>this filter converts ThML text to HTML text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlhtml_h-source.html">thmlhtml.h</a>></code> +<p> +<a href="class_thmlhtml-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLHTML::ThMLHTML"></a> + </td><td valign=bottom><b>ThMLHTML</b> ()</td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="ThMLHTML::handleToken"></a> +virtual bool </td><td valign=bottom><b>handleToken</b> (char **buf, const char *token, DualStringMap &userData)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to HTML text. +<p> + +<p> +Definition at line <a class="el" href="thmlhtml_h-source.html#l00028">28</a> of file <a class="el" href="thmlhtml_h-source.html">thmlhtml.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlhtml_h-source.html">thmlhtml.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlhtmlhref-members.html b/doc/api-documentation/html/class_thmlhtmlhref-members.html new file mode 100644 index 0000000..d520b90 --- /dev/null +++ b/doc/api-documentation/html/class_thmlhtmlhref-members.html @@ -0,0 +1,23 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLHTMLHREF Member List</h1>This is the complete list of members for <a class="el" href="class_thmlhtmlhref.html">ThMLHTMLHREF</a>, including all inherited members.<ul> +<li><b>addEscapeStringSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>addTokenSubstitute</b>(const char *findString, const char *replaceString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>DualStringMap</b> typedef (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>escSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>handleEscapeString</b>(char **buf, const char *escString, DualStringMap &userData) (defined in <b>SWBasicFilter</b>)<code> [protected, virtual]</code><li><b>handleToken</b>(char **buf, const char *token, DualStringMap &userData) (defined in <a class="el" href="class_thmlhtmlhref.html">ThMLHTMLHREF</a>)<code> [protected, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a6">SWFilter::ProcessText</a>(char *text, int maxlen, const SWKey *) +<code> [inline, virtual]</code><li><b>pushString</b>(char **buf, const char *fragToPush) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeEnd</b>(const char *escEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStart</b>(const char *escStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setEscapeStringCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>setPassThruUnknownEscapeString</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setPassThruUnknownToken</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenCaseSensitive</b>(bool val) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenEnd</b>(const char *tokenEnd) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>setTokenStart</b>(const char *tokenStart) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteEscapeString</b>(char **buf, const char *escString) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>substituteToken</b>(char **buf, const char *token) (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<li><b>ThMLHTMLHREF</b>() (defined in <a class="el" href="class_thmlhtmlhref.html">ThMLHTMLHREF</a>)<li><b>tokenSubMap</b> (defined in <b>SWBasicFilter</b>)<code> [protected]</code><li><b>~SWBasicFilter</b>() (defined in <b>SWBasicFilter</b>)<code> [virtual]</code><li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlhtmlhref.html b/doc/api-documentation/html/class_thmlhtmlhref.html new file mode 100644 index 0000000..dff54d1 --- /dev/null +++ b/doc/api-documentation/html/class_thmlhtmlhref.html @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLHTMLHREF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLHTMLHREF Class Reference</h1>this filter converts ThML text to HTML text with hrefs. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlhtmlhref_h-source.html">thmlhtmlhref.h</a>></code> +<p> +<a href="class_thmlhtmlhref-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLHTMLHREF::ThMLHTMLHREF"></a> + </td><td valign=bottom><b>ThMLHTMLHREF</b> ()</td></tr> +<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="b0" doxytag="ThMLHTMLHREF::handleToken"></a> +virtual bool </td><td valign=bottom><b>handleToken</b> (char **buf, const char *token, DualStringMap &userData)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to HTML text with hrefs. +<p> + +<p> +Definition at line <a class="el" href="thmlhtmlhref_h-source.html#l00026">26</a> of file <a class="el" href="thmlhtmlhref_h-source.html">thmlhtmlhref.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlhtmlhref_h-source.html">thmlhtmlhref.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlolb-members.html b/doc/api-documentation/html/class_thmlolb-members.html new file mode 100644 index 0000000..f699ab9 --- /dev/null +++ b/doc/api-documentation/html/class_thmlolb-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLOLB Member List</h1>This is the complete list of members for <a class="el" href="class_thmlolb.html">ThMLOLB</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_thmlolb.html#a1">ProcessText</a>(char *text, int maxlen=-1) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a6">SWFilter::ProcessText</a>(char *text, int maxlen, const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>ThMLOLB</b>() (defined in <a class="el" href="class_thmlolb.html">ThMLOLB</a>)<li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlolb.gif b/doc/api-documentation/html/class_thmlolb.gif Binary files differnew file mode 100644 index 0000000..1e223d5 --- /dev/null +++ b/doc/api-documentation/html/class_thmlolb.gif diff --git a/doc/api-documentation/html/class_thmlolb.html b/doc/api-documentation/html/class_thmlolb.html new file mode 100644 index 0000000..fc66f22 --- /dev/null +++ b/doc/api-documentation/html/class_thmlolb.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLOLB class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLOLB Class Reference</h1>this filter converts ThML text to OLB text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlolb_h-source.html">thmlolb.h</a>></code> +<p> +<p>Inheritance diagram for ThMLOLB:: +<p><center><img src="class_thmlolb.gif" usemap="#ThMLOLB_map" border="0"></center> +<map name="ThMLOLB_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,69,24"> +</map> +<a href="class_thmlolb-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLOLB::ThMLOLB"></a> + </td><td valign=bottom><b>ThMLOLB</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_thmlolb.html#a1">ProcessText</a> (char *text, int maxlen=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function without the 3rd parameter.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to OLB text. +<p> + +<p> +Definition at line <a class="el" href="thmlolb_h-source.html#l00030">30</a> of file <a class="el" href="thmlolb_h-source.html">thmlolb.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="ThMLOLB::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char ThMLOLB::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em> = -1 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function without the 3rd parameter. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a7">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlolb_h-source.html">thmlolb.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlplain-members.html b/doc/api-documentation/html/class_thmlplain-members.html new file mode 100644 index 0000000..f5b45c1 --- /dev/null +++ b/doc/api-documentation/html/class_thmlplain-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLPlain Member List</h1>This is the complete list of members for <a class="el" href="class_thmlplain.html">ThMLPlain</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_thmlplain.html#a1">ProcessText</a>(char *text, int maxlen=-1) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a6">SWFilter::ProcessText</a>(char *text, int maxlen, const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>ThMLPlain</b>() (defined in <a class="el" href="class_thmlplain.html">ThMLPlain</a>)<li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlplain.gif b/doc/api-documentation/html/class_thmlplain.gif Binary files differnew file mode 100644 index 0000000..00d6ae3 --- /dev/null +++ b/doc/api-documentation/html/class_thmlplain.gif diff --git a/doc/api-documentation/html/class_thmlplain.html b/doc/api-documentation/html/class_thmlplain.html new file mode 100644 index 0000000..6ea16f3 --- /dev/null +++ b/doc/api-documentation/html/class_thmlplain.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLPlain class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLPlain Class Reference</h1>this filter converts ThML text to plain text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlplain_h-source.html">thmlplain.h</a>></code> +<p> +<p>Inheritance diagram for ThMLPlain:: +<p><center><img src="class_thmlplain.gif" usemap="#ThMLPlain_map" border="0"></center> +<map name="ThMLPlain_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,72,24"> +</map> +<a href="class_thmlplain-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLPlain::ThMLPlain"></a> + </td><td valign=bottom><b>ThMLPlain</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_thmlplain.html#a1">ProcessText</a> (char *text, int maxlen=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function without the 3rd parameter.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to plain text. +<p> + +<p> +Definition at line <a class="el" href="thmlplain_h-source.html#l00030">30</a> of file <a class="el" href="thmlplain_h-source.html">thmlplain.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="ThMLPlain::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char ThMLPlain::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em> = -1 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function without the 3rd parameter. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a7">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlplain_h-source.html">thmlplain.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlrtf-members.html b/doc/api-documentation/html/class_thmlrtf-members.html new file mode 100644 index 0000000..259bc54 --- /dev/null +++ b/doc/api-documentation/html/class_thmlrtf-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLRTF Member List</h1>This is the complete list of members for <a class="el" href="class_thmlrtf.html">ThMLRTF</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_thmlrtf.html#a1">ProcessText</a>(char *text, int maxlen=-1) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a6">SWFilter::ProcessText</a>(char *text, int maxlen, const SWKey *) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>ThMLRTF</b>() (defined in <a class="el" href="class_thmlrtf.html">ThMLRTF</a>)<li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_thmlrtf.gif b/doc/api-documentation/html/class_thmlrtf.gif Binary files differnew file mode 100644 index 0000000..d575937 --- /dev/null +++ b/doc/api-documentation/html/class_thmlrtf.gif diff --git a/doc/api-documentation/html/class_thmlrtf.html b/doc/api-documentation/html/class_thmlrtf.html new file mode 100644 index 0000000..c13685c --- /dev/null +++ b/doc/api-documentation/html/class_thmlrtf.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ThMLRTF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ThMLRTF Class Reference</h1>this filter converts ThML text to RTF text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="thmlrtf_h-source.html">thmlrtf.h</a>></code> +<p> +<p>Inheritance diagram for ThMLRTF:: +<p><center><img src="class_thmlrtf.gif" usemap="#ThMLRTF_map" border="0"></center> +<map name="ThMLRTF_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,67,24"> +</map> +<a href="class_thmlrtf-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="ThMLRTF::ThMLRTF"></a> + </td><td valign=bottom><b>ThMLRTF</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_thmlrtf.html#a1">ProcessText</a> (char *text, int maxlen=-1)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function without the 3rd parameter.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +this filter converts ThML text to RTF text. +<p> + +<p> +Definition at line <a class="el" href="thmlrtf_h-source.html#l00030">30</a> of file <a class="el" href="thmlrtf_h-source.html">thmlrtf.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="ThMLRTF::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char ThMLRTF::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em> = -1 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function without the 3rd parameter. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a7">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="thmlrtf_h-source.html">thmlrtf.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f16_u_t_f8-members.html b/doc/api-documentation/html/class_u_t_f16_u_t_f8-members.html new file mode 100644 index 0000000..1ccde87 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f16_u_t_f8-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF16UTF8 Member List</h1>This is the complete list of members for <a class="el" href="class_u_t_f16_u_t_f8.html">UTF16UTF8</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_u_t_f16_u_t_f8.html">UTF16UTF8</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>UTF16UTF8</b>() (defined in <a class="el" href="class_u_t_f16_u_t_f8.html">UTF16UTF8</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f16_u_t_f8.gif b/doc/api-documentation/html/class_u_t_f16_u_t_f8.gif Binary files differnew file mode 100644 index 0000000..b61d597 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f16_u_t_f8.gif diff --git a/doc/api-documentation/html/class_u_t_f16_u_t_f8.html b/doc/api-documentation/html/class_u_t_f16_u_t_f8.html new file mode 100644 index 0000000..599fc15 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f16_u_t_f8.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF16UTF8 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF16UTF8 Class Reference</h1>This filter converts UTF-16 encoded text to UTF-8. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf16utf8_8h-source.html">utf16utf8.h</a>></code> +<p> +<a href="class_u_t_f16_u_t_f8-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF16UTF8::UTF16UTF8"></a> + </td><td valign=bottom><b>UTF16UTF8</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF16UTF8::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts UTF-16 encoded text to UTF-8. +<p> + +<p> +Definition at line <a class="el" href="utf16utf8_8h-source.html#l00029">29</a> of file <a class="el" href="utf16utf8_8h-source.html">utf16utf8.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf16utf8_8h-source.html">utf16utf8.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_cantillation-members.html b/doc/api-documentation/html/class_u_t_f8_cantillation-members.html new file mode 100644 index 0000000..b5ebabd --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_cantillation-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8Cantillation Member List</h1>This is the complete list of members for <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [virtual]</code><li><b>UTF8Cantillation</b>() (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~UTF8Cantillation</b>() (defined in <a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_cantillation.gif b/doc/api-documentation/html/class_u_t_f8_cantillation.gif Binary files differnew file mode 100644 index 0000000..ab115cb --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_cantillation.gif diff --git a/doc/api-documentation/html/class_u_t_f8_cantillation.html b/doc/api-documentation/html/class_u_t_f8_cantillation.html new file mode 100644 index 0000000..aff0dba --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_cantillation.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8Cantillation class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8Cantillation Class Reference</h1>This Filter shows/hides Hebrew cantillation marks in UTF8 text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8cantillation_8h-source.html">utf8cantillation.h</a>></code> +<p> +<a href="class_u_t_f8_cantillation-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8Cantillation::UTF8Cantillation"></a> + </td><td valign=bottom><b>UTF8Cantillation</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF8Cantillation::~UTF8Cantillation"></a> +virtual </td><td valign=bottom><b>~UTF8Cantillation</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="UTF8Cantillation::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="UTF8Cantillation::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="UTF8Cantillation::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="UTF8Cantillation::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="UTF8Cantillation::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="UTF8Cantillation::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="UTF8Cantillation::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="UTF8Cantillation::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="UTF8Cantillation::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="UTF8Cantillation::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="UTF8Cantillation::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="UTF8Cantillation::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides Hebrew cantillation marks in UTF8 text. +<p> + +<p> +Definition at line <a class="el" href="utf8cantillation_8h-source.html#l00029">29</a> of file <a class="el" href="utf8cantillation_8h-source.html">utf8cantillation.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8cantillation_8h-source.html">utf8cantillation.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_greek_accents-members.html b/doc/api-documentation/html/class_u_t_f8_greek_accents-members.html new file mode 100644 index 0000000..0097ba5 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_greek_accents-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8GreekAccents Member List</h1>This is the complete list of members for <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [virtual]</code><li><b>UTF8GreekAccents</b>() (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~UTF8GreekAccents</b>() (defined in <a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_greek_accents.gif b/doc/api-documentation/html/class_u_t_f8_greek_accents.gif Binary files differnew file mode 100644 index 0000000..551db4b --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_greek_accents.gif diff --git a/doc/api-documentation/html/class_u_t_f8_greek_accents.html b/doc/api-documentation/html/class_u_t_f8_greek_accents.html new file mode 100644 index 0000000..bc450ad --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_greek_accents.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8GreekAccents class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8GreekAccents Class Reference</h1>This Filter shows/hides Greek Accents marks in UTF8 text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8greekaccents_8h-source.html">utf8greekaccents.h</a>></code> +<p> +<a href="class_u_t_f8_greek_accents-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8GreekAccents::UTF8GreekAccents"></a> + </td><td valign=bottom><b>UTF8GreekAccents</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF8GreekAccents::~UTF8GreekAccents"></a> +virtual </td><td valign=bottom><b>~UTF8GreekAccents</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="UTF8GreekAccents::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="UTF8GreekAccents::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="UTF8GreekAccents::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="UTF8GreekAccents::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="UTF8GreekAccents::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="UTF8GreekAccents::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="UTF8GreekAccents::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="UTF8GreekAccents::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="UTF8GreekAccents::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="UTF8GreekAccents::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="UTF8GreekAccents::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="UTF8GreekAccents::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides Greek Accents marks in UTF8 text. +<p> + +<p> +Definition at line <a class="el" href="utf8greekaccents_8h-source.html#l00029">29</a> of file <a class="el" href="utf8greekaccents_8h-source.html">utf8greekaccents.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8greekaccents_8h-source.html">utf8greekaccents.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_h_t_m_l-members.html b/doc/api-documentation/html/class_u_t_f8_h_t_m_l-members.html new file mode 100644 index 0000000..76e22c0 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_h_t_m_l-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8HTML Member List</h1>This is the complete list of members for <a class="el" href="class_u_t_f8_h_t_m_l.html">UTF8HTML</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_u_t_f8_h_t_m_l.html">UTF8HTML</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>UTF8HTML</b>() (defined in <a class="el" href="class_u_t_f8_h_t_m_l.html">UTF8HTML</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_h_t_m_l.gif b/doc/api-documentation/html/class_u_t_f8_h_t_m_l.gif Binary files differnew file mode 100644 index 0000000..23df580 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_h_t_m_l.gif diff --git a/doc/api-documentation/html/class_u_t_f8_h_t_m_l.html b/doc/api-documentation/html/class_u_t_f8_h_t_m_l.html new file mode 100644 index 0000000..4e2dd83 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_h_t_m_l.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8HTML class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8HTML Class Reference</h1>This filter converts UTF-8 text into HTML escape sequences. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8html_8h-source.html">utf8html.h</a>></code> +<p> +<a href="class_u_t_f8_h_t_m_l-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8HTML::UTF8HTML"></a> + </td><td valign=bottom><b>UTF8HTML</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF8HTML::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts UTF-8 text into HTML escape sequences. +<p> + +<p> +Definition at line <a class="el" href="utf8html_8h-source.html#l00029">29</a> of file <a class="el" href="utf8html_8h-source.html">utf8html.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8html_8h-source.html">utf8html.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_hebrew_points-members.html b/doc/api-documentation/html/class_u_t_f8_hebrew_points-members.html new file mode 100644 index 0000000..b1a9e96 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_hebrew_points-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8HebrewPoints Member List</h1>This is the complete list of members for <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [virtual]</code><li><b>getOptionValues</b>() (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [private, static]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *ival) (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [virtual]</code><li><b>UTF8HebrewPoints</b>() (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>~UTF8HebrewPoints</b>() (defined in <a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_hebrew_points.gif b/doc/api-documentation/html/class_u_t_f8_hebrew_points.gif Binary files differnew file mode 100644 index 0000000..3351492 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_hebrew_points.gif diff --git a/doc/api-documentation/html/class_u_t_f8_hebrew_points.html b/doc/api-documentation/html/class_u_t_f8_hebrew_points.html new file mode 100644 index 0000000..1d744b7 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_hebrew_points.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8HebrewPoints class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8HebrewPoints Class Reference</h1>This Filter shows/hides Hebrew vowel points in UTF8 text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8hebrewpoints_8h-source.html">utf8hebrewpoints.h</a>></code> +<p> +<a href="class_u_t_f8_hebrew_points-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8HebrewPoints::UTF8HebrewPoints"></a> + </td><td valign=bottom><b>UTF8HebrewPoints</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF8HebrewPoints::~UTF8HebrewPoints"></a> +virtual </td><td valign=bottom><b>~UTF8HebrewPoints</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a2" doxytag="UTF8HebrewPoints::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a3" doxytag="UTF8HebrewPoints::getOptionName"></a> +virtual const char * </td><td valign=bottom><b>getOptionName</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="UTF8HebrewPoints::getOptionTip"></a> +virtual const char * </td><td valign=bottom><b>getOptionTip</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a5" doxytag="UTF8HebrewPoints::setOptionValue"></a> +virtual void </td><td valign=bottom><b>setOptionValue</b> (const char *ival)</td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="UTF8HebrewPoints::getOptionValue"></a> +virtual const char * </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a7" doxytag="UTF8HebrewPoints::getOptionValues"></a> +virtual OptionsList </td><td valign=bottom><b>getOptionValues</b> ()</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="UTF8HebrewPoints::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="UTF8HebrewPoints::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="UTF8HebrewPoints::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="UTF8HebrewPoints::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="UTF8HebrewPoints::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="UTF8HebrewPoints::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides Hebrew vowel points in UTF8 text. +<p> + +<p> +Definition at line <a class="el" href="utf8hebrewpoints_8h-source.html#l00029">29</a> of file <a class="el" href="utf8hebrewpoints_8h-source.html">utf8hebrewpoints.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8hebrewpoints_8h-source.html">utf8hebrewpoints.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_latin1-members.html b/doc/api-documentation/html/class_u_t_f8_latin1-members.html new file mode 100644 index 0000000..dd8fc08 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_latin1-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8Latin1 Member List</h1>This is the complete list of members for <a class="el" href="class_u_t_f8_latin1.html">UTF8Latin1</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_u_t_f8_latin1.html">UTF8Latin1</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>replacementChar</b> (defined in <a class="el" href="class_u_t_f8_latin1.html">UTF8Latin1</a>)<code> [private]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>UTF8Latin1</b>(char rchar='?') (defined in <a class="el" href="class_u_t_f8_latin1.html">UTF8Latin1</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_latin1.gif b/doc/api-documentation/html/class_u_t_f8_latin1.gif Binary files differnew file mode 100644 index 0000000..50f5fa9 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_latin1.gif diff --git a/doc/api-documentation/html/class_u_t_f8_latin1.html b/doc/api-documentation/html/class_u_t_f8_latin1.html new file mode 100644 index 0000000..cc611c7 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_latin1.html @@ -0,0 +1,37 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8Latin1 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8Latin1 Class Reference</h1>This filter converts UTF-8 encoded text to Latin-1. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8latin1_8h-source.html">utf8latin1.h</a>></code> +<p> +<a href="class_u_t_f8_latin1-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8Latin1::UTF8Latin1"></a> + </td><td valign=bottom><b>UTF8Latin1</b> (char rchar='?')</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF8Latin1::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="UTF8Latin1::replacementChar"></a> +char </td><td valign=bottom><b>replacementChar</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts UTF-8 encoded text to Latin-1. +<p> + +<p> +Definition at line <a class="el" href="utf8latin1_8h-source.html#l00029">29</a> of file <a class="el" href="utf8latin1_8h-source.html">utf8latin1.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8latin1_8h-source.html">utf8latin1.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_u_t_f16-members.html b/doc/api-documentation/html/class_u_t_f8_u_t_f16-members.html new file mode 100644 index 0000000..eac8cfa --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_u_t_f16-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8UTF16 Member List</h1>This is the complete list of members for <a class="el" href="class_u_t_f8_u_t_f16.html">UTF8UTF16</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_u_t_f8_u_t_f16.html">UTF8UTF16</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>UTF8UTF16</b>() (defined in <a class="el" href="class_u_t_f8_u_t_f16.html">UTF8UTF16</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_u_t_f8_u_t_f16.gif b/doc/api-documentation/html/class_u_t_f8_u_t_f16.gif Binary files differnew file mode 100644 index 0000000..b76f597 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_u_t_f16.gif diff --git a/doc/api-documentation/html/class_u_t_f8_u_t_f16.html b/doc/api-documentation/html/class_u_t_f8_u_t_f16.html new file mode 100644 index 0000000..be609e8 --- /dev/null +++ b/doc/api-documentation/html/class_u_t_f8_u_t_f16.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8UTF16 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8UTF16 Class Reference</h1>This filter converts UTF-8 encoded text to UTF-16. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8utf16_8h-source.html">utf8utf16.h</a>></code> +<p> +<a href="class_u_t_f8_u_t_f16-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8UTF16::UTF8UTF16"></a> + </td><td valign=bottom><b>UTF8UTF16</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF8UTF16::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts UTF-8 encoded text to UTF-16. +<p> + +<p> +Definition at line <a class="el" href="utf8utf16_8h-source.html#l00029">29</a> of file <a class="el" href="utf8utf16_8h-source.html">utf8utf16.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8utf16_8h-source.html">utf8utf16.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_unicode_r_t_f-members.html b/doc/api-documentation/html/class_unicode_r_t_f-members.html new file mode 100644 index 0000000..a4150c9 --- /dev/null +++ b/doc/api-documentation/html/class_unicode_r_t_f-members.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UnicodeRTF Member List</h1>This is the complete list of members for <a class="el" href="class_unicode_r_t_f.html">UnicodeRTF</a>, including all inherited members.<ul> +<li><b>getOptionName</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionTip</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>getOptionValues</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>ProcessText</b>(char *text, int maxlen, const SWKey *key, const SWModule *=0) (defined in <a class="el" href="class_unicode_r_t_f.html">UnicodeRTF</a>)<code> [virtual]</code><li><b>ProcessText</b>(char *text, int maxlen=-1) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>setOptionValue</b>(const char *) (defined in <b>SWFilter</b>)<code> [inline, virtual]</code><li><b>UnicodeRTF</b>() (defined in <a class="el" href="class_unicode_r_t_f.html">UnicodeRTF</a>)<li><b>~SWFilter</b>() (defined in <b>SWFilter</b>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_unicode_r_t_f.gif b/doc/api-documentation/html/class_unicode_r_t_f.gif Binary files differnew file mode 100644 index 0000000..d7a335f --- /dev/null +++ b/doc/api-documentation/html/class_unicode_r_t_f.gif diff --git a/doc/api-documentation/html/class_unicode_r_t_f.html b/doc/api-documentation/html/class_unicode_r_t_f.html new file mode 100644 index 0000000..b89fda6 --- /dev/null +++ b/doc/api-documentation/html/class_unicode_r_t_f.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UnicodeRTF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UnicodeRTF Class Reference</h1>This filter converts UTF-8 text into RTF Unicode tags. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="unicodertf_8h-source.html">unicodertf.h</a>></code> +<p> +<a href="class_unicode_r_t_f-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UnicodeRTF::UnicodeRTF"></a> + </td><td valign=bottom><b>UnicodeRTF</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UnicodeRTF::ProcessText"></a> +virtual char </td><td valign=bottom><b>ProcessText</b> (char *text, int maxlen, const <a class="el" href="class_s_w_key.html">SWKey</a> *key, const <a class="el" href="class_s_w_module.html">SWModule</a> *=0)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts UTF-8 text into RTF Unicode tags. +<p> + +<p> +Definition at line <a class="el" href="unicodertf_8h-source.html#l00030">30</a> of file <a class="el" href="unicodertf_8h-source.html">unicodertf.h</a>.<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="unicodertf_8h-source.html">unicodertf.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_unicodertf-members.html b/doc/api-documentation/html/class_unicodertf-members.html new file mode 100644 index 0000000..36ed285 --- /dev/null +++ b/doc/api-documentation/html/class_unicodertf-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UnicodeRTF Member List</h1>This is the complete list of members for <a class="el" href="class_unicodertf.html">UnicodeRTF</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_unicodertf.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>UnicodeRTF</b>() (defined in <a class="el" href="class_unicodertf.html">UnicodeRTF</a>)<li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_unicodertf.gif b/doc/api-documentation/html/class_unicodertf.gif Binary files differnew file mode 100644 index 0000000..d7a335f --- /dev/null +++ b/doc/api-documentation/html/class_unicodertf.gif diff --git a/doc/api-documentation/html/class_unicodertf.html b/doc/api-documentation/html/class_unicodertf.html new file mode 100644 index 0000000..310c51e --- /dev/null +++ b/doc/api-documentation/html/class_unicodertf.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UnicodeRTF class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UnicodeRTF Class Reference</h1>This filter converts UTF-8 text into RTF Unicode tags. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="unicodertf_h-source.html">unicodertf.h</a>></code> +<p> +<p>Inheritance diagram for UnicodeRTF:: +<p><center><img src="class_unicodertf.gif" usemap="#UnicodeRTF_map" border="0"></center> +<map name="UnicodeRTF_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,81,24"> +</map> +<a href="class_unicodertf-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UnicodeRTF::UnicodeRTF"></a> + </td><td valign=bottom><b>UnicodeRTF</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_unicodertf.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts UTF-8 text into RTF Unicode tags. +<p> + +<p> +Definition at line <a class="el" href="unicodertf_h-source.html#l00030">30</a> of file <a class="el" href="unicodertf_h-source.html">unicodertf.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="UnicodeRTF::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char UnicodeRTF::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="unicodertf_h-source.html">unicodertf.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_utf16utf8-members.html b/doc/api-documentation/html/class_utf16utf8-members.html new file mode 100644 index 0000000..4d8c89b --- /dev/null +++ b/doc/api-documentation/html/class_utf16utf8-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF16UTF8 Member List</h1>This is the complete list of members for <a class="el" href="class_utf16utf8.html">UTF16UTF8</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_utf16utf8.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>UTF16UTF8</b>() (defined in <a class="el" href="class_utf16utf8.html">UTF16UTF8</a>)<li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_utf16utf8.gif b/doc/api-documentation/html/class_utf16utf8.gif Binary files differnew file mode 100644 index 0000000..b61d597 --- /dev/null +++ b/doc/api-documentation/html/class_utf16utf8.gif diff --git a/doc/api-documentation/html/class_utf16utf8.html b/doc/api-documentation/html/class_utf16utf8.html new file mode 100644 index 0000000..195d263 --- /dev/null +++ b/doc/api-documentation/html/class_utf16utf8.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF16UTF8 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF16UTF8 Class Reference</h1>This filter converts UTF-16 encoded text to UTF-8. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf16utf8_h-source.html">utf16utf8.h</a>></code> +<p> +<p>Inheritance diagram for UTF16UTF8:: +<p><center><img src="class_utf16utf8.gif" usemap="#UTF16UTF8_map" border="0"></center> +<map name="UTF16UTF8_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,79,24"> +</map> +<a href="class_utf16utf8-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF16UTF8::UTF16UTF8"></a> + </td><td valign=bottom><b>UTF16UTF8</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_utf16utf8.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts UTF-16 encoded text to UTF-8. +<p> + +<p> +Definition at line <a class="el" href="utf16utf8_h-source.html#l00029">29</a> of file <a class="el" href="utf16utf8_h-source.html">utf16utf8.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="UTF16UTF8::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char UTF16UTF8::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf16utf8_h-source.html">utf16utf8.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_utf8cantillation-members.html b/doc/api-documentation/html/class_utf8cantillation-members.html new file mode 100644 index 0000000..8fe1b37 --- /dev/null +++ b/doc/api-documentation/html/class_utf8cantillation-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8Cantillation Member List</h1>This is the complete list of members for <a class="el" href="class_utf8cantillation.html">UTF8Cantillation</a>, including all inherited members.<ul> +<li><a class="el" href="class_utf8cantillation.html#a3">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_utf8cantillation.html#a4">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_utf8cantillation.html">UTF8Cantillation</a>)<code> [virtual]</code><li><a class="el" href="class_utf8cantillation.html#a7">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_utf8cantillation.html">UTF8Cantillation</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_utf8cantillation.html">UTF8Cantillation</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_utf8cantillation.html">UTF8Cantillation</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_utf8cantillation.html">UTF8Cantillation</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_utf8cantillation.html">UTF8Cantillation</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_utf8cantillation.html">UTF8Cantillation</a>)<code> [private, static]</code><li><a class="el" href="class_utf8cantillation.html#a2">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_utf8cantillation.html#a5">setOptionValue</a>(const char *ival) +<code> [virtual]</code><li><b>UTF8Cantillation</b>() (defined in <a class="el" href="class_utf8cantillation.html">UTF8Cantillation</a>)<li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><b>~UTF8Cantillation</b>() (defined in <a class="el" href="class_utf8cantillation.html">UTF8Cantillation</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_utf8cantillation.gif b/doc/api-documentation/html/class_utf8cantillation.gif Binary files differnew file mode 100644 index 0000000..ab115cb --- /dev/null +++ b/doc/api-documentation/html/class_utf8cantillation.gif diff --git a/doc/api-documentation/html/class_utf8cantillation.html b/doc/api-documentation/html/class_utf8cantillation.html new file mode 100644 index 0000000..229facb --- /dev/null +++ b/doc/api-documentation/html/class_utf8cantillation.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8Cantillation class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8Cantillation Class Reference</h1>This Filter shows/hides Hebrew cantillation marks in UTF8 text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8cantillation_h-source.html">utf8cantillation.h</a>></code> +<p> +<p>Inheritance diagram for UTF8Cantillation:: +<p><center><img src="class_utf8cantillation.gif" usemap="#UTF8Cantillation_map" border="0"></center> +<map name="UTF8Cantillation_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,104,24"> +</map> +<a href="class_utf8cantillation-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8Cantillation::UTF8Cantillation"></a> + </td><td valign=bottom><b>UTF8Cantillation</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF8Cantillation::~UTF8Cantillation"></a> +virtual </td><td valign=bottom><b>~UTF8Cantillation</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_utf8cantillation.html#a2">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_utf8cantillation.html#a3">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_utf8cantillation.html#a4">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_utf8cantillation.html#a5">setOptionValue</a> (const char *ival)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_utf8cantillation.html#a7">getOptionValues</a>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="UTF8Cantillation::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_utf8cantillation.html#a7">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="UTF8Cantillation::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="UTF8Cantillation::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="UTF8Cantillation::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="UTF8Cantillation::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="UTF8Cantillation::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="UTF8Cantillation::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides Hebrew cantillation marks in UTF8 text. +<p> + +<p> +Definition at line <a class="el" href="utf8cantillation_h-source.html#l00029">29</a> of file <a class="el" href="utf8cantillation_h-source.html">utf8cantillation.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="UTF8Cantillation::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char UTF8Cantillation::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<a name="a3" doxytag="UTF8Cantillation::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * UTF8Cantillation::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a1">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8cantillation_h-source.html#l00041">41</a> of file <a class="el" href="utf8cantillation_h-source.html">utf8cantillation.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="UTF8Cantillation::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * UTF8Cantillation::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a2">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8cantillation_h-source.html#l00045">45</a> of file <a class="el" href="utf8cantillation_h-source.html">utf8cantillation.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="UTF8Cantillation::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList UTF8Cantillation::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a3">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8cantillation_h-source.html#l00051">51</a> of file <a class="el" href="utf8cantillation_h-source.html">utf8cantillation.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="UTF8Cantillation::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual void UTF8Cantillation::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_utf8cantillation.html#a7">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a4">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8cantillation_h-source.html">utf8cantillation.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_utf8greekaccents-members.html b/doc/api-documentation/html/class_utf8greekaccents-members.html new file mode 100644 index 0000000..e64e737 --- /dev/null +++ b/doc/api-documentation/html/class_utf8greekaccents-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8GreekAccents Member List</h1>This is the complete list of members for <a class="el" href="class_utf8greekaccents.html">UTF8GreekAccents</a>, including all inherited members.<ul> +<li><a class="el" href="class_utf8greekaccents.html#a3">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_utf8greekaccents.html#a4">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_utf8greekaccents.html">UTF8GreekAccents</a>)<code> [virtual]</code><li><a class="el" href="class_utf8greekaccents.html#a7">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_utf8greekaccents.html">UTF8GreekAccents</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_utf8greekaccents.html">UTF8GreekAccents</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_utf8greekaccents.html">UTF8GreekAccents</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_utf8greekaccents.html">UTF8GreekAccents</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_utf8greekaccents.html">UTF8GreekAccents</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_utf8greekaccents.html">UTF8GreekAccents</a>)<code> [private, static]</code><li><a class="el" href="class_utf8greekaccents.html#a2">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_utf8greekaccents.html#a5">setOptionValue</a>(const char *ival) +<code> [virtual]</code><li><b>UTF8GreekAccents</b>() (defined in <a class="el" href="class_utf8greekaccents.html">UTF8GreekAccents</a>)<li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><b>~UTF8GreekAccents</b>() (defined in <a class="el" href="class_utf8greekaccents.html">UTF8GreekAccents</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_utf8greekaccents.gif b/doc/api-documentation/html/class_utf8greekaccents.gif Binary files differnew file mode 100644 index 0000000..551db4b --- /dev/null +++ b/doc/api-documentation/html/class_utf8greekaccents.gif diff --git a/doc/api-documentation/html/class_utf8greekaccents.html b/doc/api-documentation/html/class_utf8greekaccents.html new file mode 100644 index 0000000..cfd764b --- /dev/null +++ b/doc/api-documentation/html/class_utf8greekaccents.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8GreekAccents class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8GreekAccents Class Reference</h1>This Filter shows/hides Greek Accents marks in UTF8 text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8greekaccents_h-source.html">utf8greekaccents.h</a>></code> +<p> +<p>Inheritance diagram for UTF8GreekAccents:: +<p><center><img src="class_utf8greekaccents.gif" usemap="#UTF8GreekAccents_map" border="0"></center> +<map name="UTF8GreekAccents_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,122,24"> +</map> +<a href="class_utf8greekaccents-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8GreekAccents::UTF8GreekAccents"></a> + </td><td valign=bottom><b>UTF8GreekAccents</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF8GreekAccents::~UTF8GreekAccents"></a> +virtual </td><td valign=bottom><b>~UTF8GreekAccents</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_utf8greekaccents.html#a2">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_utf8greekaccents.html#a3">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_utf8greekaccents.html#a4">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_utf8greekaccents.html#a5">setOptionValue</a> (const char *ival)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_utf8greekaccents.html#a7">getOptionValues</a>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="UTF8GreekAccents::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_utf8greekaccents.html#a7">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="UTF8GreekAccents::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="UTF8GreekAccents::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="UTF8GreekAccents::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="UTF8GreekAccents::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="UTF8GreekAccents::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="UTF8GreekAccents::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides Greek Accents marks in UTF8 text. +<p> + +<p> +Definition at line <a class="el" href="utf8greekaccents_h-source.html#l00029">29</a> of file <a class="el" href="utf8greekaccents_h-source.html">utf8greekaccents.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="UTF8GreekAccents::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char UTF8GreekAccents::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<a name="a3" doxytag="UTF8GreekAccents::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * UTF8GreekAccents::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a1">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8greekaccents_h-source.html#l00041">41</a> of file <a class="el" href="utf8greekaccents_h-source.html">utf8greekaccents.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="UTF8GreekAccents::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * UTF8GreekAccents::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a2">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8greekaccents_h-source.html#l00045">45</a> of file <a class="el" href="utf8greekaccents_h-source.html">utf8greekaccents.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="UTF8GreekAccents::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList UTF8GreekAccents::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a3">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8greekaccents_h-source.html#l00051">51</a> of file <a class="el" href="utf8greekaccents_h-source.html">utf8greekaccents.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="UTF8GreekAccents::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual void UTF8GreekAccents::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_utf8greekaccents.html#a7">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a4">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8greekaccents_h-source.html">utf8greekaccents.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_utf8hebrewpoints-members.html b/doc/api-documentation/html/class_utf8hebrewpoints-members.html new file mode 100644 index 0000000..ff3e409 --- /dev/null +++ b/doc/api-documentation/html/class_utf8hebrewpoints-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8HebrewPoints Member List</h1>This is the complete list of members for <a class="el" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>, including all inherited members.<ul> +<li><a class="el" href="class_utf8hebrewpoints.html#a3">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_utf8hebrewpoints.html#a4">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>)<code> [virtual]</code><li><a class="el" href="class_utf8hebrewpoints.html#a7">getOptionValues</a>() +<code> [inline, virtual]</code><li><b>off</b> (defined in <a class="el" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>)<code> [private, static]</code><li><b>on</b> (defined in <a class="el" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>)<code> [private, static]</code><li><b>option</b> (defined in <a class="el" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>)<code> [private]</code><li><b>options</b> (defined in <a class="el" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>)<code> [private]</code><li><b>optName</b> (defined in <a class="el" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>)<code> [private, static]</code><li><b>optTip</b> (defined in <a class="el" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>)<code> [private, static]</code><li><a class="el" href="class_utf8hebrewpoints.html#a2">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_utf8hebrewpoints.html#a5">setOptionValue</a>(const char *ival) +<code> [virtual]</code><li><b>UTF8HebrewPoints</b>() (defined in <a class="el" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>)<li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><b>~UTF8HebrewPoints</b>() (defined in <a class="el" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>)<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_utf8hebrewpoints.gif b/doc/api-documentation/html/class_utf8hebrewpoints.gif Binary files differnew file mode 100644 index 0000000..3351492 --- /dev/null +++ b/doc/api-documentation/html/class_utf8hebrewpoints.gif diff --git a/doc/api-documentation/html/class_utf8hebrewpoints.html b/doc/api-documentation/html/class_utf8hebrewpoints.html new file mode 100644 index 0000000..9f948a7 --- /dev/null +++ b/doc/api-documentation/html/class_utf8hebrewpoints.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8HebrewPoints class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8HebrewPoints Class Reference</h1>This Filter shows/hides Hebrew vowel points in UTF8 text. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a>></code> +<p> +<p>Inheritance diagram for UTF8HebrewPoints:: +<p><center><img src="class_utf8hebrewpoints.gif" usemap="#UTF8HebrewPoints_map" border="0"></center> +<map name="UTF8HebrewPoints_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,120,24"> +</map> +<a href="class_utf8hebrewpoints-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8HebrewPoints::UTF8HebrewPoints"></a> + </td><td valign=bottom><b>UTF8HebrewPoints</b> ()</td></tr> +<tr><td nowrap align=right valign=top><a name="a1" doxytag="UTF8HebrewPoints::~UTF8HebrewPoints"></a> +virtual </td><td valign=bottom><b>~UTF8HebrewPoints</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_utf8hebrewpoints.html#a2">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_utf8hebrewpoints.html#a3">getOptionName</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets the name of the option of this filter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_utf8hebrewpoints.html#a4">getOptionTip</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_utf8hebrewpoints.html#a5">setOptionValue</a> (const char *ival)</td></tr> +<tr><td> </td><td><font size=-1><em>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 <a class="el" href="class_utf8hebrewpoints.html#a7">getOptionValues</a>.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="UTF8HebrewPoints::getOptionValue"></a> +virtual const char* </td><td valign=bottom><b>getOptionValue</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_utf8hebrewpoints.html#a7">getOptionValues</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns a list of the possible option values might be.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="UTF8HebrewPoints::option"></a> +bool </td><td valign=bottom><b>option</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="UTF8HebrewPoints::options"></a> +OptionsList </td><td valign=bottom><b>options</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="UTF8HebrewPoints::on"></a> +const char </td><td valign=bottom><b>on</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="UTF8HebrewPoints::off"></a> +const char </td><td valign=bottom><b>off</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="UTF8HebrewPoints::optName"></a> +const char </td><td valign=bottom><b>optName</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="UTF8HebrewPoints::optTip"></a> +const char </td><td valign=bottom><b>optTip</b> []</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This Filter shows/hides Hebrew vowel points in UTF8 text. +<p> + +<p> +Definition at line <a class="el" href="utf8hebrewpoints_h-source.html#l00029">29</a> of file <a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a2" doxytag="UTF8HebrewPoints::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char UTF8HebrewPoints::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<a name="a3" doxytag="UTF8HebrewPoints::getOptionName"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * UTF8HebrewPoints::getOptionName ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the name of the option of this filter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option name </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a1">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8hebrewpoints_h-source.html#l00041">41</a> of file <a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a>. </td> + </tr> +</table> +<a name="a4" doxytag="UTF8HebrewPoints::getOptionTip"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +const char * UTF8HebrewPoints::getOptionTip ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets a short explanation of the option of this filter; it could be presented to the user in frontend programs. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +option tip/explanation </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a2">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8hebrewpoints_h-source.html#l00045">45</a> of file <a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a>. </td> + </tr> +</table> +<a name="a7" doxytag="UTF8HebrewPoints::getOptionValues"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +OptionsList UTF8HebrewPoints::getOptionValues ( + </b></td> + <td valign="bottom"><b> +)<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +returns a list of the possible option values might be. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +list of option values </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a3">SWFilter</a>. +<p> +Definition at line <a class="el" href="utf8hebrewpoints_h-source.html#l00051">51</a> of file <a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a>. </td> + </tr> +</table> +<a name="a5" doxytag="UTF8HebrewPoints::setOptionValue"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual void UTF8HebrewPoints::setOptionValue ( + </b></td> + <td valign="bottom"><b> +const char * <em>ival</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +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 <a class="el" href="class_utf8hebrewpoints.html#a7">getOptionValues</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ival</em> + </td><td> +the new option valus </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a4">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8hebrewpoints_h-source.html">utf8hebrewpoints.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_utf8utf16-members.html b/doc/api-documentation/html/class_utf8utf16-members.html new file mode 100644 index 0000000..b102ef5 --- /dev/null +++ b/doc/api-documentation/html/class_utf8utf16-members.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8UTF16 Member List</h1>This is the complete list of members for <a class="el" href="class_utf8utf16.html">UTF8UTF16</a>, including all inherited members.<ul> +<li><a class="el" href="class_swfilter.html#a1">getOptionName</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a2">getOptionTip</a>() +<code> [inline, virtual]</code><li><b>getOptionValue</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a3">getOptionValues</a>() +<code> [inline, virtual]</code><li><a class="el" href="class_utf8utf16.html#a1">ProcessText</a>(char *text, int maxlen, const SWKey *key) +<code> [virtual]</code><li><a class="el" href="class_swfilter.html#a7">SWFilter::ProcessText</a>(char *text, int maxlen=-1) +<code> [inline, virtual]</code><li><a class="el" href="class_swfilter.html#a4">setOptionValue</a>(const char *) +<code> [inline, virtual]</code><li><b>UTF8UTF16</b>() (defined in <a class="el" href="class_utf8utf16.html">UTF8UTF16</a>)<li><b>~SWFilter</b>() (defined in <a class="el" href="class_swfilter.html">SWFilter</a>)<code> [inline, virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_utf8utf16.gif b/doc/api-documentation/html/class_utf8utf16.gif Binary files differnew file mode 100644 index 0000000..b76f597 --- /dev/null +++ b/doc/api-documentation/html/class_utf8utf16.gif diff --git a/doc/api-documentation/html/class_utf8utf16.html b/doc/api-documentation/html/class_utf8utf16.html new file mode 100644 index 0000000..fb4c4e7 --- /dev/null +++ b/doc/api-documentation/html/class_utf8utf16.html @@ -0,0 +1,101 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>UTF8UTF16 class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>UTF8UTF16 Class Reference</h1>This filter converts UTF-8 encoded text to UTF-16. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="utf8utf16_h-source.html">utf8utf16.h</a>></code> +<p> +<p>Inheritance diagram for UTF8UTF16:: +<p><center><img src="class_utf8utf16.gif" usemap="#UTF8UTF16_map" border="0"></center> +<map name="UTF8UTF16_map"> +<area href="class_swfilter.html" alt="SWFilter" shape="rect" coords="0,0,79,24"> +</map> +<a href="class_utf8utf16-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="a0" doxytag="UTF8UTF16::UTF8UTF16"></a> + </td><td valign=bottom><b>UTF8UTF16</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_utf8utf16.html#a1">ProcessText</a> (char *text, int maxlen, const <a class="el" href="class_swkey.html">SWKey</a> *key)</td></tr> +<tr><td> </td><td><font size=-1><em>This is the main filter function.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This filter converts UTF-8 encoded text to UTF-16. +<p> + +<p> +Definition at line <a class="el" href="utf8utf16_h-source.html#l00029">29</a> of file <a class="el" href="utf8utf16_h-source.html">utf8utf16.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="a1" doxytag="UTF8UTF16::ProcessText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual char UTF8UTF16::ProcessText ( + </b></td> + <td valign="bottom"><b> +char * <em>text</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>maxlen</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>key</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This is the main filter function. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>text</em> + </td><td> +the text to be filtered/converted </td></tr> +<tr><td valign=top><em>maxlen</em> + </td><td> +maximal length of text to be processed </td></tr> +<tr><td valign=top><em>key</em> + </td><td> +sorry I don't know </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +0 </dl> +<p> +Reimplemented from <a class="el" href="class_swfilter.html#a6">SWFilter</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="utf8utf16_h-source.html">utf8utf16.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_verse_key-members.html b/doc/api-documentation/html/class_verse_key-members.html new file mode 100644 index 0000000..4804ff6 --- /dev/null +++ b/doc/api-documentation/html/class_verse_key-members.html @@ -0,0 +1,67 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>VerseKey Member List</h1>This is the complete list of members for <a class="el" href="class_verse_key.html">VerseKey</a>, including all inherited members.<ul> +<li><a class="el" href="class_verse_key.html#a35">_compare</a>(const VerseKey &ikey) +<code> [virtual]</code><li><b>abbrevs</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private]</code><li><b>abbrevsCnt</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_verse_key.html#o7">autonorm</a> +<code> [private]</code><li><a class="el" href="class_verse_key.html#a28">AutoNormalize</a>(char iautonorm=MAXPOS(char)) +<code> [virtual]</code><li><b>BMAX</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<li><b>book</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_verse_key.html#a20">Book</a>() const +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a24">Book</a>(char ibook) +<code> [virtual]</code><li><b>books</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<li><b>builtin_abbrevs</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [static]</code><li><b>builtin_BMAX</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [static]</code><li><b>builtin_books</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [static]</code><li><a class="el" href="class_verse_key.html#a21">Chapter</a>() const +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a25">Chapter</a>(int ichapter) +<code> [virtual]</code><li><b>chapter</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private]</code><li><b>classdef</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><a class="el" href="class_verse_key.html#a9">ClearBounds</a>() +<li><a class="el" href="class_verse_key.html#a10">clone</a>() const +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a34">compare</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a13">copyFrom</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a14">copyFrom</a>(const VerseKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a16">decrement</a>(int step) +<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a11">equals</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_key.html#a6">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_verse_key.html#c6">findindex</a>(long *array, int size, long value) +<code> [private]</code><li><a class="el" href="class_verse_key.html#c4">freshtext</a>() const +<code> [private]</code><li><b>getBookAbbrev</b>(const char *abbr) (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_s_w_object.html#a0">getClass</a>() const +<code> [inline]</code><li><a class="el" href="class_verse_key.html#a11">getText</a>() const +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a29">Headings</a>(char iheadings=MAXPOS(char)) +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#o8">headings</a> +<code> [private]</code><li><a class="el" href="class_verse_key.html#a17">increment</a>(int step) +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a31">Index</a>() const +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a32">Index</a>(long iindex) +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#c3">init</a>() +<code> [private]</code><li><b>initBounds</b>() const (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_verse_key.html#c2">initstatics</a>() +<code> [private]</code><li><a class="el" href="class_verse_key.html#r3">instance</a> +<code> [private, static]</code><li><b>internalListKey</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private]</code><li><b>keytext</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><b>localeCache</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><a class="el" href="class_verse_key.html#a5">LowerBound</a>(const char *lb) +<li><a class="el" href="class_verse_key.html#a7">LowerBound</a>() const +<li><b>lowerBound</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private]</code><li><b>myclass</b> (defined in <a class="el" href="class_s_w_object.html">SWObject</a>)<code> [protected]</code><li><b>NewIndex</b>() const (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a27">Normalize</a>(char autocheck=0) +<code> [virtual]</code><li><b>ntbks</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><b>ntbooks</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><b>ntcps</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><b>offsets</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><b>offsize</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><b>operator=</b>(const VerseKey &ikey) (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [inline, virtual]</code><li><b>otbks</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><b>otbooks</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><b>otcps</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><a class="el" href="class_verse_key.html#c5">parse</a>() +<code> [private, virtual]</code><li><b>ParseVerseList</b>(const char *buf, const char *defaultKey="Genesis 1:1", bool expandRange=false) (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [virtual]</code><li><a class="el" href="class_s_w_key.html#a4">Persist</a>() const +<li><a class="el" href="class_s_w_key.html#a5">Persist</a>(char ikey) +<li><b>persist</b> (defined in <a class="el" href="class_s_w_key.html">SWKey</a>)<code> [protected]</code><li><b>setBookAbbrevs</b>(const struct abbrev *bookAbbrevs, unsigned int size=0) (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [virtual]</code><li><b>setBooks</b>(const char *iBMAX, struct sbook **ibooks) (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [virtual]</code><li><b>setLocale</b>(const char *name) (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a15">setPosition</a>(SW_POSITION) +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a12">setText</a>(const char *ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_s_w_key.html#a0">SWKey</a>(const char *ikey=0) +<li><a class="el" href="class_s_w_key.html#a1">SWKey</a>(SWKey const &k) +<li><a class="el" href="class_verse_key.html#a19">Testament</a>() const +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a23">Testament</a>(char itestament) +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#o3">testament</a> +<code> [private]</code><li><b>Traversable</b>() (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [inline, virtual]</code><li><b>upperBound</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_verse_key.html#a6">UpperBound</a>(const char *ub) +<li><a class="el" href="class_verse_key.html#a8">UpperBound</a>() const +<li><b>verse</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_verse_key.html#a22">Verse</a>() const +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a26">Verse</a>(int iverse) +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a0">VerseKey</a>(const char *ikey=0) +<li><a class="el" href="class_verse_key.html#a1">VerseKey</a>(const SWKey *ikey) +<li><a class="el" href="class_verse_key.html#a2">VerseKey</a>(const char *min, const char *max) +<li><a class="el" href="class_verse_key.html#a3">VerseKey</a>(VerseKey const &k) +<li><b>vm</b> (defined in <a class="el" href="class_verse_key.html">VerseKey</a>)<code> [private, static]</code><li><a class="el" href="class_s_w_key.html#a2">~SWKey</a>() +<code> [virtual]</code><li><a class="el" href="class_verse_key.html#a4">~VerseKey</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_verse_key.gif b/doc/api-documentation/html/class_verse_key.gif Binary files differnew file mode 100644 index 0000000..a6a9869 --- /dev/null +++ b/doc/api-documentation/html/class_verse_key.gif diff --git a/doc/api-documentation/html/class_verse_key.html b/doc/api-documentation/html/class_verse_key.html new file mode 100644 index 0000000..dbca3bf --- /dev/null +++ b/doc/api-documentation/html/class_verse_key.html @@ -0,0 +1,1411 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>VerseKey class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>VerseKey Class Reference</h1>Class VerseKey The <a class="el" href="class_s_w_key.html">SWKey</a> implementation used for verse based modules like Bibles or commentaries. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="versekey_8h-source.html">versekey.h</a>></code> +<p> +<p>Inheritance diagram for VerseKey:: +<p><center><img src="class_verse_key.gif" usemap="#VerseKey_map" border="0"></center> +<map name="VerseKey_map"> +<area href="class_s_w_key.html" alt="SWKey" shape="rect" coords="0,56,68,80"> +<area href="class_s_w_object.html" alt="SWObject" shape="rect" coords="0,0,68,24"> +</map> +<a href="class_verse_key-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_verse_key.html#a0">VerseKey</a> (const char *ikey=0)</td></tr> +<tr><td> </td><td><font size=-1><em>VerseKey Constructor - initializes Instance of VerseKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_verse_key.html#a1">VerseKey</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> *ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>VerseKey Constructor - initializes instance of VerseKey.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_verse_key.html#a2">VerseKey</a> (const char *min, const char *max)</td></tr> +<tr><td> </td><td><font size=-1><em>VerseKey Constructor - initializes instance of VerseKey with boundariess - see also <a class="el" href="class_verse_key.html#a5">LowerBound</a> and <a class="el" href="class_verse_key.html#a6">UpperBound</a>.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_verse_key.html#a3">VerseKey</a> (VerseKey const &k)</td></tr> +<tr><td> </td><td><font size=-1><em>VerseKey Copy Constructor - will create a new VerseKey based on an existing one.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="VerseKey::~VerseKey"></a> +virtual </td><td valign=bottom><a class="el" href="class_verse_key.html#a4">~VerseKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>VerseKey Destructor Cleans up an instance of VerseKey.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>VerseKey & </td><td valign=bottom><a class="el" href="class_verse_key.html#a5">LowerBound</a> (const char *lb)</td></tr> +<tr><td> </td><td><font size=-1><em>sets the lower boundary for this VerseKey and returns the new boundary.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>VerseKey & </td><td valign=bottom><a class="el" href="class_verse_key.html#a6">UpperBound</a> (const char *ub)</td></tr> +<tr><td> </td><td><font size=-1><em>sets the upper boundary for this VerseKey and returns the new boundary.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>VerseKey & </td><td valign=bottom><a class="el" href="class_verse_key.html#a7">LowerBound</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>gets the lower boundary of this VerseKey.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>VerseKey & </td><td valign=bottom><a class="el" href="class_verse_key.html#a8">UpperBound</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>gets the upper boundary of this VerseKey.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a9" doxytag="VerseKey::ClearBounds"></a> +void </td><td valign=bottom><a class="el" href="class_verse_key.html#a9">ClearBounds</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>clears the boundaries of this VerseKey.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a10" doxytag="VerseKey::clone"></a> +virtual <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_verse_key.html#a10">clone</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Creates a new <a class="el" href="class_s_w_key.html">SWKey</a> based on the current VerseKey see also the Copy Constructor.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a11" doxytag="VerseKey::getText"></a> +virtual const char * </td><td valign=bottom><a class="el" href="class_verse_key.html#a11">getText</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>refreshes keytext before returning if cast to a (char *) is requested.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a12">setText</a> (const char *ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this <a class="el" href="class_s_w_key.html">SWKey</a> to a character string.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a13">copyFrom</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this <a class="el" href="class_s_w_key.html">SWKey</a> to another <a class="el" href="class_s_w_key.html">SWKey</a> object.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a14" doxytag="VerseKey::copyFrom"></a> +virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a14">copyFrom</a> (const VerseKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this VerseKey to another VerseKey.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a15">setPosition</a> (SW_POSITION)</td></tr> +<tr><td> </td><td><font size=-1><em>Positions this key.</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a16">decrement</a> (int step)</td></tr> +<tr><td> </td><td><font size=-1><em>Decrements key a number of verses.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a17">increment</a> (int step)</td></tr> +<tr><td> </td><td><font size=-1><em>Increments key a number of verses.</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a18" doxytag="VerseKey::Traversable"></a> +virtual char </td><td valign=bottom><b>Traversable</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a19">Testament</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets testament.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a20">Book</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets book.</em> <a href="#a20">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a21">Chapter</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets chapter.</em> <a href="#a21">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a22">Verse</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets verse.</em> <a href="#a22">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a23">Testament</a> (char itestament)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets testament.</em> <a href="#a23">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a24">Book</a> (char ibook)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets book.</em> <a href="#a24">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a25">Chapter</a> (int ichapter)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets chapter.</em> <a href="#a25">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a26">Verse</a> (int iverse)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets verse.</em> <a href="#a26">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_verse_key.html#a27">Normalize</a> (char autocheck=0)</td></tr> +<tr><td> </td><td><font size=-1><em>checks limits and normalizes if necessary (e.g.</em> <a href="#a27">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a28">AutoNormalize</a> (char iautonorm=MAXPOS(char))</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets flag that tells VerseKey to automatically normalize itself when modified.</em> <a href="#a28">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#a29">Headings</a> (char iheadings=MAXPOS(char))</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets flag that tells VerseKey to include chapter/book/testament/module headings.</em> <a href="#a29">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a30" doxytag="VerseKey::NewIndex"></a> +virtual long </td><td valign=bottom><b>NewIndex</b> () const</td></tr> +<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_verse_key.html#a31">Index</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets index based upon current verse.</em> <a href="#a31">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_verse_key.html#a32">Index</a> (long iindex)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets index based upon current verse.</em> <a href="#a32">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a33" doxytag="VerseKey::ParseVerseList"></a> +virtual <a class="el" href="class_list_key.html">ListKey</a> </td><td valign=bottom><b>ParseVerseList</b> (const char *buf, const char *defaultKey="Genesis 1:1", bool expandRange=false)</td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a34">compare</a> (const <a class="el" href="class_s_w_key.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Compares another <a class="el" href="class_s_w_key.html">SWKey</a> object.</em> <a href="#a34">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_verse_key.html#a35">_compare</a> (const VerseKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Compares another VerseKey object.</em> <a href="#a35">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a36" doxytag="VerseKey::setBookAbbrevs"></a> +virtual void </td><td valign=bottom><b>setBookAbbrevs</b> (const struct abbrev *bookAbbrevs, unsigned int size=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a37" doxytag="VerseKey::setBooks"></a> +virtual void </td><td valign=bottom><b>setBooks</b> (const char *iBMAX, struct sbook **ibooks)</td></tr> +<tr><td nowrap align=right valign=top><a name="a38" doxytag="VerseKey::setLocale"></a> +virtual void </td><td valign=bottom><b>setLocale</b> (const char *name)</td></tr> +<tr><td nowrap align=right valign=top><a name="a39" doxytag="VerseKey::operator="></a> +virtual SWKEY_OPERATORS <a class="el" href="class_s_w_key.html">SWKey</a> & </td><td valign=bottom><b>operator=</b> (const VerseKey &ikey)</td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="m0" doxytag="VerseKey::BMAX"></a> +const char * </td><td valign=bottom><b>BMAX</b></td></tr> +<tr><td nowrap align=right valign=top><a name="m1" doxytag="VerseKey::books"></a> +sbook ** </td><td valign=bottom><b>books</b></td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="p0" doxytag="VerseKey::builtin_BMAX"></a> +const char </td><td valign=bottom><b>builtin_BMAX</b> [2]</td></tr> +<tr><td nowrap align=right valign=top><a name="p1" doxytag="VerseKey::builtin_books"></a> +sbook * </td><td valign=bottom><b>builtin_books</b> [2]</td></tr> +<tr><td nowrap align=right valign=top><a name="p2" doxytag="VerseKey::builtin_abbrevs"></a> +const struct abbrev </td><td valign=bottom><b>builtin_abbrevs</b> []</td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="VerseKey::getBookAbbrev"></a> +int </td><td valign=bottom><b>getBookAbbrev</b> (const char *abbr)</td></tr> +<tr><td nowrap align=right valign=top><a name="c1" doxytag="VerseKey::initBounds"></a> +void </td><td valign=bottom><b>initBounds</b> () const</td></tr> +<tr><td nowrap align=right valign=top><a name="c2" doxytag="VerseKey::initstatics"></a> +void </td><td valign=bottom><a class="el" href="class_verse_key.html#c2">initstatics</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>initialize and allocate books array.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="c3" doxytag="VerseKey::init"></a> +void </td><td valign=bottom><a class="el" href="class_verse_key.html#c3">init</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>initializes this <a class="el" href="class_verse_key.html#a0">VerseKey</a>().</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="c4" doxytag="VerseKey::freshtext"></a> +void </td><td valign=bottom><a class="el" href="class_verse_key.html#c4">freshtext</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Refresh keytext based on testament|book|chapter|verse default auto normalization to true default display headings option is false.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="c5" doxytag="VerseKey::parse"></a> +virtual char </td><td valign=bottom><a class="el" href="class_verse_key.html#c5">parse</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Parse a character array into testament|book|chapter|verse.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_verse_key.html#c6">findindex</a> (long *array, int size, long value)</td></tr> +<tr><td> </td><td><font size=-1><em>Binary search to find the index closest, but less than the given value.</em> <a href="#c6">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="VerseKey::internalListKey"></a> +<a class="el" href="class_list_key.html">ListKey</a> </td><td valign=bottom><b>internalListKey</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="VerseKey::abbrevs"></a> +const struct abbrev * </td><td valign=bottom><b>abbrevs</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o2" doxytag="VerseKey::abbrevsCnt"></a> +int </td><td valign=bottom><b>abbrevsCnt</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o3" doxytag="VerseKey::testament"></a> +char </td><td valign=bottom><a class="el" href="class_verse_key.html#o3">testament</a></td></tr> +<tr><td> </td><td><font size=-1><em>The Testament: 0 - Old; 1 - New.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="o4" doxytag="VerseKey::book"></a> +char </td><td valign=bottom><b>book</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o5" doxytag="VerseKey::chapter"></a> +int </td><td valign=bottom><b>chapter</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o6" doxytag="VerseKey::verse"></a> +int </td><td valign=bottom><b>verse</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o7" doxytag="VerseKey::autonorm"></a> +char </td><td valign=bottom><a class="el" href="class_verse_key.html#o7">autonorm</a></td></tr> +<tr><td> </td><td><font size=-1><em>flag for auto normalization.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="o8" doxytag="VerseKey::headings"></a> +char </td><td valign=bottom><a class="el" href="class_verse_key.html#o8">headings</a></td></tr> +<tr><td> </td><td><font size=-1><em>flag for headings on/off.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="o9" doxytag="VerseKey::lowerBound"></a> +VerseKey * </td><td valign=bottom><b>lowerBound</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o10" doxytag="VerseKey::upperBound"></a> +VerseKey * </td><td valign=bottom><b>upperBound</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="VerseKey::classdef"></a> +<a class="el" href="class_s_w_class.html">SWClass</a> </td><td valign=bottom><b>classdef</b></td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="VerseKey::offsets"></a> +long * </td><td valign=bottom><b>offsets</b> [2][2]</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="VerseKey::offsize"></a> +int </td><td valign=bottom><b>offsize</b> [2][2]</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="VerseKey::instance"></a> +int </td><td valign=bottom><a class="el" href="class_verse_key.html#r3">instance</a></td></tr> +<tr><td> </td><td><font size=-1><em>number of instantiated VerseKey objects or derivitives.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="r4" doxytag="VerseKey::otbooks"></a> +sbook </td><td valign=bottom><b>otbooks</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r5" doxytag="VerseKey::ntbooks"></a> +sbook </td><td valign=bottom><b>ntbooks</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r6" doxytag="VerseKey::otbks"></a> +long </td><td valign=bottom><b>otbks</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r7" doxytag="VerseKey::otcps"></a> +long </td><td valign=bottom><b>otcps</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r8" doxytag="VerseKey::ntbks"></a> +long </td><td valign=bottom><b>ntbks</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r9" doxytag="VerseKey::ntcps"></a> +long </td><td valign=bottom><b>ntcps</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r10" doxytag="VerseKey::vm"></a> +int </td><td valign=bottom><b>vm</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r11" doxytag="VerseKey::localeCache"></a> +LocaleCache </td><td valign=bottom><b>localeCache</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Class VerseKey The <a class="el" href="class_s_w_key.html">SWKey</a> implementation used for verse based modules like Bibles or commentaries. +<p> + +<p> +Definition at line <a class="el" href="versekey_8h-source.html#l00067">67</a> of file <a class="el" href="versekey_8h-source.html">versekey.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="VerseKey::VerseKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +VerseKey::VerseKey + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ikey</em> = 0 </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +VerseKey Constructor - initializes Instance of VerseKey. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +text key (will take various forms of 'BOOK CH:VS'. See <a class="el" href="class_verse_key.html#c5">parse</a> for more detailed information) </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="VerseKey::VerseKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +VerseKey::VerseKey + </td> + <td class="md">( </td> + <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> * </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +VerseKey Constructor - initializes instance of VerseKey. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +base key (will take various forms of 'BOOK CH:VS'. See <a class="el" href="class_verse_key.html#c5">parse</a> for more detailed information) </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a2" doxytag="VerseKey::VerseKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +VerseKey::VerseKey + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>min</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">const char * </td> + <td class="mdname"> <em>max</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +VerseKey Constructor - initializes instance of VerseKey with boundariess - see also <a class="el" href="class_verse_key.html#a5">LowerBound</a> and <a class="el" href="class_verse_key.html#a6">UpperBound</a>. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>min +</em> </td><td> +the lower boundary of the new VerseKey </td></tr> +<tr><td valign=top><em>max +</em> </td><td> +the upper boundary of the new VerseKey </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a3" doxytag="VerseKey::VerseKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +VerseKey::VerseKey + </td> + <td class="md">( </td> + <td class="md">VerseKey const & </td> + <td class="mdname"> <em>k</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +VerseKey Copy Constructor - will create a new VerseKey based on an existing one. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>k +</em> </td><td> +the VerseKey to copy from </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a28" doxytag="VerseKey::AutoNormalize"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char VerseKey::AutoNormalize + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>iautonorm</em> = MAXPOS (char) </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets flag that tells VerseKey to automatically normalize itself when modified. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iautonorm +</em> </td><td> +value which to set autonorm [MAXPOS(char)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of autonorm, if changed -> previous value of autonorm </dl> </td> + </tr> +</table> +<a name="a24" doxytag="VerseKey::Book"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char VerseKey::Book + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>ibook</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets book. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ibook +</em> </td><td> +value which to set book [MAXPOS(char)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of book, if changed -> previous value of book </dl> </td> + </tr> +</table> +<a name="a20" doxytag="VerseKey::Book"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char VerseKey::Book + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets book. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +value of book </dl> </td> + </tr> +</table> +<a name="a25" doxytag="VerseKey::Chapter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual int VerseKey::Chapter + </td> + <td class="md">( </td> + <td class="md">int </td> + <td class="mdname"> <em>ichapter</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets chapter. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ichapter +</em> </td><td> +value which to set chapter [MAXPOS(int)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of chapter, if changed -> previous value of chapter </dl> </td> + </tr> +</table> +<a name="a21" doxytag="VerseKey::Chapter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual int VerseKey::Chapter + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets chapter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +value of chapter </dl> </td> + </tr> +</table> +<a name="a29" doxytag="VerseKey::Headings"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char VerseKey::Headings + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>iheadings</em> = MAXPOS (char) </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets flag that tells VerseKey to include chapter/book/testament/module headings. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iheadings +</em> </td><td> +value which to set headings [MAXPOS(char)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of headings, if changed -> previous value of headings </dl> </td> + </tr> +</table> +<a name="a32" doxytag="VerseKey::Index"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual long VerseKey::Index + </td> + <td class="md">( </td> + <td class="md">long </td> + <td class="mdname"> <em>index</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets index based upon current verse. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iindex +</em> </td><td> +value to set index to </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +offset </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html">SWKey</a>. </td> + </tr> +</table> +<a name="a31" doxytag="VerseKey::Index"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual long VerseKey::Index + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets index based upon current verse. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +offset </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html#a16">SWKey</a>. </td> + </tr> +</table> +<a name="a7" doxytag="VerseKey::LowerBound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +VerseKey& VerseKey::LowerBound + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the lower boundary of this VerseKey. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +the lower boundary of this VerseKey </dl> </td> + </tr> +</table> +<a name="a5" doxytag="VerseKey::LowerBound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +VerseKey& VerseKey::LowerBound + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>lb</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +sets the lower boundary for this VerseKey and returns the new boundary. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>lb +</em> </td><td> +the new lower boundary for this VerseKey </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +the lower boundary the key was set to </dl> </td> + </tr> +</table> +<a name="a27" doxytag="VerseKey::Normalize"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void VerseKey::Normalize + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>autocheck</em> = 0 </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +checks limits and normalizes if necessary (e.g. +<p> +Matthew 29:47 = Mark 2:2). If last verse is exceeded, key is set to last Book CH:VS +<p> +<dl compact><dt> +<b>Returns: </b><dd> +*this </dl> </td> + </tr> +</table> +<a name="a23" doxytag="VerseKey::Testament"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char VerseKey::Testament + </td> + <td class="md">( </td> + <td class="md">char </td> + <td class="mdname"> <em>itestament</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets testament. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>itestament +</em> </td><td> +value which to set testament [MAXPOS(char)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of testament, if changed -> previous value of testament </dl> </td> + </tr> +</table> +<a name="a19" doxytag="VerseKey::Testament"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual char VerseKey::Testament + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets testament. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +value of testament </dl> </td> + </tr> +</table> +<a name="a8" doxytag="VerseKey::UpperBound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +VerseKey& VerseKey::UpperBound + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the upper boundary of this VerseKey. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +the upper boundary of this VerseKey </dl> </td> + </tr> +</table> +<a name="a6" doxytag="VerseKey::UpperBound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +VerseKey& VerseKey::UpperBound + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ub</em> </td> + <td class="md">) </td> + <td class="md"> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +sets the upper boundary for this VerseKey and returns the new boundary. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>lb +</em> </td><td> +the new upper boundary for this VerseKey </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +the upper boundary the key was set to </dl> </td> + </tr> +</table> +<a name="a26" doxytag="VerseKey::Verse"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual int VerseKey::Verse + </td> + <td class="md">( </td> + <td class="md">int </td> + <td class="mdname"> <em>iverse</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets verse. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iverse +</em> </td><td> +value which to set verse [MAXPOS(int)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of verse, if changed -> previous value of verse </dl> </td> + </tr> +</table> +<a name="a22" doxytag="VerseKey::Verse"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual int VerseKey::Verse + </td> + <td class="md">( </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"> const<code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets verse. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +value of verse </dl> </td> + </tr> +</table> +<a name="a35" doxytag="VerseKey::_compare"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual int VerseKey::_compare + </td> + <td class="md">( </td> + <td class="md">const VerseKey & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compares another VerseKey object. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +key to compare with this one </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +>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 </dl> </td> + </tr> +</table> +<a name="a34" doxytag="VerseKey::compare"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual int VerseKey::compare + </td> + <td class="md">( </td> + <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compares another <a class="el" href="class_s_w_key.html">SWKey</a> object. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +key to compare with this one </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +>0 if this VerseKey is greater than compare <a class="el" href="class_s_w_key.html">SWKey</a>, <0 if this VerseKey is smaller than compare <a class="el" href="class_s_w_key.html">SWKey</a>, 0 if the keys are the same </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html#a10">SWKey</a>. </td> + </tr> +</table> +<a name="a13" doxytag="VerseKey::copyFrom"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void VerseKey::copyFrom + </td> + <td class="md">( </td> + <td class="md">const <a class="el" href="class_s_w_key.html">SWKey</a> & </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this <a class="el" href="class_s_w_key.html">SWKey</a> to another <a class="el" href="class_s_w_key.html">SWKey</a> object. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +other swkey object </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html#a8">SWKey</a>. </td> + </tr> +</table> +<a name="a16" doxytag="VerseKey::decrement"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void VerseKey::decrement + </td> + <td class="md">( </td> + <td class="md">int </td> + <td class="mdname"> <em>step</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Decrements key a number of verses. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>decrement +</em> </td><td> +Number of verses to jump backward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html#a13">SWKey</a>. </td> + </tr> +</table> +<a name="c6" doxytag="VerseKey::findindex"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +int VerseKey::findindex + </td> + <td class="md">( </td> + <td class="md">long * </td> + <td class="mdname"> <em>array</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">int </td> + <td class="mdname"> <em>size</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md"> <tr> + <td></td> + <td></td> + <td class="md">long </td> + <td class="mdname"> <em>value</em> </td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [private]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Binary search to find the index closest, but less than the given value. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>array +</em> </td><td> +long * to array to search </td></tr> +<tr><td valign=top><em>size +</em> </td><td> +number of elements in the array </td></tr> +<tr><td valign=top><em>value +</em> </td><td> +value to find </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +the index into the array that is less than but closest to value </dl> </td> + </tr> +</table> +<a name="a17" doxytag="VerseKey::increment"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void VerseKey::increment + </td> + <td class="md">( </td> + <td class="md">int </td> + <td class="mdname"> <em>step</em> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Increments key a number of verses. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>increment +</em> </td><td> +Number of verses to jump forward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html#a14">SWKey</a>. </td> + </tr> +</table> +<a name="a15" doxytag="VerseKey::setPosition"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void VerseKey::setPosition + </td> + <td class="md">( </td> + <td class="md">SW_POSITION </td> + <td class="mdname"> </td> + <td class="md">) </td> + <td class="md"><code> [virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Positions this key. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>p +</em> </td><td> +position </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html">SWKey</a>. </td> + </tr> +</table> +<a name="a12" doxytag="VerseKey::setText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> +virtual void VerseKey::setText + </td> + <td class="md">( </td> + <td class="md">const char * </td> + <td class="mdname"> <em>ikey</em> </td> + <td class="md">) </td> + <td class="md"><code> [inline, virtual]</code> </td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this <a class="el" href="class_s_w_key.html">SWKey</a> to a character string. +<p> +<dl compact><dt> +Parameters: <dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey +</em> </td><td> +string to set this key to </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_s_w_key.html#a7">SWKey</a>. +<p> +Definition at line <a class="el" href="versekey_8h-source.html#l00229">229</a> of file <a class="el" href="versekey_8h-source.html">versekey.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="versekey_8h-source.html">versekey.h</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_versekey-members.html b/doc/api-documentation/html/class_versekey-members.html new file mode 100644 index 0000000..1c1025d --- /dev/null +++ b/doc/api-documentation/html/class_versekey-members.html @@ -0,0 +1,68 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Member List</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>VerseKey Member List</h1>This is the complete list of members for <a class="el" href="class_versekey.html">VerseKey</a>, including all inherited members.<ul> +<li><a class="el" href="class_versekey.html#a35">_compare</a>(const VerseKey &ikey) +<code> [virtual]</code><li><b>abbrevs</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private]</code><li><b>abbrevsCnt</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_versekey.html#o7">autonorm</a> +<code> [private]</code><li><a class="el" href="class_versekey.html#a28">AutoNormalize</a>(char iautonorm=MAXPOS(char)) +<code> [virtual]</code><li><b>BMAX</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<li><b>book</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_versekey.html#a20">Book</a>() const +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a24">Book</a>(char ibook) +<code> [virtual]</code><li><b>books</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<li><b>builtin_abbrevs</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [static]</code><li><b>builtin_BMAX</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [static]</code><li><b>builtin_books</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [static]</code><li><a class="el" href="class_versekey.html#a21">Chapter</a>() const +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a25">Chapter</a>(int ichapter) +<code> [virtual]</code><li><b>chapter</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private]</code><li><b>classdef</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><a class="el" href="class_versekey.html#a9">ClearBounds</a>() +<li><a class="el" href="class_versekey.html#a10">clone</a>() const +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a34">compare</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a13">copyFrom</a>(const SWKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a14">copyFrom</a>(const VerseKey &ikey) +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a16">decrement</a>(int step) +<code> [virtual]</code><li><a class="el" href="class_swkey.html#a11">equals</a>(const SWKey &ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_swkey.html#a6">Error</a>() +<code> [virtual]</code><li><b>error</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><a class="el" href="class_versekey.html#c6">findindex</a>(long *array, int size, long value) +<code> [private]</code><li><a class="el" href="class_versekey.html#c4">freshtext</a>() const +<code> [private]</code><li><b>getBookAbbrev</b>(char *abbr) (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_swobject.html#a0">getClass</a>() const +<code> [inline]</code><li><a class="el" href="class_versekey.html#a11">getText</a>() const +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a29">Headings</a>(char iheadings=MAXPOS(char)) +<code> [virtual]</code><li><a class="el" href="class_versekey.html#o8">headings</a> +<code> [private]</code><li><a class="el" href="class_versekey.html#a17">increment</a>(int step) +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a31">Index</a>() const +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a32">Index</a>(long iindex) +<code> [virtual]</code><li><a class="el" href="class_versekey.html#c3">init</a>() +<code> [private]</code><li><b>initBounds</b>() const (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_versekey.html#c2">initstatics</a>() +<code> [private]</code><li><a class="el" href="class_versekey.html#r3">instance</a> +<code> [private, static]</code><li><b>internalListKey</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private]</code><li><b>keytext</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><b>localeCache</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><a class="el" href="class_versekey.html#a5">LowerBound</a>(const char *lb) +<li><a class="el" href="class_versekey.html#a7">LowerBound</a>() const +<li><b>lowerBound</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private]</code><li><b>myclass</b> (defined in <a class="el" href="class_swobject.html">SWObject</a>)<code> [protected]</code><li><b>NewIndex</b>() const (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [virtual]</code><li><a class="el" href="class_versekey.html#a27">Normalize</a>(char autocheck=0) +<code> [virtual]</code><li><b>ntbks</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><b>ntbooks</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><b>ntcps</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><b>offsets</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><b>offsize</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><b>operator=</b>(const VerseKey &ikey) (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [inline, virtual]</code><li><b>otbks</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><b>otbooks</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><b>otcps</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><a class="el" href="class_versekey.html#c5">parse</a>() +<code> [private, virtual]</code><li><b>ParseVerseList</b>(const char *buf, const char *defaultKey="Genesis 1:1", bool expandRange=false) (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [virtual]</code><li><a class="el" href="class_swkey.html#a4">Persist</a>() const +<li><a class="el" href="class_swkey.html#a5">Persist</a>(char ikey) +<li><b>persist</b> (defined in <a class="el" href="class_swkey.html">SWKey</a>)<code> [protected]</code><li><b>setBookAbbrevs</b>(const struct abbrev *bookAbbrevs, unsigned int size=0) (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [virtual]</code><li><b>setBooks</b>(const char *iBMAX, struct sbook **ibooks) (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [virtual]</code><li><b>setLocale</b>(const char *name) (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [virtual]</code><li><a class="el" href="class_versekey.html#a15">setPosition</a>(SW_POSITION) +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a12">setText</a>(const char *ikey) +<code> [inline, virtual]</code><li><a class="el" href="class_swkey.html#a0">SWKey</a>(const char *ikey=0) +<li><a class="el" href="class_swkey.html#a1">SWKey</a>(SWKey const &k) +<li><a class="el" href="class_versekey.html#a19">Testament</a>() const +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a23">Testament</a>(char itestament) +<code> [virtual]</code><li><a class="el" href="class_versekey.html#o3">testament</a> +<code> [private]</code><li><b>Traversable</b>() (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [inline, virtual]</code><li><b>upperBound</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_versekey.html#a6">UpperBound</a>(const char *ub) +<li><a class="el" href="class_versekey.html#a8">UpperBound</a>() const +<li><b>verse</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private]</code><li><a class="el" href="class_versekey.html#a22">Verse</a>() const +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a26">Verse</a>(int iverse) +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a0">VerseKey</a>(const char *ikey=0) +<li><a class="el" href="class_versekey.html#a1">VerseKey</a>(const SWKey *ikey) +<li><a class="el" href="class_versekey.html#a2">VerseKey</a>(const char *min, const char *max) +<li><a class="el" href="class_versekey.html#a3">VerseKey</a>(VerseKey const &k) +<li><b>vm</b> (defined in <a class="el" href="class_versekey.html">VerseKey</a>)<code> [private, static]</code><li><a class="el" href="class_swkey.html#a2">~SWKey</a>() +<code> [virtual]</code><li><a class="el" href="class_versekey.html#a4">~VerseKey</a>() +<code> [virtual]</code></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/class_versekey.gif b/doc/api-documentation/html/class_versekey.gif Binary files differnew file mode 100644 index 0000000..a6a9869 --- /dev/null +++ b/doc/api-documentation/html/class_versekey.gif diff --git a/doc/api-documentation/html/class_versekey.html b/doc/api-documentation/html/class_versekey.html new file mode 100644 index 0000000..418468a --- /dev/null +++ b/doc/api-documentation/html/class_versekey.html @@ -0,0 +1,1346 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>VerseKey class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>VerseKey Class Reference</h1>Class VerseKey The <a class="el" href="class_swkey.html">SWKey</a> implementation used for verse based modules like Bibles or commentaries. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="versekey_h-source.html">versekey.h</a>></code> +<p> +<p>Inheritance diagram for VerseKey:: +<p><center><img src="class_versekey.gif" usemap="#VerseKey_map" border="0"></center> +<map name="VerseKey_map"> +<area href="class_swkey.html" alt="SWKey" shape="rect" coords="0,56,68,80"> +<area href="class_swobject.html" alt="SWObject" shape="rect" coords="0,0,68,24"> +</map> +<a href="class_versekey-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_versekey.html#a0">VerseKey</a> (const char *ikey=0)</td></tr> +<tr><td> </td><td><font size=-1><em>VerseKey Constructor - initializes Instance of VerseKey.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_versekey.html#a1">VerseKey</a> (const <a class="el" href="class_swkey.html">SWKey</a> *ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>VerseKey Constructor - initializes instance of VerseKey.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_versekey.html#a2">VerseKey</a> (const char *min, const char *max)</td></tr> +<tr><td> </td><td><font size=-1><em>VerseKey Constructor - initializes instance of VerseKey with boundariess - see also <a class="el" href="class_versekey.html#a5">LowerBound</a> and <a class="el" href="class_versekey.html#a6">UpperBound</a>.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_versekey.html#a3">VerseKey</a> (VerseKey const &k)</td></tr> +<tr><td> </td><td><font size=-1><em>VerseKey Copy Constructor - will create a new VerseKey based on an existing one.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a4" doxytag="VerseKey::~VerseKey"></a> +virtual </td><td valign=bottom><a class="el" href="class_versekey.html#a4">~VerseKey</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>VerseKey Destructor Cleans up an instance of VerseKey.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>VerseKey& </td><td valign=bottom><a class="el" href="class_versekey.html#a5">LowerBound</a> (const char *lb)</td></tr> +<tr><td> </td><td><font size=-1><em>sets the lower boundary for this VerseKey and returns the new boundary.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>VerseKey& </td><td valign=bottom><a class="el" href="class_versekey.html#a6">UpperBound</a> (const char *ub)</td></tr> +<tr><td> </td><td><font size=-1><em>sets the upper boundary for this VerseKey and returns the new boundary.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>VerseKey& </td><td valign=bottom><a class="el" href="class_versekey.html#a7">LowerBound</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>gets the lower boundary of this VerseKey.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>VerseKey& </td><td valign=bottom><a class="el" href="class_versekey.html#a8">UpperBound</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>gets the upper boundary of this VerseKey.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a9" doxytag="VerseKey::ClearBounds"></a> +void </td><td valign=bottom><a class="el" href="class_versekey.html#a9">ClearBounds</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>clears the boundaries of this VerseKey.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a10" doxytag="VerseKey::clone"></a> +virtual <a class="el" href="class_swkey.html">SWKey</a>* </td><td valign=bottom><a class="el" href="class_versekey.html#a10">clone</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Creates a new <a class="el" href="class_swkey.html">SWKey</a> based on the current VerseKey see also the Copy Constructor.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a11" doxytag="VerseKey::getText"></a> +virtual const char* </td><td valign=bottom><a class="el" href="class_versekey.html#a11">getText</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>refreshes keytext before returning if cast to a (char *) is requested.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_versekey.html#a12">setText</a> (const char *ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this <a class="el" href="class_swkey.html">SWKey</a> to a character string.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_versekey.html#a13">copyFrom</a> (const <a class="el" href="class_swkey.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this <a class="el" href="class_swkey.html">SWKey</a> to another <a class="el" href="class_swkey.html">SWKey</a> object.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a14" doxytag="VerseKey::copyFrom"></a> +virtual void </td><td valign=bottom><a class="el" href="class_versekey.html#a14">copyFrom</a> (const VerseKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Equates this VerseKey to another VerseKey.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_versekey.html#a15">setPosition</a> (SW_POSITION)</td></tr> +<tr><td> </td><td><font size=-1><em>Positions this key.</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_versekey.html#a16">decrement</a> (int step)</td></tr> +<tr><td> </td><td><font size=-1><em>Decrements key a number of verses.</em> <a href="#a16">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_versekey.html#a17">increment</a> (int step)</td></tr> +<tr><td> </td><td><font size=-1><em>Increments key a number of verses.</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a18" doxytag="VerseKey::Traversable"></a> +virtual char </td><td valign=bottom><b>Traversable</b> ()</td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_versekey.html#a19">Testament</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets testament.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_versekey.html#a20">Book</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets book.</em> <a href="#a20">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_versekey.html#a21">Chapter</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets chapter.</em> <a href="#a21">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_versekey.html#a22">Verse</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets verse.</em> <a href="#a22">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_versekey.html#a23">Testament</a> (char itestament)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets testament.</em> <a href="#a23">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_versekey.html#a24">Book</a> (char ibook)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets book.</em> <a href="#a24">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_versekey.html#a25">Chapter</a> (int ichapter)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets chapter.</em> <a href="#a25">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_versekey.html#a26">Verse</a> (int iverse)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets verse.</em> <a href="#a26">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_versekey.html#a27">Normalize</a> (char autocheck=0)</td></tr> +<tr><td> </td><td><font size=-1><em>checks limits and normalizes if necessary (e.g.</em> <a href="#a27">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_versekey.html#a28">AutoNormalize</a> (char iautonorm=MAXPOS(char))</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets flag that tells VerseKey to automatically normalize itself when modified.</em> <a href="#a28">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_versekey.html#a29">Headings</a> (char iheadings=MAXPOS(char))</td></tr> +<tr><td> </td><td><font size=-1><em>Sets/gets flag that tells VerseKey to include chapter/book/testament/module headings.</em> <a href="#a29">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a30" doxytag="VerseKey::NewIndex"></a> +virtual long </td><td valign=bottom><b>NewIndex</b> () const</td></tr> +<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_versekey.html#a31">Index</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Gets index based upon current verse.</em> <a href="#a31">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual long </td><td valign=bottom><a class="el" href="class_versekey.html#a32">Index</a> (long iindex)</td></tr> +<tr><td> </td><td><font size=-1><em>Sets index based upon current verse.</em> <a href="#a32">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a33" doxytag="VerseKey::ParseVerseList"></a> +virtual <a class="el" href="class_listkey.html">ListKey</a> </td><td valign=bottom><b>ParseVerseList</b> (const char *buf, const char *defaultKey="Genesis 1:1", bool expandRange=false)</td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_versekey.html#a34">compare</a> (const <a class="el" href="class_swkey.html">SWKey</a> &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Compares another <a class="el" href="class_swkey.html">SWKey</a> object.</em> <a href="#a34">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual int </td><td valign=bottom><a class="el" href="class_versekey.html#a35">_compare</a> (const VerseKey &ikey)</td></tr> +<tr><td> </td><td><font size=-1><em>Compares another VerseKey object.</em> <a href="#a35">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a36" doxytag="VerseKey::setBookAbbrevs"></a> +virtual void </td><td valign=bottom><b>setBookAbbrevs</b> (const struct abbrev *bookAbbrevs, unsigned int size=0)</td></tr> +<tr><td nowrap align=right valign=top><a name="a37" doxytag="VerseKey::setBooks"></a> +virtual void </td><td valign=bottom><b>setBooks</b> (const char *iBMAX, struct sbook **ibooks)</td></tr> +<tr><td nowrap align=right valign=top><a name="a38" doxytag="VerseKey::setLocale"></a> +virtual void </td><td valign=bottom><b>setLocale</b> (const char *name)</td></tr> +<tr><td nowrap align=right valign=top><a name="a39" doxytag="VerseKey::operator="></a> +virtual SWKEY_OPERATORS <a class="el" href="class_swkey.html">SWKey</a>& </td><td valign=bottom><b>operator=</b> (const VerseKey &ikey)</td></tr> +<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="m0" doxytag="VerseKey::BMAX"></a> +const char* </td><td valign=bottom><b>BMAX</b></td></tr> +<tr><td nowrap align=right valign=top><a name="m1" doxytag="VerseKey::books"></a> +struct sbook** </td><td valign=bottom><b>books</b></td></tr> +<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="p0" doxytag="VerseKey::builtin_BMAX"></a> +const char </td><td valign=bottom><b>builtin_BMAX</b> [2]</td></tr> +<tr><td nowrap align=right valign=top><a name="p1" doxytag="VerseKey::builtin_books"></a> +struct sbook* </td><td valign=bottom><b>builtin_books</b> [2]</td></tr> +<tr><td nowrap align=right valign=top><a name="p2" doxytag="VerseKey::builtin_abbrevs"></a> +const struct abbrev </td><td valign=bottom><b>builtin_abbrevs</b> []</td></tr> +<tr><td colspan=2><br><h2>Private Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="c0" doxytag="VerseKey::getBookAbbrev"></a> +int </td><td valign=bottom><b>getBookAbbrev</b> (char *abbr)</td></tr> +<tr><td nowrap align=right valign=top><a name="c1" doxytag="VerseKey::initBounds"></a> +void </td><td valign=bottom><b>initBounds</b> () const</td></tr> +<tr><td nowrap align=right valign=top><a name="c2" doxytag="VerseKey::initstatics"></a> +void </td><td valign=bottom><a class="el" href="class_versekey.html#c2">initstatics</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>initialize and allocate books array.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="c3" doxytag="VerseKey::init"></a> +void </td><td valign=bottom><a class="el" href="class_versekey.html#c3">init</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>initializes this <a class="el" href="class_versekey.html#a0">VerseKey</a>().</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="c4" doxytag="VerseKey::freshtext"></a> +void </td><td valign=bottom><a class="el" href="class_versekey.html#c4">freshtext</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Refresh keytext based on testament|book|chapter|verse default auto normalization to true default display headings option is false.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="c5" doxytag="VerseKey::parse"></a> +virtual char </td><td valign=bottom><a class="el" href="class_versekey.html#c5">parse</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Parse a character array into testament|book|chapter|verse.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_versekey.html#c6">findindex</a> (long *array, int size, long value)</td></tr> +<tr><td> </td><td><font size=-1><em>Binary search to find the index closest, but less than the given value.</em> <a href="#c6">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="o0" doxytag="VerseKey::internalListKey"></a> +<a class="el" href="class_listkey.html">ListKey</a> </td><td valign=bottom><b>internalListKey</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o1" doxytag="VerseKey::abbrevs"></a> +const struct abbrev* </td><td valign=bottom><b>abbrevs</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o2" doxytag="VerseKey::abbrevsCnt"></a> +int </td><td valign=bottom><b>abbrevsCnt</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o3" doxytag="VerseKey::testament"></a> +char </td><td valign=bottom><a class="el" href="class_versekey.html#o3">testament</a></td></tr> +<tr><td> </td><td><font size=-1><em>The Testament: 0 - Old; 1 - New.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="o4" doxytag="VerseKey::book"></a> +char </td><td valign=bottom><b>book</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o5" doxytag="VerseKey::chapter"></a> +int </td><td valign=bottom><b>chapter</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o6" doxytag="VerseKey::verse"></a> +int </td><td valign=bottom><b>verse</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o7" doxytag="VerseKey::autonorm"></a> +char </td><td valign=bottom><a class="el" href="class_versekey.html#o7">autonorm</a></td></tr> +<tr><td> </td><td><font size=-1><em>flag for auto normalization.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="o8" doxytag="VerseKey::headings"></a> +char </td><td valign=bottom><a class="el" href="class_versekey.html#o8">headings</a></td></tr> +<tr><td> </td><td><font size=-1><em>flag for headings on/off.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="o9" doxytag="VerseKey::lowerBound"></a> +VerseKey* </td><td valign=bottom><b>lowerBound</b></td></tr> +<tr><td nowrap align=right valign=top><a name="o10" doxytag="VerseKey::upperBound"></a> +VerseKey * </td><td valign=bottom><b>upperBound</b></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a name="r0" doxytag="VerseKey::classdef"></a> +<a class="el" href="class_swclass.html">SWClass</a> </td><td valign=bottom><b>classdef</b></td></tr> +<tr><td nowrap align=right valign=top><a name="r1" doxytag="VerseKey::offsets"></a> +long* </td><td valign=bottom><b>offsets</b> [2][2]</td></tr> +<tr><td nowrap align=right valign=top><a name="r2" doxytag="VerseKey::offsize"></a> +int </td><td valign=bottom><b>offsize</b> [2][2]</td></tr> +<tr><td nowrap align=right valign=top><a name="r3" doxytag="VerseKey::instance"></a> +int </td><td valign=bottom><a class="el" href="class_versekey.html#r3">instance</a></td></tr> +<tr><td> </td><td><font size=-1><em>number of instantiated VerseKey objects or derivitives.</em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="r4" doxytag="VerseKey::otbooks"></a> +struct sbook </td><td valign=bottom><b>otbooks</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r5" doxytag="VerseKey::ntbooks"></a> +struct sbook </td><td valign=bottom><b>ntbooks</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r6" doxytag="VerseKey::otbks"></a> +long </td><td valign=bottom><b>otbks</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r7" doxytag="VerseKey::otcps"></a> +long </td><td valign=bottom><b>otcps</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r8" doxytag="VerseKey::ntbks"></a> +long </td><td valign=bottom><b>ntbks</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r9" doxytag="VerseKey::ntcps"></a> +long </td><td valign=bottom><b>ntcps</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r10" doxytag="VerseKey::vm"></a> +int </td><td valign=bottom><b>vm</b> []</td></tr> +<tr><td nowrap align=right valign=top><a name="r11" doxytag="VerseKey::localeCache"></a> +LocaleCache </td><td valign=bottom><b>localeCache</b></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Class VerseKey The <a class="el" href="class_swkey.html">SWKey</a> implementation used for verse based modules like Bibles or commentaries. +<p> + +<p> +Definition at line <a class="el" href="versekey_h-source.html#l00066">66</a> of file <a class="el" href="versekey_h-source.html">versekey.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="VerseKey::VerseKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +VerseKey::VerseKey ( + </b></td> + <td valign="bottom"><b> +const char * <em>ikey</em> = 0 ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +VerseKey Constructor - initializes Instance of VerseKey. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +text key (will take various forms of 'BOOK CH:VS'. See <a class="el" href="class_versekey.html#c5">parse</a> for more detailed information) </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a1" doxytag="VerseKey::VerseKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +VerseKey::VerseKey ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="class_swkey.html">SWKey</a> * <em>ikey</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +VerseKey Constructor - initializes instance of VerseKey. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +base key (will take various forms of 'BOOK CH:VS'. See <a class="el" href="class_versekey.html#c5">parse</a> for more detailed information) </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a2" doxytag="VerseKey::VerseKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +VerseKey::VerseKey ( + </b></td> + <td valign="bottom"><b> +const char * <em>min</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +const char * <em>max</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +VerseKey Constructor - initializes instance of VerseKey with boundariess - see also <a class="el" href="class_versekey.html#a5">LowerBound</a> and <a class="el" href="class_versekey.html#a6">UpperBound</a>. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>min</em> + </td><td> +the lower boundary of the new VerseKey </td></tr> +<tr><td valign=top><em>max</em> + </td><td> +the upper boundary of the new VerseKey </td></tr> +</table> +</dl> </td> + </tr> +</table> +<a name="a3" doxytag="VerseKey::VerseKey"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +VerseKey::VerseKey ( + </b></td> + <td valign="bottom"><b> +VerseKey const & <em>k</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +VerseKey Copy Constructor - will create a new VerseKey based on an existing one. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>k</em> + </td><td> +the VerseKey to copy from </td></tr> +</table> +</dl> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a28" doxytag="VerseKey::AutoNormalize"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char VerseKey::AutoNormalize ( + </b></td> + <td valign="bottom"><b> +char <em>iautonorm</em> = MAXPOS (char) )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets flag that tells VerseKey to automatically normalize itself when modified. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iautonorm</em> + </td><td> +value which to set autonorm [MAXPOS(char)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of autonorm, if changed -> previous value of autonorm </dl> </td> + </tr> +</table> +<a name="a24" doxytag="VerseKey::Book"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char VerseKey::Book ( + </b></td> + <td valign="bottom"><b> +char <em>ibook</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets book. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ibook</em> + </td><td> +value which to set book [MAXPOS(char)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of book, if changed -> previous value of book </dl> </td> + </tr> +</table> +<a name="a20" doxytag="VerseKey::Book"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char VerseKey::Book ( + </b></td> + <td valign="bottom"><b> +) const<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets book. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +value of book </dl> </td> + </tr> +</table> +<a name="a25" doxytag="VerseKey::Chapter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int VerseKey::Chapter ( + </b></td> + <td valign="bottom"><b> +int <em>ichapter</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets chapter. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ichapter</em> + </td><td> +value which to set chapter [MAXPOS(int)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of chapter, if changed -> previous value of chapter </dl> </td> + </tr> +</table> +<a name="a21" doxytag="VerseKey::Chapter"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int VerseKey::Chapter ( + </b></td> + <td valign="bottom"><b> +) const<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets chapter. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +value of chapter </dl> </td> + </tr> +</table> +<a name="a29" doxytag="VerseKey::Headings"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char VerseKey::Headings ( + </b></td> + <td valign="bottom"><b> +char <em>iheadings</em> = MAXPOS (char) )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets flag that tells VerseKey to include chapter/book/testament/module headings. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iheadings</em> + </td><td> +value which to set headings [MAXPOS(char)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of headings, if changed -> previous value of headings </dl> </td> + </tr> +</table> +<a name="a32" doxytag="VerseKey::Index"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +long VerseKey::Index ( + </b></td> + <td valign="bottom"><b> +long <em>index</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets index based upon current verse. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iindex</em> + </td><td> +value to set index to </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +offset </dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html">SWKey</a>. </td> + </tr> +</table> +<a name="a31" doxytag="VerseKey::Index"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +long VerseKey::Index ( + </b></td> + <td valign="bottom"><b> +) const<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets index based upon current verse. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +offset </dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html#a16">SWKey</a>. </td> + </tr> +</table> +<a name="a7" doxytag="VerseKey::LowerBound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +VerseKey & VerseKey::LowerBound ( + </b></td> + <td valign="bottom"><b> +) const + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the lower boundary of this VerseKey. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +the lower boundary of this VerseKey </dl> </td> + </tr> +</table> +<a name="a5" doxytag="VerseKey::LowerBound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +VerseKey & VerseKey::LowerBound ( + </b></td> + <td valign="bottom"><b> +const char * <em>lb</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +sets the lower boundary for this VerseKey and returns the new boundary. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>lb</em> + </td><td> +the new lower boundary for this VerseKey </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +the lower boundary the key was set to </dl> </td> + </tr> +</table> +<a name="a27" doxytag="VerseKey::Normalize"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void VerseKey::Normalize ( + </b></td> + <td valign="bottom"><b> +char <em>autocheck</em> = 0 )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +checks limits and normalizes if necessary (e.g. +<p> +Matthew 29:47 = Mark 2:2). If last verse is exceeded, key is set to last Book CH:VS +<p> +<dl compact><dt> +<b>Returns: </b><dd> +*this </dl> </td> + </tr> +</table> +<a name="a23" doxytag="VerseKey::Testament"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char VerseKey::Testament ( + </b></td> + <td valign="bottom"><b> +char <em>itestament</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets testament. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>itestament</em> + </td><td> +value which to set testament [MAXPOS(char)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of testament, if changed -> previous value of testament </dl> </td> + </tr> +</table> +<a name="a19" doxytag="VerseKey::Testament"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +char VerseKey::Testament ( + </b></td> + <td valign="bottom"><b> +) const<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets testament. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +value of testament </dl> </td> + </tr> +</table> +<a name="a8" doxytag="VerseKey::UpperBound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +VerseKey & VerseKey::UpperBound ( + </b></td> + <td valign="bottom"><b> +) const + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +gets the upper boundary of this VerseKey. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +the upper boundary of this VerseKey </dl> </td> + </tr> +</table> +<a name="a6" doxytag="VerseKey::UpperBound"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +VerseKey & VerseKey::UpperBound ( + </b></td> + <td valign="bottom"><b> +const char * <em>ub</em> ) + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +sets the upper boundary for this VerseKey and returns the new boundary. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>lb</em> + </td><td> +the new upper boundary for this VerseKey </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +the upper boundary the key was set to </dl> </td> + </tr> +</table> +<a name="a26" doxytag="VerseKey::Verse"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int VerseKey::Verse ( + </b></td> + <td valign="bottom"><b> +int <em>iverse</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Sets/gets verse. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>iverse</em> + </td><td> +value which to set verse [MAXPOS(int)] - only get </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +if unchanged -> value of verse, if changed -> previous value of verse </dl> </td> + </tr> +</table> +<a name="a22" doxytag="VerseKey::Verse"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int VerseKey::Verse ( + </b></td> + <td valign="bottom"><b> +) const<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Gets verse. +<p> +<dl compact><dt> +<b>Returns: </b><dd> +value of verse </dl> </td> + </tr> +</table> +<a name="a35" doxytag="VerseKey::_compare"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int VerseKey::_compare ( + </b></td> + <td valign="bottom"><b> +const VerseKey & <em>ikey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compares another VerseKey object. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +key to compare with this one </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +>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 </dl> </td> + </tr> +</table> +<a name="a34" doxytag="VerseKey::compare"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int VerseKey::compare ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="class_swkey.html">SWKey</a> & <em>ikey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compares another <a class="el" href="class_swkey.html">SWKey</a> object. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +key to compare with this one </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +>0 if this VerseKey is greater than compare <a class="el" href="class_swkey.html">SWKey</a>, <0 if this VerseKey is smaller than compare <a class="el" href="class_swkey.html">SWKey</a>, 0 if the keys are the same </dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html#a10">SWKey</a>. </td> + </tr> +</table> +<a name="a13" doxytag="VerseKey::copyFrom"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +virtual void VerseKey::copyFrom ( + </b></td> + <td valign="bottom"><b> +const <a class="el" href="class_swkey.html">SWKey</a> & <em>ikey</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this <a class="el" href="class_swkey.html">SWKey</a> to another <a class="el" href="class_swkey.html">SWKey</a> object. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +other swkey object </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html#a8">SWKey</a>. </td> + </tr> +</table> +<a name="a16" doxytag="VerseKey::decrement"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void VerseKey::decrement ( + </b></td> + <td valign="bottom"><b> +int <em>step</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Decrements key a number of verses. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>decrement</em> + </td><td> +Number of verses to jump backward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html#a13">SWKey</a>. </td> + </tr> +</table> +<a name="c6" doxytag="VerseKey::findindex"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +int VerseKey::findindex ( + </b></td> + <td valign="bottom"><b> +long * <em>array</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +int <em>size</em>, + </b></td> + </tr> + <tr> + <td></td> + <td><b> +long <em>value</em> )<code> [private]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Binary search to find the index closest, but less than the given value. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>array</em> + </td><td> +long * to array to search </td></tr> +<tr><td valign=top><em>size</em> + </td><td> +number of elements in the array </td></tr> +<tr><td valign=top><em>value</em> + </td><td> +value to find </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +the index into the array that is less than but closest to value </dl> </td> + </tr> +</table> +<a name="a17" doxytag="VerseKey::increment"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void VerseKey::increment ( + </b></td> + <td valign="bottom"><b> +int <em>step</em> )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Increments key a number of verses. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>increment</em> + </td><td> +Number of verses to jump forward </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html#a14">SWKey</a>. </td> + </tr> +</table> +<a name="a15" doxytag="VerseKey::setPosition"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void VerseKey::setPosition ( + </b></td> + <td valign="bottom"><b> +SW_POSITION )<code> [virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Positions this key. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>p</em> + </td><td> +position </td></tr> +</table> +</dl><dl compact><dt> +<b>Returns: </b><dd> +*this </dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html">SWKey</a>. </td> + </tr> +</table> +<a name="a12" doxytag="VerseKey::setText"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td nowrap valign="top"><b> +void VerseKey::setText ( + </b></td> + <td valign="bottom"><b> +const char * <em>ikey</em> )<code> [inline, virtual]</code> + </b></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Equates this <a class="el" href="class_swkey.html">SWKey</a> to a character string. +<p> +<dl compact><dt> +<b>Parameters: </b><dd> +<table border=0 cellspacing=2 cellpadding=0> +<tr><td valign=top><em>ikey</em> + </td><td> +string to set this key to </td></tr> +</table> +</dl> +<p> +Reimplemented from <a class="el" href="class_swkey.html#a7">SWKey</a>. +<p> +Definition at line <a class="el" href="versekey_h-source.html#l00228">228</a> of file <a class="el" href="versekey_h-source.html">versekey.h</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="versekey_h-source.html">versekey.h</a></ul> +<hr><address><small>Generated at Fri Oct 5 22:45:38 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/classes.html b/doc/api-documentation/html/classes.html new file mode 100644 index 0000000..ebc30f5 --- /dev/null +++ b/doc/api-documentation/html/classes.html @@ -0,0 +1,31 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Alphabetical index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>The Sword Project Compound Index</h1><table align=center width="95%" border="0" cellspacing="0" cellpadding="0"> +<tr><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> E </td</tr></table></td><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> L </td</tr></table></td><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> S </td</tr></table></td><td><a class="el" href="class_s_w_text.html">SWText</a> </td><td><a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a> </td></tr> +<tr><td><a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a> </td><td><a class="el" href="class_latin1_u_t_f16.html">Latin1UTF16</a> </td><td><a class="el" href="class_s_c_s_u_u_t_f8.html">SCSUUTF8</a> </td><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> T </td</tr></table></td><td><a class="el" href="class_th_m_l_variants.html">ThMLVariants</a> </td></tr> +<tr><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> G </td</tr></table></td><td><a class="el" href="class_latin1_u_t_f8.html">Latin1UTF8</a> </td><td><a class="el" href="class_str_key.html">StrKey</a> </td><td><a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a> </td><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> U </td</tr></table></td></tr> +<tr><td><a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a> </td><td><a class="el" href="class_list_key.html">ListKey</a> </td><td><a class="el" href="class_s_w_class.html">SWClass</a> </td><td><a class="el" href="class_th_m_l_g_b_f.html">ThMLGBF</a> </td><td><a class="el" href="class_unicode_r_t_f.html">UnicodeRTF</a> </td></tr> +<tr><td><a class="el" href="class_g_b_f_headings.html">GBFHeadings</a> </td><td><a class="el" href="class_locale_mgr.html">LocaleMgr</a> </td><td><a class="el" href="class_s_w_com.html">SWCom</a> </td><td><a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a> </td><td><a class="el" href="class_u_t_f16_u_t_f8.html">UTF16UTF8</a> </td></tr> +<tr><td><a class="el" href="class_g_b_f_h_t_m_l.html">GBFHTML</a> </td><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> M </td</tr></table></td><td><a class="el" href="class_s_w_config.html">SWConfig</a> </td><td><a class="el" href="class_th_m_l_h_t_m_l.html">ThMLHTML</a> </td><td><a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a> </td></tr> +<tr><td><a class="el" href="class_g_b_f_h_t_m_l_h_r_e_f.html">GBFHTMLHREF</a> </td><td><a class="el" href="class_markup_filter_mgr.html">MarkupFilterMgr</a> </td><td><a class="el" href="class_s_w_display.html">SWDisplay</a> </td><td><a class="el" href="class_th_m_l_h_t_m_l_h_r_e_f.html">ThMLHTMLHREF</a> </td><td><a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a> </td></tr> +<tr><td><a class="el" href="class_g_b_f_morph.html">GBFMorph</a> </td><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> P </td</tr></table></td><td><a class="el" href="class_s_w_input_method.html">SWInputMethod</a> </td><td><a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a> </td><td><a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a> </td></tr> +<tr><td><a class="el" href="class_g_b_f_plain.html">GBFPlain</a> </td><td><a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a> </td><td><a class="el" href="class_s_w_key.html">SWKey</a> </td><td><a class="el" href="class_th_m_l_morph.html">ThMLMorph</a> </td><td><a class="el" href="class_u_t_f8_h_t_m_l.html">UTF8HTML</a> </td></tr> +<tr><td><a class="el" href="class_g_b_f_r_t_f.html">GBFRTF</a> </td><td><a class="el" href="class_p_l_a_i_n_h_t_m_l.html">PLAINHTML</a> </td><td><a class="el" href="class_s_w_l_d.html">SWLD</a> </td><td><a class="el" href="class_th_m_l_o_l_b.html">ThMLOLB</a> </td><td><a class="el" href="class_u_t_f8_latin1.html">UTF8Latin1</a> </td></tr> +<tr><td><a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a> </td><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> R </td</tr></table></td><td><a class="el" href="class_s_w_locale.html">SWLocale</a> </td><td><a class="el" href="class_th_m_l_plain.html">ThMLPlain</a> </td><td><a class="el" href="class_u_t_f8_u_t_f16.html">UTF8UTF16</a> </td></tr> +<tr><td><a class="el" href="class_g_b_f_th_m_l.html">GBFThML</a> </td><td><a class="el" href="class_r_t_f_h_t_m_l.html">RTFHTML</a> </td><td><a class="el" href="class_s_w_mgr.html">SWMgr</a> </td><td><a class="el" href="class_th_m_l_r_t_f.html">ThMLRTF</a> </td><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> V </td</tr></table></td></tr> +<tr><td><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> H </td</tr></table></td><td><a class="el" href="class_r_w_p_h_t_m_l.html">RWPHTML</a> </td><td><a class="el" href="class_s_w_module.html">SWModule</a> </td><td><a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a> </td><td><a class="el" href="class_verse_key.html">VerseKey</a> </td></tr> +<tr><td><a class="el" href="class_hebrew_m_c_i_m.html">HebrewMCIM</a> </td><td><a class="el" href="class_r_w_p_r_t_f.html">RWPRTF</a> </td><td><a class="el" href="class_s_w_object.html">SWObject</a> </td></tr> +</table> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/defs.h-source.html b/doc/api-documentation/html/defs.h-source.html new file mode 100644 index 0000000..3f48690 --- /dev/null +++ b/doc/api-documentation/html/defs.h-source.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>defs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:24 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>defs.h</h1><div class="fragment"><pre>00001 <font class="comment">// ----------------------------------------------------------------------------</font> +00002 <font class="comment">// Making or using sword as a Windows DLL</font> +00003 <font class="comment">// ----------------------------------------------------------------------------</font> +00004 +00005 <font class="preprocessor">#if defined(__SWMSW__) +</font>00006 <font class="preprocessor"></font> +00007 <font class="comment">// _declspec works in BC++ 5 and later, as well as VC++</font> +00008 <font class="preprocessor">#if defined(__VISUALC__) +</font>00009 <font class="preprocessor"></font> +00010 <font class="preprocessor"># ifdef SWMAKINGDLL +</font>00011 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _declspec( dllexport ) +</font>00012 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _declspec( dllexport ) type +</font>00013 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00014 <font class="preprocessor"></font><font class="preprocessor"># elif defined(SWUSINGDLL) +</font>00015 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _declspec( dllimport ) +</font>00016 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _declspec( dllimport ) type +</font>00017 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00018 <font class="preprocessor"></font><font class="preprocessor"># else +</font>00019 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT +</font>00020 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type +</font>00021 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00022 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#elif defined(__SWPM__) +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor"># ifdef SWMAKINGDLL +</font>00027 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _Export +</font>00028 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _Export type +</font>00029 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00030 <font class="preprocessor"></font><font class="preprocessor"># elif defined(SWUSINGDLL) +</font>00031 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _Export +</font>00032 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _Export type +</font>00033 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00034 <font class="preprocessor"></font><font class="preprocessor"># else +</font>00035 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT +</font>00036 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type +</font>00037 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00038 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00039 <font class="preprocessor"></font> +00040 <font class="preprocessor">#elif defined(__GNUWIN32__) || defined(__BORLANDC__) +</font>00041 <font class="preprocessor"></font> +00042 <font class="preprocessor"># ifdef SWMAKINGDLL +</font>00043 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT __declspec( dllexport ) +</font>00044 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) __declspec( dllexport ) type +</font>00045 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00046 <font class="preprocessor"></font><font class="preprocessor"># elif defined(SWUSINGDLL) +</font>00047 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT __declspec( dllimport ) +</font>00048 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) __declspec( dllimport ) type +</font>00049 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00050 <font class="preprocessor"></font><font class="preprocessor"># else +</font>00051 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT +</font>00052 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type +</font>00053 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00054 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00055 <font class="preprocessor"></font> +00056 +00057 <font class="preprocessor">#else +</font>00058 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT +</font>00059 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type +</font>00060 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00061 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00062 <font class="preprocessor"></font> +00063 <font class="preprocessor">#else // !Windows +</font>00064 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT +</font>00065 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type +</font>00066 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN +</font>00067 <font class="preprocessor"></font><font class="preprocessor">#endif // Win/!Win +</font>00068 <font class="preprocessor"></font> +00069 <font class="comment">// For ostream, istream ofstream</font> +00070 <font class="preprocessor">#if defined(__BORLANDC__) && defined( _RTLDLL ) +</font>00071 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLIMPORT __import +</font>00072 <font class="preprocessor"></font><font class="preprocessor">#else +</font>00073 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLIMPORT +</font>00074 <font class="preprocessor"></font><font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:24 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/defs_8h-source.html b/doc/api-documentation/html/defs_8h-source.html new file mode 100644 index 0000000..2085518 --- /dev/null +++ b/doc/api-documentation/html/defs_8h-source.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>defs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>defs.h</h1><div class="fragment"><pre>00001 <font class="comment">// ----------------------------------------------------------------------------</font> +00002 <font class="comment">// Making or using sword as a Windows DLL</font> +00003 <font class="comment">// ----------------------------------------------------------------------------</font> +00004 +00005 <font class="preprocessor">#if defined(__SWMSW__)</font> +00006 <font class="preprocessor"></font> +00007 <font class="comment">// _declspec works in BC++ 5 and later, as well as VC++</font> +00008 <font class="preprocessor">#if defined(_MSC_VER)</font> +00009 <font class="preprocessor"></font> +00010 <font class="preprocessor"># ifdef SWMAKINGDLL</font> +00011 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _declspec( dllexport )</font> +00012 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _declspec( dllexport ) type</font> +00013 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00014 <font class="preprocessor"></font><font class="preprocessor"># elif defined(SWUSINGDLL)</font> +00015 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _declspec( dllimport )</font> +00016 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _declspec( dllimport ) type</font> +00017 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00018 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00019 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT</font> +00020 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type</font> +00021 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00022 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#elif defined(__SWPM__)</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor"># ifdef SWMAKINGDLL</font> +00027 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _Export</font> +00028 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _Export type</font> +00029 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00030 <font class="preprocessor"></font><font class="preprocessor"># elif defined(SWUSINGDLL)</font> +00031 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _Export</font> +00032 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _Export type</font> +00033 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00034 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00035 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT</font> +00036 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type</font> +00037 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00038 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00039 <font class="preprocessor"></font> +00040 <font class="preprocessor">#elif defined(__GNUWIN32__) || defined(__BORLANDC__)</font> +00041 <font class="preprocessor"></font> +00042 <font class="preprocessor"># ifdef SWMAKINGDLL</font> +00043 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT __declspec( dllexport )</font> +00044 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) __declspec( dllexport ) type</font> +00045 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00046 <font class="preprocessor"></font><font class="preprocessor"># elif defined(SWUSINGDLL)</font> +00047 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT __declspec( dllimport )</font> +00048 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) __declspec( dllimport ) type</font> +00049 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00050 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00051 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT</font> +00052 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type</font> +00053 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00054 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00055 <font class="preprocessor"></font> +00056 +00057 <font class="preprocessor">#else</font> +00058 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT</font> +00059 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type</font> +00060 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00061 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00062 <font class="preprocessor"></font> +00063 <font class="preprocessor">#else // !Windows</font> +00064 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT</font> +00065 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type</font> +00066 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00067 <font class="preprocessor"></font><font class="preprocessor">#endif // Win/!Win</font> +00068 <font class="preprocessor"></font> +00069 <font class="comment">// For ostream, istream ofstream</font> +00070 <font class="preprocessor">#if defined(__BORLANDC__) && defined( _RTLDLL )</font> +00071 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLIMPORT __import</font> +00072 <font class="preprocessor"></font><font class="preprocessor">#else</font> +00073 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLIMPORT</font> +00074 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/defs_h-source.html b/doc/api-documentation/html/defs_h-source.html new file mode 100644 index 0000000..9402b70 --- /dev/null +++ b/doc/api-documentation/html/defs_h-source.html @@ -0,0 +1,90 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>defs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>defs.h</h1><div class="fragment"><pre>00001 <font class="comment">// ----------------------------------------------------------------------------</font> +00002 <font class="comment">// Making or using sword as a Windows DLL</font> +00003 <font class="comment">// ----------------------------------------------------------------------------</font> +00004 +00005 <font class="preprocessor">#if defined(__SWMSW__)</font> +00006 <font class="preprocessor"></font> +00007 <font class="comment">// _declspec works in BC++ 5 and later, as well as VC++</font> +00008 <font class="preprocessor">#if defined(__VISUALC__)</font> +00009 <font class="preprocessor"></font> +00010 <font class="preprocessor"># ifdef SWMAKINGDLL</font> +00011 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _declspec( dllexport )</font> +00012 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _declspec( dllexport ) type</font> +00013 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00014 <font class="preprocessor"></font><font class="preprocessor"># elif defined(SWUSINGDLL)</font> +00015 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _declspec( dllimport )</font> +00016 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _declspec( dllimport ) type</font> +00017 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00018 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00019 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT</font> +00020 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type</font> +00021 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00022 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#elif defined(__SWPM__)</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor"># ifdef SWMAKINGDLL</font> +00027 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _Export</font> +00028 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _Export type</font> +00029 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00030 <font class="preprocessor"></font><font class="preprocessor"># elif defined(SWUSINGDLL)</font> +00031 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT _Export</font> +00032 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) _Export type</font> +00033 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00034 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00035 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT</font> +00036 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type</font> +00037 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00038 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00039 <font class="preprocessor"></font> +00040 <font class="preprocessor">#elif defined(__GNUWIN32__) || defined(__BORLANDC__)</font> +00041 <font class="preprocessor"></font> +00042 <font class="preprocessor"># ifdef SWMAKINGDLL</font> +00043 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT __declspec( dllexport )</font> +00044 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) __declspec( dllexport ) type</font> +00045 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00046 <font class="preprocessor"></font><font class="preprocessor"># elif defined(SWUSINGDLL)</font> +00047 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT __declspec( dllimport )</font> +00048 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) __declspec( dllimport ) type</font> +00049 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00050 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00051 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT</font> +00052 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type</font> +00053 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00054 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00055 <font class="preprocessor"></font> +00056 +00057 <font class="preprocessor">#else</font> +00058 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT</font> +00059 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type</font> +00060 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00061 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00062 <font class="preprocessor"></font> +00063 <font class="preprocessor">#else // !Windows</font> +00064 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT</font> +00065 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_DATA(type) type</font> +00066 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLEXPORT_CTORFN</font> +00067 <font class="preprocessor"></font><font class="preprocessor">#endif // Win/!Win</font> +00068 <font class="preprocessor"></font> +00069 <font class="comment">// For ostream, istream ofstream</font> +00070 <font class="preprocessor">#if defined(__BORLANDC__) && defined( _RTLDLL )</font> +00071 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLIMPORT __import</font> +00072 <font class="preprocessor"></font><font class="preprocessor">#else</font> +00073 <font class="preprocessor"></font><font class="preprocessor"># define SWDLLIMPORT</font> +00074 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/doxygen.css b/doc/api-documentation/html/doxygen.css new file mode 100644 index 0000000..aee2f34 --- /dev/null +++ b/doc/api-documentation/html/doxygen.css @@ -0,0 +1,22 @@ +H1 { text-align: center; } +A.qindex {} +A.qindexRef {} +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } +A:hover { text-decoration: none; background-color: #f2f2ff } +DL.el { margin-left: -1cm } +DIV.fragment { width: 100%; border: none; background-color: #eeeeee } +DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: #f2f2ff; font-weight: bold; } +TD.mdname { background-color: #f2f2ff; font-weight: bold; font-style: italic } +DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold } +DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller } +FONT.keyword { color: #008000 } +FONT.keywordtype { color: #604020 } +FONT.keywordflow { color: #e08000 } +FONT.comment { color: #800000 } +FONT.preprocessor { color: #806020 } +FONT.stringliteral { color: #002080 } +FONT.charliteral { color: #008080 } diff --git a/doc/api-documentation/html/doxygen.gif b/doc/api-documentation/html/doxygen.gif Binary files differnew file mode 100644 index 0000000..192c83c --- /dev/null +++ b/doc/api-documentation/html/doxygen.gif diff --git a/doc/api-documentation/html/echomod.h-source.html b/doc/api-documentation/html/echomod.h-source.html new file mode 100644 index 0000000..59683f9 --- /dev/null +++ b/doc/api-documentation/html/echomod.h-source.html @@ -0,0 +1,53 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>echomod.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:24 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>echomod.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * echomod.h - code for class 'EchoMod' - a test module that just echo back +</font>00003 <font class="comment"> * text of key. +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: echomod.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef ECHOMOD_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define ECHOMOD_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swtext.h></font> +00027 <font class="preprocessor">#include <versekey.h></font> +00028 +00029 <font class="keyword">class </font>EchoMod:<font class="keyword">public</font> <a class="code" href="class_swtext.html">SWText</a> +00030 { +00031 <font class="keyword">public</font>: +00032 EchoMod (); +00033 <font class="keyword">virtual</font> ~ EchoMod (); +00034 <font class="keyword">virtual</font> operator const char *(); +00035 }; +00036 +00037 +00038 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:24 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/echomod_8h-source.html b/doc/api-documentation/html/echomod_8h-source.html new file mode 100644 index 0000000..c7da403 --- /dev/null +++ b/doc/api-documentation/html/echomod_8h-source.html @@ -0,0 +1,53 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>echomod.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>echomod.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * echomod.h - code for class 'EchoMod' - a test module that just echo back</font> +00003 <font class="comment"> * text of key.</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: echomod_8h-source.html,v 1.4 2002/01/22 14:20:27 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef ECHOMOD_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define ECHOMOD_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swtext.h></font> +00027 <font class="preprocessor">#include <versekey.h></font> +00028 +00029 <font class="keyword">class </font>EchoMod:<font class="keyword">public</font> <a class="code" href="class_s_w_text.html">SWText</a> +00030 { +00031 <font class="keyword">public</font>: +00032 EchoMod (); +00033 <font class="keyword">virtual</font> ~ EchoMod (); +00034 <font class="keyword">virtual</font> operator const char *(); +00035 }; +00036 +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/echomod_h-source.html b/doc/api-documentation/html/echomod_h-source.html new file mode 100644 index 0000000..c2c5e8d --- /dev/null +++ b/doc/api-documentation/html/echomod_h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>echomod.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>echomod.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * echomod.h - code for class 'EchoMod' - a test module that just echo back</font> +00003 <font class="comment"> * text of key.</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: echomod_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef ECHOMOD_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define ECHOMOD_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swtext.h></font> +00027 <font class="preprocessor">#include <versekey.h></font> +00028 +00029 <font class="keyword">class </font>EchoMod:<font class="keyword">public</font> <a class="code" href="class_swtext.html">SWText</a> +00030 { +00031 <font class="keyword">public</font>: +00032 EchoMod (); +00033 <font class="keyword">virtual</font> ~ EchoMod (); +00034 <font class="keyword">virtual</font> operator const char *(); +00035 }; +00036 +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/encfiltmgr_8h-source.html b/doc/api-documentation/html/encfiltmgr_8h-source.html new file mode 100644 index 0000000..67c6553 --- /dev/null +++ b/doc/api-documentation/html/encfiltmgr_8h-source.html @@ -0,0 +1,70 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>encfiltmgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>encfiltmgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swencodingmgr.h - definition of class SWEncodingMgr, subclass of</font> +00003 <font class="comment"> * used to transcode all module text to a requested</font> +00004 <font class="comment"> * markup.</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef ENCFILTERMGR_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define ENCFILTERMGR_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swfiltermgr.h></font> +00026 +00027 +<a name="l00033"></a><a class="code" href="class_encoding_filter_mgr.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a> : <font class="keyword">public</font> SWFilterMgr { +00034 +00035 <font class="keyword">protected</font>: +00036 SWFilter *latin1utf8; +00037 SWFilter *scsuutf8; +00038 SWFilter *targetenc; +00039 +00040 +00041 <font class="comment">/*</font> +00042 <font class="comment"> * current encoding value</font> +00043 <font class="comment"> */</font> +00044 <font class="keywordtype">char</font> encoding; +00045 +00046 <font class="keyword">public</font>: +00047 +00048 +00056 <a class="code" href="class_encoding_filter_mgr.html#a0">EncodingFilterMgr</a> (<font class="keywordtype">char</font> encoding = ENC_UTF8); +00057 +00061 <a class="code" href="class_encoding_filter_mgr.html#a1">~EncodingFilterMgr</a>(); +00062 +00068 <font class="keywordtype">char</font> <a class="code" href="class_encoding_filter_mgr.html#a2">Encoding</a>(<font class="keywordtype">char</font> enc); +00069 +00075 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_encoding_filter_mgr.html#a3">AddRawFilters</a>(<a class="code" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section); +00076 +00082 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_encoding_filter_mgr.html#a4">AddEncodingFilters</a>(<a class="code" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section); +00083 }; +00084 +00085 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/entriesblk.h-source.html b/doc/api-documentation/html/entriesblk.h-source.html new file mode 100644 index 0000000..1021077 --- /dev/null +++ b/doc/api-documentation/html/entriesblk.h-source.html @@ -0,0 +1,39 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>entriesblk.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:24 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>entriesblk.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef ENTRIESBLK_H +</font>00002 <font class="preprocessor"></font><font class="preprocessor">#define ENTRIESBLK_H +</font>00003 <font class="preprocessor"></font> +00004 <font class="keyword">class </font>EntriesBlock { +00005 <font class="keyword">private</font>: +00006 <font class="keywordtype">char</font> *block; +00007 <font class="keywordtype">void</font> setCount(<font class="keywordtype">int</font> count); +00008 <font class="keywordtype">void</font> getMetaEntry(<font class="keywordtype">int</font> index, <font class="keywordtype">long</font> *offset, <font class="keywordtype">short</font> *size); +00009 <font class="keywordtype">void</font> setMetaEntry(<font class="keywordtype">int</font> index, <font class="keywordtype">long</font> offset, <font class="keywordtype">short</font> size); +00010 +00011 <font class="keyword">public</font>: +00012 EntriesBlock(<font class="keyword">const</font> <font class="keywordtype">char</font> *iBlock, <font class="keywordtype">long</font> size); +00013 EntriesBlock(); +00014 ~EntriesBlock(); +00015 +00016 <font class="keywordtype">int</font> getCount(); +00017 <font class="keywordtype">int</font> addEntry(<font class="keyword">const</font> <font class="keywordtype">char</font> *entry); +00018 <font class="keyword">const</font> <font class="keywordtype">char</font> *getEntry(<font class="keywordtype">int</font> entryIndex); +00019 <font class="keywordtype">void</font> removeEntry(<font class="keywordtype">int</font> entryIndex); +00020 <font class="keyword">const</font> <font class="keywordtype">char</font> *getRawData(<font class="keywordtype">long</font> *size); +00021 }; +00022 +00023 +00024 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/entriesblk_8h-source.html b/doc/api-documentation/html/entriesblk_8h-source.html new file mode 100644 index 0000000..433e600 --- /dev/null +++ b/doc/api-documentation/html/entriesblk_8h-source.html @@ -0,0 +1,45 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>entriesblk.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>entriesblk.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef ENTRIESBLK_H</font> +00002 <font class="preprocessor"></font><font class="preprocessor">#define ENTRIESBLK_H</font> +00003 <font class="preprocessor"></font> +00004 <font class="preprocessor">#include <sysdata.h></font> +00005 +00006 <font class="keyword">class </font>EntriesBlock { +00007 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">int</font> METAHEADERSIZE; +00008 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">int</font> METAENTRYSIZE; +00009 +00010 <font class="keyword">private</font>: +00011 <font class="keywordtype">char</font> *block; +00012 <font class="keywordtype">void</font> setCount(<font class="keywordtype">int</font> count); +00013 <font class="keywordtype">void</font> getMetaEntry(<font class="keywordtype">int</font> index, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> *offset, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> *size); +00014 <font class="keywordtype">void</font> setMetaEntry(<font class="keywordtype">int</font> index, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> offset, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> size); +00015 +00016 <font class="keyword">public</font>: +00017 EntriesBlock(<font class="keyword">const</font> <font class="keywordtype">char</font> *iBlock, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> size); +00018 EntriesBlock(); +00019 ~EntriesBlock(); +00020 +00021 <font class="keywordtype">int</font> getCount(); +00022 <font class="keywordtype">int</font> addEntry(<font class="keyword">const</font> <font class="keywordtype">char</font> *entry); +00023 <font class="keyword">const</font> <font class="keywordtype">char</font> *getEntry(<font class="keywordtype">int</font> entryIndex); +00024 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> getEntrySize(<font class="keywordtype">int</font> entryIndex); +00025 <font class="keywordtype">void</font> removeEntry(<font class="keywordtype">int</font> entryIndex); +00026 <font class="keyword">const</font> <font class="keywordtype">char</font> *getRawData(<font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> *size); +00027 }; +00028 +00029 +00030 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/entriesblk_h-source.html b/doc/api-documentation/html/entriesblk_h-source.html new file mode 100644 index 0000000..8c7b6cc --- /dev/null +++ b/doc/api-documentation/html/entriesblk_h-source.html @@ -0,0 +1,40 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>entriesblk.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>entriesblk.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef ENTRIESBLK_H</font> +00002 <font class="preprocessor"></font><font class="preprocessor">#define ENTRIESBLK_H</font> +00003 <font class="preprocessor"></font> +00004 <font class="keyword">class </font>EntriesBlock { +00005 <font class="keyword">private</font>: +00006 <font class="keywordtype">char</font> *block; +00007 <font class="keywordtype">void</font> setCount(<font class="keywordtype">int</font> count); +00008 <font class="keywordtype">void</font> getMetaEntry(<font class="keywordtype">int</font> index, <font class="keywordtype">long</font> *offset, <font class="keywordtype">short</font> *size); +00009 <font class="keywordtype">void</font> setMetaEntry(<font class="keywordtype">int</font> index, <font class="keywordtype">long</font> offset, <font class="keywordtype">short</font> size); +00010 +00011 <font class="keyword">public</font>: +00012 EntriesBlock(<font class="keyword">const</font> <font class="keywordtype">char</font> *iBlock, <font class="keywordtype">long</font> size); +00013 EntriesBlock(); +00014 ~EntriesBlock(); +00015 +00016 <font class="keywordtype">int</font> getCount(); +00017 <font class="keywordtype">int</font> addEntry(<font class="keyword">const</font> <font class="keywordtype">char</font> *entry); +00018 <font class="keyword">const</font> <font class="keywordtype">char</font> *getEntry(<font class="keywordtype">int</font> entryIndex); +00019 <font class="keywordtype">void</font> removeEntry(<font class="keywordtype">int</font> entryIndex); +00020 <font class="keyword">const</font> <font class="keywordtype">char</font> *getRawData(<font class="keywordtype">long</font> *size); +00021 }; +00022 +00023 +00024 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/femain.h-source.html b/doc/api-documentation/html/femain.h-source.html new file mode 100644 index 0000000..b7f44b3 --- /dev/null +++ b/doc/api-documentation/html/femain.h-source.html @@ -0,0 +1,47 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>femain.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>femain.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * $Id: femain.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef FEMAIN_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define FEMAIN_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="keyword">class </font>FEMain +00025 { +00026 <font class="keyword">public</font>: +00027 FEMain (); +00028 <font class="keyword">virtual</font> ~FEMain (); +00029 list < SWDisplay * >displays; <font class="comment">// so we can delete each display we create</font> +00030 }; +00031 +00032 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/femain_8h-source.html b/doc/api-documentation/html/femain_8h-source.html new file mode 100644 index 0000000..91a8c62 --- /dev/null +++ b/doc/api-documentation/html/femain_8h-source.html @@ -0,0 +1,47 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>femain.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>femain.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: femain_8h-source.html,v 1.4 2002/01/22 14:20:27 jansorg Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef FEMAIN_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define FEMAIN_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="keyword">class </font>FEMain +00025 { +00026 <font class="keyword">public</font>: +00027 FEMain (); +00028 <font class="keyword">virtual</font> ~FEMain (); +00029 list < SWDisplay * >displays; <font class="comment">// so we can delete each display we create</font> +00030 }; +00031 +00032 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/femain_h-source.html b/doc/api-documentation/html/femain_h-source.html new file mode 100644 index 0000000..a02250e --- /dev/null +++ b/doc/api-documentation/html/femain_h-source.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>femain.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>femain.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: femain_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef FEMAIN_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define FEMAIN_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="keyword">class </font>FEMain +00025 { +00026 <font class="keyword">public</font>: +00027 FEMain (); +00028 <font class="keyword">virtual</font> ~FEMain (); +00029 list < SWDisplay * >displays; <font class="comment">// so we can delete each display we create</font> +00030 }; +00031 +00032 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/filemgr.h-source.html b/doc/api-documentation/html/filemgr.h-source.html new file mode 100644 index 0000000..4c574d6 --- /dev/null +++ b/doc/api-documentation/html/filemgr.h-source.html @@ -0,0 +1,94 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>filemgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>filemgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * filemgr.h - definition of class FileMgr used for pooling file handles +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: filemgr.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef FILEMGR_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define FILEMGR_H +</font>00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <sys/stat.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT FileMgr; +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT FileDesc +00032 { +00033 +00034 <font class="keyword">friend</font> <font class="keyword">class </font>FileMgr; +00035 +00036 <font class="keywordtype">char</font> *path; +00037 <font class="keywordtype">int</font> mode; +00038 <font class="keywordtype">int</font> perms; +00039 <font class="keywordtype">long</font> offset; +00040 <font class="keywordtype">int</font> fd; <font class="comment">// -77 closed;</font> +00041 FileMgr *parent; +00042 FileDesc *next; +00043 +00044 <font class="keyword">public</font>: +00045 FileDesc (FileMgr * parent, <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> mode, <font class="keywordtype">int</font> perms); +00046 <font class="keyword">virtual</font> ~FileDesc (); +00047 <font class="keywordtype">int</font> getFd (); +00048 }; +00049 +00050 +00051 <font class="keyword">class </font>FileMgr +00052 { +00053 +00054 <font class="keyword">friend</font> <font class="keyword">class </font>FileDesc; +00055 +00056 FileDesc *files; +00057 <font class="keywordtype">int</font> sysOpen (FileDesc * file); +00058 <font class="keyword">public</font>: +00059 +00060 FileMgr (<font class="keywordtype">int</font> maxFiles = 35); +00061 ~FileMgr (); +00062 FileDesc *open (<font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> mode, <font class="keywordtype">int</font> perms = S_IREAD | S_IWRITE); +00063 <font class="keywordtype">void</font> close (FileDesc *); +00064 +00065 <font class="keyword">static</font> <font class="keywordtype">char</font> existsFile (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *ifileName = 0); +00066 <font class="keyword">static</font> <font class="keywordtype">char</font> existsDir (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *idirName = 0); +00067 <font class="comment">// to truncate a file at its current position</font> +00068 <font class="comment">// leaving byte at current possition intact</font> +00069 <font class="comment">// deleting everything afterward.</font> +00070 <font class="keywordtype">char</font> trunc (FileDesc *); +00071 +00072 <font class="keywordtype">int</font> maxFiles; +00073 <font class="keyword">static</font> FileMgr systemFileMgr; +00074 }; +00075 +00076 +00077 +00078 +00079 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/filemgr_8h-source.html b/doc/api-documentation/html/filemgr_8h-source.html new file mode 100644 index 0000000..b7d3c3d --- /dev/null +++ b/doc/api-documentation/html/filemgr_8h-source.html @@ -0,0 +1,97 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>filemgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>filemgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * filemgr.h - definition of class FileMgr used for pooling file handles</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: filemgr_8h-source.html,v 1.4 2002/01/22 14:20:27 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef FILEMGR_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define FILEMGR_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <sys/stat.h></font> +00026 <font class="preprocessor">#ifdef BEOS</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#include <fcntl.h></font> +00028 <font class="preprocessor">#endif</font> +00029 <font class="preprocessor"></font> +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT FileMgr; +00033 +00034 <font class="keyword">class </font>SWDLLEXPORT FileDesc +00035 { +00036 +00037 <font class="keyword">friend</font> <font class="keyword">class </font>FileMgr; +00038 +00039 <font class="keywordtype">char</font> *path; +00040 <font class="keywordtype">int</font> mode; +00041 <font class="keywordtype">int</font> perms; +00042 <font class="keywordtype">long</font> offset; +00043 <font class="keywordtype">int</font> fd; <font class="comment">// -77 closed;</font> +00044 FileMgr *parent; +00045 FileDesc *next; +00046 +00047 <font class="keyword">public</font>: +00048 FileDesc (FileMgr * parent, <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> mode, <font class="keywordtype">int</font> perms); +00049 <font class="keyword">virtual</font> ~FileDesc (); +00050 <font class="keywordtype">int</font> getFd (); +00051 }; +00052 +00053 +00054 <font class="keyword">class </font>FileMgr +00055 { +00056 +00057 <font class="keyword">friend</font> <font class="keyword">class </font>FileDesc; +00058 +00059 FileDesc *files; +00060 <font class="keywordtype">int</font> sysOpen (FileDesc * file); +00061 <font class="keyword">public</font>: +00062 +00063 FileMgr (<font class="keywordtype">int</font> maxFiles = 35); +00064 ~FileMgr (); +00065 FileDesc *open (<font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> mode, <font class="keywordtype">int</font> perms = S_IREAD | S_IWRITE); +00066 <font class="keywordtype">void</font> close (FileDesc *); +00067 +00068 <font class="keyword">static</font> <font class="keywordtype">signed</font> <font class="keywordtype">char</font> existsFile (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *ifileName = 0); +00069 <font class="keyword">static</font> <font class="keywordtype">signed</font> <font class="keywordtype">char</font> existsDir (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *idirName = 0); +00070 <font class="comment">// to truncate a file at its current position</font> +00071 <font class="comment">// leaving byte at current possition intact</font> +00072 <font class="comment">// deleting everything afterward.</font> +00073 <font class="keywordtype">signed</font> <font class="keywordtype">char</font> trunc (FileDesc *); +00074 +00075 <font class="keywordtype">int</font> maxFiles; +00076 <font class="keyword">static</font> FileMgr systemFileMgr; +00077 }; +00078 +00079 +00080 +00081 +00082 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/filemgr_h-source.html b/doc/api-documentation/html/filemgr_h-source.html new file mode 100644 index 0000000..a03cc69 --- /dev/null +++ b/doc/api-documentation/html/filemgr_h-source.html @@ -0,0 +1,95 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>filemgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>filemgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * filemgr.h - definition of class FileMgr used for pooling file handles</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: filemgr_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef FILEMGR_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define FILEMGR_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <sys/stat.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT FileMgr; +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT FileDesc +00032 { +00033 +00034 <font class="keyword">friend</font> <font class="keyword">class </font>FileMgr; +00035 +00036 <font class="keywordtype">char</font> *path; +00037 <font class="keywordtype">int</font> mode; +00038 <font class="keywordtype">int</font> perms; +00039 <font class="keywordtype">long</font> offset; +00040 <font class="keywordtype">int</font> fd; <font class="comment">// -77 closed;</font> +00041 FileMgr *parent; +00042 FileDesc *next; +00043 +00044 <font class="keyword">public</font>: +00045 FileDesc (FileMgr * parent, <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> mode, <font class="keywordtype">int</font> perms); +00046 <font class="keyword">virtual</font> ~FileDesc (); +00047 <font class="keywordtype">int</font> getFd (); +00048 }; +00049 +00050 +00051 <font class="keyword">class </font>FileMgr +00052 { +00053 +00054 <font class="keyword">friend</font> <font class="keyword">class </font>FileDesc; +00055 +00056 FileDesc *files; +00057 <font class="keywordtype">int</font> sysOpen (FileDesc * file); +00058 <font class="keyword">public</font>: +00059 +00060 FileMgr (<font class="keywordtype">int</font> maxFiles = 35); +00061 ~FileMgr (); +00062 FileDesc *open (<font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> mode, <font class="keywordtype">int</font> perms = S_IREAD | S_IWRITE); +00063 <font class="keywordtype">void</font> close (FileDesc *); +00064 +00065 <font class="keyword">static</font> <font class="keywordtype">char</font> existsFile (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *ifileName = 0); +00066 <font class="keyword">static</font> <font class="keywordtype">char</font> existsDir (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *idirName = 0); +00067 <font class="comment">// to truncate a file at its current position</font> +00068 <font class="comment">// leaving byte at current possition intact</font> +00069 <font class="comment">// deleting everything afterward.</font> +00070 <font class="keywordtype">char</font> trunc (FileDesc *); +00071 +00072 <font class="keywordtype">int</font> maxFiles; +00073 <font class="keyword">static</font> FileMgr systemFileMgr; +00074 }; +00075 +00076 +00077 +00078 +00079 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/files.html b/doc/api-documentation/html/files.html new file mode 100644 index 0000000..b7eab8a --- /dev/null +++ b/doc/api-documentation/html/files.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>File Index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>The Sword Project File List</h1>Here is a list of all documented files with brief descriptions:<ul> +<li><b>cipherfil.h</b> <a href="cipherfil_8h-source.html">[code]</a><li><b>defs.h</b> <a href="defs_8h-source.html">[code]</a><li><b>echomod.h</b> <a href="echomod_8h-source.html">[code]</a><li><b>encfiltmgr.h</b> <a href="encfiltmgr_8h-source.html">[code]</a><li><b>entriesblk.h</b> <a href="entriesblk_8h-source.html">[code]</a><li><b>femain.h</b> <a href="femain_8h-source.html">[code]</a><li><b>filemgr.h</b> <a href="filemgr_8h-source.html">[code]</a><li><b>flatapi.h</b> <a href="flatapi_8h-source.html">[code]</a><li><b>gbffootnotes.h</b> <a href="gbffootnotes_8h-source.html">[code]</a><li><b>gbfheadings.h</b> <a href="gbfheadings_8h-source.html">[code]</a><li><b>gbfhtml.h</b> <a href="gbfhtml_8h-source.html">[code]</a><li><b>gbfhtmlhref.h</b> <a href="gbfhtmlhref_8h-source.html">[code]</a><li><b>gbfmorph.h</b> <a href="gbfmorph_8h-source.html">[code]</a><li><b>gbfplain.h</b> <a href="gbfplain_8h-source.html">[code]</a><li><b>gbfrtf.h</b> <a href="gbfrtf_8h-source.html">[code]</a><li><b>gbfstrongs.h</b> <a href="gbfstrongs_8h-source.html">[code]</a><li><b>gbfthml.h</b> <a href="gbfthml_8h-source.html">[code]</a><li><b>Greek2Greek.h</b> <a href="_greek2_greek_8h-source.html">[code]</a><li><b>GreekChars.h</b> <a href="_greek_chars_8h-source.html">[code]</a><li><b>hebrewmcim.h</b> <a href="hebrewmcim_8h-source.html">[code]</a><li><b>hrefcom.h</b> <a href="hrefcom_8h-source.html">[code]</a><li><b>latin1utf16.h</b> <a href="latin1utf16_8h-source.html">[code]</a><li><b>latin1utf8.h</b> <a href="latin1utf8_8h-source.html">[code]</a><li><b>listkey.h</b> <a href="listkey_8h-source.html">[code]</a><li><b>localemgr.h</b> <a href="localemgr_8h-source.html">[code]</a><li><b>lzsscomprs.h</b> <a href="lzsscomprs_8h-source.html">[code]</a><li><b>markupfiltmgr.h</b> <a href="markupfiltmgr_8h-source.html">[code]</a><li><b>nullim.h</b> <a href="nullim_8h-source.html">[code]</a><li><b>plainfootnotes.h</b> <a href="plainfootnotes_8h-source.html">[code]</a><li><b>plainhtml.h</b> <a href="plainhtml_8h-source.html">[code]</a><li><b>rawcom.h</b> <a href="rawcom_8h-source.html">[code]</a><li><b>rawfiles.h</b> <a href="rawfiles_8h-source.html">[code]</a><li><b>rawgbf.h</b> <a href="rawgbf_8h-source.html">[code]</a><li><b>rawld.h</b> <a href="rawld_8h-source.html">[code]</a><li><b>rawld4.h</b> <a href="rawld4_8h-source.html">[code]</a><li><b>rawstr.h</b> <a href="rawstr_8h-source.html">[code]</a><li><b>rawstr4.h</b> <a href="rawstr4_8h-source.html">[code]</a><li><b>rawtext.h</b> <a href="rawtext_8h-source.html">[code]</a><li><b>rawverse.h</b> <a href="rawverse_8h-source.html">[code]</a><li><b>regex.h</b> <a href="regex_8h-source.html">[code]</a><li><b>roman.h</b> <a href="roman_8h-source.html">[code]</a><li><b>rtfhtml.h</b> <a href="rtfhtml_8h-source.html">[code]</a><li><b>rwphtml.h</b> <a href="rwphtml_8h-source.html">[code]</a><li><b>rwprtf.h</b> <a href="rwprtf_8h-source.html">[code]</a><li><b>sapphire.h</b> <a href="sapphire_8h-source.html">[code]</a><li><b>scsuutf8.h</b> <a href="scsuutf8_8h-source.html">[code]</a><li><b>strkey.h</b> <a href="strkey_8h-source.html">[code]</a><li><b>swbasicfilter.h</b> <a href="swbasicfilter_8h-source.html">[code]</a><li><b>swbyteswap.h</b> <a href="swbyteswap_8h-source.html">[code]</a><li><b>swcipher.h</b> <a href="swcipher_8h-source.html">[code]</a><li><b>swcom.h</b> <a href="swcom_8h-source.html">[code]</a><li><b>swcomprs.h</b> <a href="swcomprs_8h-source.html">[code]</a><li><b>swconfig.h</b> <a href="swconfig_8h-source.html">[code]</a><li><b>swdisp.h</b> <a href="swdisp_8h-source.html">[code]</a><li><b>swdisprtf.h</b> <a href="swdisprtf_8h-source.html">[code]</a><li><b>swdisprtfchap.h</b> <a href="swdisprtfchap_8h-source.html">[code]</a><li><b>swfilter.h</b> <a href="swfilter_8h-source.html">[code]</a><li><b>swfiltermgr.h</b> <a href="swfiltermgr_8h-source.html">[code]</a><li><b>swinputmeth.h</b> <a href="swinputmeth_8h-source.html">[code]</a><li><b>swkey.h</b> <a href="swkey_8h-source.html">[code]</a><li><b>swld.h</b> <a href="swld_8h-source.html">[code]</a><li><b>swlocale.h</b> <a href="swlocale_8h-source.html">[code]</a><li><b>swlog.h</b> <a href="swlog_8h-source.html">[code]</a><li><b>swmacs.h</b> <a href="swmacs_8h-source.html">[code]</a><li><b>swmgr.h</b> <a href="swmgr_8h-source.html">[code]</a><li><b>swmodule.h</b> <a href="swmodule_8h-source.html">[code]</a><li><b>swobject.h</b> <a href="swobject_8h-source.html">[code]</a><li><b>swtext.h</b> <a href="swtext_8h-source.html">[code]</a><li><b>swunicod.h</b> <a href="swunicod_8h-source.html">[code]</a><li><b>swversion.h</b> <a href="swversion_8h-source.html">[code]</a><li><b>swwinlog.h</b> <a href="swwinlog_8h-source.html">[code]</a><li><b>sysdata.h</b> <a href="sysdata_8h-source.html">[code]</a><li><b>tbdisp.h</b> <a href="tbdisp_8h-source.html">[code]</a><li><b>thmlfootnotes.h</b> <a href="thmlfootnotes_8h-source.html">[code]</a><li><b>thmlgbf.h</b> <a href="thmlgbf_8h-source.html">[code]</a><li><b>thmlheadings.h</b> <a href="thmlheadings_8h-source.html">[code]</a><li><b>thmlhtml.h</b> <a href="thmlhtml_8h-source.html">[code]</a><li><b>thmlhtmlhref.h</b> <a href="thmlhtmlhref_8h-source.html">[code]</a><li><b>thmllemma.h</b> <a href="thmllemma_8h-source.html">[code]</a><li><b>thmlmorph.h</b> <a href="thmlmorph_8h-source.html">[code]</a><li><b>thmlolb.h</b> <a href="thmlolb_8h-source.html">[code]</a><li><b>thmlplain.h</b> <a href="thmlplain_8h-source.html">[code]</a><li><b>thmlrtf.h</b> <a href="thmlrtf_8h-source.html">[code]</a><li><b>thmlscripref.h</b> <a href="thmlscripref_8h-source.html">[code]</a><li><b>thmlstrongs.h</b> <a href="thmlstrongs_8h-source.html">[code]</a><li><b>thmlvariants.h</b> <a href="thmlvariants_8h-source.html">[code]</a><li><b>unicodertf.h</b> <a href="unicodertf_8h-source.html">[code]</a><li><b>unixstr.h</b> <a href="unixstr_8h-source.html">[code]</a><li><b>untgz.h</b> <a href="untgz_8h-source.html">[code]</a><li><b>utf16utf8.h</b> <a href="utf16utf8_8h-source.html">[code]</a><li><b>utf8arshaping.h</b> <a href="utf8arshaping_8h-source.html">[code]</a><li><b>utf8bidireorder.h</b> <a href="utf8bidireorder_8h-source.html">[code]</a><li><b>utf8cantillation.h</b> <a href="utf8cantillation_8h-source.html">[code]</a><li><b>utf8greekaccents.h</b> <a href="utf8greekaccents_8h-source.html">[code]</a><li><b>utf8hebrewpoints.h</b> <a href="utf8hebrewpoints_8h-source.html">[code]</a><li><b>utf8html.h</b> <a href="utf8html_8h-source.html">[code]</a><li><b>utf8latin1.h</b> <a href="utf8latin1_8h-source.html">[code]</a><li><b>utf8nfc.h</b> <a href="utf8nfc_8h-source.html">[code]</a><li><b>utf8nfkd.h</b> <a href="utf8nfkd_8h-source.html">[code]</a><li><b>utf8transliterator.h</b> <a href="utf8transliterator_8h-source.html">[code]</a><li><b>utf8utf16.h</b> <a href="utf8utf16_8h-source.html">[code]</a><li><b>utilconf.h</b> <a href="utilconf_8h-source.html">[code]</a><li><b>utilfuns.h</b> <a href="utilfuns_8h-source.html">[code]</a><li><b>utilstr.h</b> <a href="utilstr_8h-source.html">[code]</a><li><b>versekey.h</b> <a href="versekey_8h-source.html">[code]</a><li><b>zcom.h</b> <a href="zcom_8h-source.html">[code]</a><li><b>zconf.h</b> <a href="zconf_8h-source.html">[code]</a><li><b>zipcomprs.h</b> <a href="zipcomprs_8h-source.html">[code]</a><li><b>zld.h</b> <a href="zld_8h-source.html">[code]</a><li><b>zlib.h</b> <a href="zlib_8h-source.html">[code]</a><li><b>zstr.h</b> <a href="zstr_8h-source.html">[code]</a><li><b>ztext.h</b> <a href="ztext_8h-source.html">[code]</a><li><b>zverse.h</b> <a href="zverse_8h-source.html">[code]</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/frontend.html b/doc/api-documentation/html/frontend.html new file mode 100644 index 0000000..ab3f3e7 --- /dev/null +++ b/doc/api-documentation/html/frontend.html @@ -0,0 +1,21 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>How to write a frontend for the Sword library</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu Apr 19 16:40:35 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center> +<hr><a name="frontend"><h2>How to write a frontend for the Sword library</h2></a> + This page describes howto create a new frontend using the Sword library.<br> + We do only show how to write a very simple frontend, the GUI and more features have to be implemented with your own ideas.<br> + The programming language is C++, the toolkit is Qt 2.2 because I do only know Qt and it's available on Linux and Windows.<br> + +<p> +<hr><address><small>Generated at Thu Apr 19 16:40:35 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/functions.html b/doc/api-documentation/html/functions.html new file mode 100644 index 0000000..c8a6178 --- /dev/null +++ b/doc/api-documentation/html/functions.html @@ -0,0 +1,229 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Compound Member Index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>The Sword Project Compound Members</h1><center> +<a href="#index__">_</a> | <a href="#index_a">a</a> | <a href="#index_b">b</a> | <a href="#index_c">c</a> | <a href="#index_d">d</a> | <a href="#index_e">e</a> | <a href="#index_f">f</a> | <a href="#index_g">g</a> | <a href="#index_h">h</a> | <a href="#index_i">i</a> | <a href="#index_k">k</a> | <a href="#index_l">l</a> | <a href="#index_m">m</a> | <a href="#index_n">n</a> | <a href="#index_o">o</a> | <a href="#index_p">p</a> | <a href="#index_r">r</a> | <a href="#index_s">s</a> | <a href="#index_t">t</a> | <a href="#index_u">u</a> | <a href="#index_v">v</a> | <a href="#index_~">~</a></center> + +<p> +Here is a list of all documented class members with links to the classes they belong to:<a name="index__"><h3>- _ -</h3></a> +<ul> +<li>_compare() +: <a class="el" href="class_verse_key.html#a35">VerseKey</a></ul> +<a name="index_a"><h3>- a -</h3></a> +<ul> +<li>AddEncodingFilter() +: <a class="el" href="class_s_w_module.html#a42">SWModule</a><li>AddEncodingFilters() +: <a class="el" href="class_s_w_mgr.html#b8">SWMgr</a>, <a class="el" href="class_encoding_filter_mgr.html#a4">EncodingFilterMgr</a><li>AddOptionFilter() +: <a class="el" href="class_s_w_module.html#a51">SWModule</a><li>AddRawFilter() +: <a class="el" href="class_s_w_module.html#a48">SWModule</a><li>AddRawFilters() +: <a class="el" href="class_s_w_mgr.html#b11">SWMgr</a>, <a class="el" href="class_encoding_filter_mgr.html#a3">EncodingFilterMgr</a><li>AddRenderFilter() +: <a class="el" href="class_s_w_module.html#a38">SWModule</a><li>AddRenderFilters() +: <a class="el" href="class_s_w_mgr.html#b9">SWMgr</a>, <a class="el" href="class_markup_filter_mgr.html#a3">MarkupFilterMgr</a><li>AddStripFilter() +: <a class="el" href="class_s_w_module.html#a46">SWModule</a><li>AddStripFilters() +: <a class="el" href="class_s_w_mgr.html#b10">SWMgr</a><li>autonorm +: <a class="el" href="class_verse_key.html#o7">VerseKey</a><li>AutoNormalize() +: <a class="el" href="class_verse_key.html#a28">VerseKey</a></ul> +<a name="index_b"><h3>- b -</h3></a> +<ul> +<li>Book() +: <a class="el" href="class_verse_key.html#a24">VerseKey</a></ul> +<a name="index_c"><h3>- c -</h3></a> +<ul> +<li>Chapter() +: <a class="el" href="class_verse_key.html#a25">VerseKey</a><li>ClearBounds() +: <a class="el" href="class_verse_key.html#a9">VerseKey</a><li>ClearList() +: <a class="el" href="class_list_key.html#a4">ListKey</a><li>clone() +: <a class="el" href="class_verse_key.html#a10">VerseKey</a>, <a class="el" href="class_s_w_key.html#a3">SWKey</a>, <a class="el" href="class_list_key.html#a3">ListKey</a><li>compare() +: <a class="el" href="class_verse_key.html#a34">VerseKey</a>, <a class="el" href="class_s_w_key.html#a10">SWKey</a><li>config +: <a class="el" href="class_s_w_mgr.html#m0">SWMgr</a><li>copyFrom() +: <a class="el" href="class_verse_key.html#a14">VerseKey</a>, <a class="el" href="class_s_w_key.html#a8">SWKey</a>, <a class="el" href="class_list_key.html#a12">ListKey</a><li>Count() +: <a class="el" href="class_list_key.html#a5">ListKey</a><li>CreateKey() +: <a class="el" href="class_s_w_text.html#a2">SWText</a>, <a class="el" href="class_s_w_module.html#a23">SWModule</a>, <a class="el" href="class_s_w_l_d.html#a2">SWLD</a>, <a class="el" href="class_s_w_com.html#a2">SWCom</a><li>createModule() +: <a class="el" href="class_s_w_module.html#d1">SWModule</a></ul> +<a name="index_d"><h3>- d -</h3></a> +<ul> +<li>debug +: <a class="el" href="class_s_w_mgr.html#p0">SWMgr</a><li>decrement() +: <a class="el" href="class_verse_key.html#a16">VerseKey</a>, <a class="el" href="class_s_w_key.html#a13">SWKey</a>, <a class="el" href="class_list_key.html#a14">ListKey</a><li>deleteEntry() +: <a class="el" href="class_s_w_module.html#a32">SWModule</a><li>Description() +: <a class="el" href="class_s_w_module.html#a13">SWModule</a><li>Direction() +: <a class="el" href="class_s_w_module.html#a15">SWModule</a><li>Disp() +: <a class="el" href="class_s_w_module.html#a11">SWModule</a><li>disp +: <a class="el" href="class_s_w_module.html#n10">SWModule</a><li>Display() +: <a class="el" href="class_s_w_module.html#a10">SWModule</a>, <a class="el" href="class_s_w_display.html#a1">SWDisplay</a></ul> +<a name="index_e"><h3>- e -</h3></a> +<ul> +<li>Encoding() +: <a class="el" href="class_s_w_module.html#a16">SWModule</a>, <a class="el" href="class_encoding_filter_mgr.html#a2">EncodingFilterMgr</a><li>encodingFilter() +: <a class="el" href="class_s_w_module.html#a45">SWModule</a><li>EncodingFilterMgr() +: <a class="el" href="class_encoding_filter_mgr.html#a0">EncodingFilterMgr</a><li>encodingFilters +: <a class="el" href="class_s_w_module.html#n16">SWModule</a><li>equals() +: <a class="el" href="class_s_w_key.html#a11">SWKey</a><li>Error() +: <a class="el" href="class_s_w_module.html#a2">SWModule</a>, <a class="el" href="class_s_w_key.html#a6">SWKey</a></ul> +<a name="index_f"><h3>- f -</h3></a> +<ul> +<li>filename +: <a class="el" href="class_s_w_config.html#m0">SWConfig</a><li>filterBuffer() +: <a class="el" href="class_s_w_module.html#a49">SWModule</a><li>findindex() +: <a class="el" href="class_verse_key.html#c6">VerseKey</a><li>freshtext() +: <a class="el" href="class_verse_key.html#c4">VerseKey</a></ul> +<a name="index_g"><h3>- g -</h3></a> +<ul> +<li>getAvailableLocales() +: <a class="el" href="class_locale_mgr.html#a3">LocaleMgr</a><li>getClass() +: <a class="el" href="class_s_w_object.html#a0">SWObject</a><li>getDefaultLocaleName() +: <a class="el" href="class_locale_mgr.html#a5">LocaleMgr</a><li>getDescription() +: <a class="el" href="class_s_w_locale.html#a3">SWLocale</a><li>GetElement() +: <a class="el" href="class_list_key.html#a8">ListKey</a><li>getEntrySize() +: <a class="el" href="class_s_w_module.html#a4">SWModule</a><li>getGlobalOption() +: <a class="el" href="class_s_w_mgr.html#a7">SWMgr</a><li>getGlobalOptions() +: <a class="el" href="class_s_w_mgr.html#a9">SWMgr</a><li>getGlobalOptionTip() +: <a class="el" href="class_s_w_mgr.html#a8">SWMgr</a><li>getLocale() +: <a class="el" href="class_locale_mgr.html#a2">LocaleMgr</a><li>getName() +: <a class="el" href="class_s_w_locale.html#a2">SWLocale</a><li>getRawEntry() +: <a class="el" href="class_s_w_module.html#a25">SWModule</a><li>getText() +: <a class="el" href="class_verse_key.html#a11">VerseKey</a>, <a class="el" href="class_s_w_key.html#a9">SWKey</a></ul> +<a name="index_h"><h3>- h -</h3></a> +<ul> +<li>Headings() +: <a class="el" href="class_verse_key.html#a29">VerseKey</a><li>headings +: <a class="el" href="class_verse_key.html#o8">VerseKey</a></ul> +<a name="index_i"><h3>- i -</h3></a> +<ul> +<li>increment() +: <a class="el" href="class_verse_key.html#a17">VerseKey</a>, <a class="el" href="class_s_w_key.html#a14">SWKey</a>, <a class="el" href="class_list_key.html#a15">ListKey</a><li>Index() +: <a class="el" href="class_verse_key.html#a32">VerseKey</a>, <a class="el" href="class_s_w_key.html#a16">SWKey</a>, <a class="el" href="class_list_key.html#a18">ListKey</a><li>init() +: <a class="el" href="class_verse_key.html#c3">VerseKey</a><li>initstatics() +: <a class="el" href="class_verse_key.html#c2">VerseKey</a><li>InstallScan() +: <a class="el" href="class_s_w_mgr.html#a4">SWMgr</a><li>instance +: <a class="el" href="class_verse_key.html#r3">VerseKey</a><li>isSearchOptimallySupported() +: <a class="el" href="class_s_w_module.html#a22">SWModule</a><li>isUnicode() +: <a class="el" href="class_s_w_module.html#a3">SWModule</a><li>isWritable() +: <a class="el" href="class_s_w_module.html#a28">SWModule</a></ul> +<a name="index_k"><h3>- k -</h3></a> +<ul> +<li>Key() +: <a class="el" href="class_s_w_module.html#a8">SWModule</a><li>key +: <a class="el" href="class_s_w_module.html#n1">SWModule</a><li>KeyText() +: <a class="el" href="class_s_w_module.html#a9">SWModule</a>, <a class="el" href="class_s_w_l_d.html#a3">SWLD</a></ul> +<a name="index_l"><h3>- l -</h3></a> +<ul> +<li>Lang() +: <a class="el" href="class_s_w_module.html#a18">SWModule</a><li>ListKey() +: <a class="el" href="class_list_key.html#a0">ListKey</a><li>Load() +: <a class="el" href="class_s_w_mgr.html#a5">SWMgr</a>, <a class="el" href="class_s_w_config.html#a2">SWConfig</a><li>LocaleMgr() +: <a class="el" href="class_locale_mgr.html#a0">LocaleMgr</a><li>LowerBound() +: <a class="el" href="class_verse_key.html#a7">VerseKey</a></ul> +<a name="index_m"><h3>- m -</h3></a> +<ul> +<li>Markup() +: <a class="el" href="class_s_w_module.html#a17">SWModule</a>, <a class="el" href="class_markup_filter_mgr.html#a2">MarkupFilterMgr</a><li>MarkupFilterMgr() +: <a class="el" href="class_markup_filter_mgr.html#a0">MarkupFilterMgr</a><li>Modules +: <a class="el" href="class_s_w_mgr.html#m2">SWMgr</a></ul> +<a name="index_n"><h3>- n -</h3></a> +<ul> +<li>Name() +: <a class="el" href="class_s_w_module.html#a12">SWModule</a><li>Normalize() +: <a class="el" href="class_verse_key.html#a27">VerseKey</a><li>nullPercent() +: <a class="el" href="class_s_w_module.html#d0">SWModule</a></ul> +<a name="index_o"><h3>- o -</h3></a> +<ul> +<li>operator char *() +: <a class="el" href="class_s_w_module.html#a24">SWModule</a><li>operator SWKey &() +: <a class="el" href="class_s_w_module.html#a26">SWModule</a><li>operator SWKey *() +: <a class="el" href="class_s_w_module.html#a27">SWModule</a><li>operator++() +: <a class="el" href="class_s_w_module.html#a35">SWModule</a><li>operator+=() +: <a class="el" href="class_s_w_module.html#a34">SWModule</a>, <a class="el" href="class_s_w_config.html#a4">SWConfig</a><li>operator--() +: <a class="el" href="class_s_w_module.html#a36">SWModule</a><li>operator-=() +: <a class="el" href="class_s_w_module.html#a33">SWModule</a><li>operator<<() +: <a class="el" href="class_s_w_module.html#a31">SWModule</a>, <a class="el" href="class_list_key.html#a9">ListKey</a><li>operator=() +: <a class="el" href="class_s_w_module.html#a37">SWModule</a><li>operator[]() +: <a class="el" href="class_s_w_config.html#a5">SWConfig</a><li>optionFilter() +: <a class="el" href="class_s_w_module.html#a52">SWModule</a><li>optionFilters +: <a class="el" href="class_s_w_module.html#n15">SWModule</a></ul> +<a name="index_p"><h3>- p -</h3></a> +<ul> +<li>parse() +: <a class="el" href="class_verse_key.html#c5">VerseKey</a><li>Persist() +: <a class="el" href="class_s_w_key.html#a5">SWKey</a><li>prefixPath +: <a class="el" href="class_s_w_mgr.html#m3">SWMgr</a></ul> +<a name="index_r"><h3>- r -</h3></a> +<ul> +<li>rawFilter() +: <a class="el" href="class_s_w_module.html#a50">SWModule</a><li>rawFilters +: <a class="el" href="class_s_w_module.html#n13">SWModule</a><li>Remove() +: <a class="el" href="class_list_key.html#a6">ListKey</a><li>RemoveEncodingFilter() +: <a class="el" href="class_s_w_module.html#a43">SWModule</a><li>RemoveRenderFilter() +: <a class="el" href="class_s_w_module.html#a39">SWModule</a><li>renderFilter() +: <a class="el" href="class_s_w_module.html#a41">SWModule</a><li>renderFilters +: <a class="el" href="class_s_w_module.html#n14">SWModule</a><li>RenderText() +: <a class="el" href="class_s_w_module.html#a56">SWModule</a><li>ReplaceEncodingFilter() +: <a class="el" href="class_s_w_module.html#a44">SWModule</a><li>ReplaceRenderFilter() +: <a class="el" href="class_s_w_module.html#a40">SWModule</a></ul> +<a name="index_s"><h3>- s -</h3></a> +<ul> +<li>Save() +: <a class="el" href="class_s_w_config.html#a3">SWConfig</a><li>Search() +: <a class="el" href="class_s_w_module.html#a19">SWModule</a><li>Sections +: <a class="el" href="class_s_w_config.html#m1">SWConfig</a><li>setCipherKey() +: <a class="el" href="class_s_w_mgr.html#a11">SWMgr</a><li>setDefaultLocaleName() +: <a class="el" href="class_locale_mgr.html#a6">LocaleMgr</a><li>setentry() +: <a class="el" href="class_s_w_module.html#a29">SWModule</a><li>setGlobalOption() +: <a class="el" href="class_s_w_mgr.html#a6">SWMgr</a><li>SetKey() +: <a class="el" href="class_s_w_module.html#a6">SWModule</a><li>setPosition() +: <a class="el" href="class_verse_key.html#a15">VerseKey</a>, <a class="el" href="class_list_key.html#a13">ListKey</a><li>setText() +: <a class="el" href="class_verse_key.html#a12">VerseKey</a>, <a class="el" href="class_s_w_key.html#a7">SWKey</a><li>SetToElement() +: <a class="el" href="class_list_key.html#a7">ListKey</a><li>stripFilter() +: <a class="el" href="class_s_w_module.html#a47">SWModule</a><li>stripFilters +: <a class="el" href="class_s_w_module.html#n12">SWModule</a><li>StripText() +: <a class="el" href="class_s_w_module.html#a55">SWModule</a><li>StrKey() +: <a class="el" href="class_str_key.html#a0">StrKey</a><li>SWCom() +: <a class="el" href="class_s_w_com.html#a0">SWCom</a><li>SWConfig() +: <a class="el" href="class_s_w_config.html#a0">SWConfig</a><li>SWKey() +: <a class="el" href="class_s_w_key.html#a1">SWKey</a><li>SWLD() +: <a class="el" href="class_s_w_l_d.html#a0">SWLD</a><li>SWMgr() +: <a class="el" href="class_s_w_mgr.html#a2">SWMgr</a><li>SWModule() +: <a class="el" href="class_s_w_module.html#a0">SWModule</a><li>SWText() +: <a class="el" href="class_s_w_text.html#a0">SWText</a><li>systemLocaleMgr +: <a class="el" href="class_locale_mgr.html#p0">LocaleMgr</a></ul> +<a name="index_t"><h3>- t -</h3></a> +<ul> +<li>terminateSearch +: <a class="el" href="class_s_w_module.html#m0">SWModule</a><li>testament +: <a class="el" href="class_verse_key.html#o3">VerseKey</a><li>Testament() +: <a class="el" href="class_verse_key.html#a23">VerseKey</a><li>translate() +: <a class="el" href="class_locale_mgr.html#a4">LocaleMgr</a><li>Type() +: <a class="el" href="class_s_w_module.html#a14">SWModule</a></ul> +<a name="index_u"><h3>- u -</h3></a> +<ul> +<li>UpperBound() +: <a class="el" href="class_verse_key.html#a8">VerseKey</a></ul> +<a name="index_v"><h3>- v -</h3></a> +<ul> +<li>Verse() +: <a class="el" href="class_verse_key.html#a26">VerseKey</a><li>VerseKey() +: <a class="el" href="class_verse_key.html#a3">VerseKey</a></ul> +<a name="index_~"><h3>- ~ -</h3></a> +<ul> +<li>~EncodingFilterMgr() +: <a class="el" href="class_encoding_filter_mgr.html#a1">EncodingFilterMgr</a><li>~ListKey() +: <a class="el" href="class_list_key.html#a2">ListKey</a><li>~LocaleMgr() +: <a class="el" href="class_locale_mgr.html#a1">LocaleMgr</a><li>~MarkupFilterMgr() +: <a class="el" href="class_markup_filter_mgr.html#a1">MarkupFilterMgr</a><li>~StrKey() +: <a class="el" href="class_str_key.html#a1">StrKey</a><li>~SWKey() +: <a class="el" href="class_s_w_key.html#a2">SWKey</a><li>~SWMgr() +: <a class="el" href="class_s_w_mgr.html#a3">SWMgr</a><li>~SWModule() +: <a class="el" href="class_s_w_module.html#a1">SWModule</a><li>~VerseKey() +: <a class="el" href="class_verse_key.html#a4">VerseKey</a></ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbffootnotes.h-source.html b/doc/api-documentation/html/gbffootnotes.h-source.html new file mode 100644 index 0000000..f600d40 --- /dev/null +++ b/doc/api-documentation/html/gbffootnotes.h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>gbffootnotes.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbffootnotes.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * $Id: gbffootnotes.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFFOOTNOTES_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFFOOTNOTES_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_gbffootnotes.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbffootnotes.html">GBFFootnotes</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 GBFFootnotes (); +00040 <font class="keyword">virtual</font> ~ GBFFootnotes (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +<a name="l00042"></a><a class="code" href="class_gbffootnotes.html#a3">00042</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"> +</font>00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +<a name="l00046"></a><a class="code" href="class_gbffootnotes.html#a4">00046</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"> +</font>00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00052"></a><a class="code" href="class_gbffootnotes.html#a7">00052</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"> +</font>00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbffootnotes_8h-source.html b/doc/api-documentation/html/gbffootnotes_8h-source.html new file mode 100644 index 0000000..999a705 --- /dev/null +++ b/doc/api-documentation/html/gbffootnotes_8h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbffootnotes.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbffootnotes.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: gbffootnotes_8h-source.html,v 1.4 2002/01/22 14:20:27 jansorg Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFFOOTNOTES_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFFOOTNOTES_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_g_b_f_footnotes.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_g_b_f_footnotes.html">GBFFootnotes</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 GBFFootnotes (); +00040 <font class="keyword">virtual</font> ~ GBFFootnotes (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00042 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +00046 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00052 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbffootnotes_h-source.html b/doc/api-documentation/html/gbffootnotes_h-source.html new file mode 100644 index 0000000..44d647b --- /dev/null +++ b/doc/api-documentation/html/gbffootnotes_h-source.html @@ -0,0 +1,72 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbffootnotes.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbffootnotes.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: gbffootnotes_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFFOOTNOTES_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFFOOTNOTES_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_gbffootnotes.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbffootnotes.html">GBFFootnotes</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 GBFFootnotes (); +00040 <font class="keyword">virtual</font> ~ GBFFootnotes (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +<a name="l00042"></a><a class="code" href="class_gbffootnotes.html#a3">00042</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +<a name="l00046"></a><a class="code" href="class_gbffootnotes.html#a4">00046</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00052"></a><a class="code" href="class_gbffootnotes.html#a7">00052</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfheadings.h-source.html b/doc/api-documentation/html/gbfheadings.h-source.html new file mode 100644 index 0000000..18bfb2a --- /dev/null +++ b/doc/api-documentation/html/gbfheadings.h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>gbfheadings.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfheadings.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * $Id: gbfheadings.h-source.html,v 1.1 2001/05/25 10:50:59 jansorg Exp $ +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFHEADINGS_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFHEADINGS_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_gbfheadings.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfheadings.html">GBFHeadings</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 GBFHeadings (); +00040 <font class="keyword">virtual</font> ~ GBFHeadings (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +<a name="l00042"></a><a class="code" href="class_gbfheadings.html#a3">00042</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"> +</font>00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +<a name="l00046"></a><a class="code" href="class_gbfheadings.html#a4">00046</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"> +</font>00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00052"></a><a class="code" href="class_gbfheadings.html#a7">00052</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"> +</font>00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfheadings_8h-source.html b/doc/api-documentation/html/gbfheadings_8h-source.html new file mode 100644 index 0000000..727a8e5 --- /dev/null +++ b/doc/api-documentation/html/gbfheadings_8h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfheadings.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfheadings.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: gbfheadings_8h-source.html,v 1.4 2002/01/22 14:20:27 jansorg Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFHEADINGS_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFHEADINGS_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_g_b_f_headings.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_g_b_f_headings.html">GBFHeadings</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 GBFHeadings (); +00040 <font class="keyword">virtual</font> ~ GBFHeadings (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00042 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +00046 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00052 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfheadings_h-source.html b/doc/api-documentation/html/gbfheadings_h-source.html new file mode 100644 index 0000000..02e4ba7 --- /dev/null +++ b/doc/api-documentation/html/gbfheadings_h-source.html @@ -0,0 +1,72 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfheadings.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfheadings.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: gbfheadings_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFHEADINGS_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFHEADINGS_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_gbfheadings.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfheadings.html">GBFHeadings</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 GBFHeadings (); +00040 <font class="keyword">virtual</font> ~ GBFHeadings (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +<a name="l00042"></a><a class="code" href="class_gbfheadings.html#a3">00042</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +<a name="l00046"></a><a class="code" href="class_gbfheadings.html#a4">00046</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00052"></a><a class="code" href="class_gbfheadings.html#a7">00052</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfhtml.h-source.html b/doc/api-documentation/html/gbfhtml.h-source.html new file mode 100644 index 0000000..65842c5 --- /dev/null +++ b/doc/api-documentation/html/gbfhtml.h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>gbfhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/*************************************************************************** +</font>00002 <font class="comment"> gbfhtml.h - description +</font>00003 <font class="comment"> ------------------- +</font>00004 <font class="comment"> begin : Tue Jun 15 15:34:26 CEST 1999 +</font>00005 <font class="comment"> +</font>00006 <font class="comment"> copyright : (C) 1999 by Torsten Uhlmann +</font>00007 <font class="comment"> email : TUhlmann@gmx.de +</font>00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/*************************************************************************** +</font>00011 <font class="comment"> * * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify * +</font>00013 <font class="comment"> * it under the terms of the GNU General Public License as published by * +</font>00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or * +</font>00015 <font class="comment"> * (at your option) any later version. * +</font>00016 <font class="comment"> * * +</font>00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/gbfhtml.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ */</font> +00020 <font class="comment">/* $Revision: 1.10 $ */</font> +00021 +00022 <font class="preprocessor">#ifndef GBFHTML_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define GBFHTML_H +</font>00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swfilter.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +<a name="l00031"></a><a class="code" href="class_gbfhtml.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfhtml.html">GBFHTML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00032 { +00033 <font class="keyword">public</font>: +00034 GBFHTML (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00036 }; +00037 +00038 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfhtml_8h-source.html b/doc/api-documentation/html/gbfhtml_8h-source.html new file mode 100644 index 0000000..22dc5e9 --- /dev/null +++ b/doc/api-documentation/html/gbfhtml_8h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> gbfhtml.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : Tue Jun 15 15:34:26 CEST 1999</font> +00005 <font class="comment"></font> +00006 <font class="comment"> copyright : (C) 1999 by Torsten Uhlmann</font> +00007 <font class="comment"> email : TUhlmann@gmx.de</font> +00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/***************************************************************************</font> +00011 <font class="comment"> * *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00013 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00015 <font class="comment"> * (at your option) any later version. *</font> +00016 <font class="comment"> * *</font> +00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/gbfhtml_8h-source.html,v 1.4 2002/01/22 14:20:27 jansorg Exp $ */</font> +00020 <font class="comment">/* $Revision: 1.4 $ */</font> +00021 +00022 <font class="preprocessor">#ifndef GBFHTML_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define GBFHTML_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swfilter.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +<a name="l00031"></a><a class="code" href="class_g_b_f_h_t_m_l.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_g_b_f_h_t_m_l.html">GBFHTML</a>:<font class="keyword">public</font> SWFilter +00032 { +00033 <font class="keyword">public</font>: +00034 GBFHTML (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00036 }; +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfhtml_h-source.html b/doc/api-documentation/html/gbfhtml_h-source.html new file mode 100644 index 0000000..2412583 --- /dev/null +++ b/doc/api-documentation/html/gbfhtml_h-source.html @@ -0,0 +1,52 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> gbfhtml.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : Tue Jun 15 15:34:26 CEST 1999</font> +00005 <font class="comment"></font> +00006 <font class="comment"> copyright : (C) 1999 by Torsten Uhlmann</font> +00007 <font class="comment"> email : TUhlmann@gmx.de</font> +00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/***************************************************************************</font> +00011 <font class="comment"> * *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00013 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00015 <font class="comment"> * (at your option) any later version. *</font> +00016 <font class="comment"> * *</font> +00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/gbfhtml_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $ */</font> +00020 <font class="comment">/* $Revision: 1.4 $ */</font> +00021 +00022 <font class="preprocessor">#ifndef GBFHTML_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define GBFHTML_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swfilter.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +<a name="l00031"></a><a class="code" href="class_gbfhtml.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfhtml.html">GBFHTML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00032 { +00033 <font class="keyword">public</font>: +00034 GBFHTML (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00036 }; +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfhtmlhref_8h-source.html b/doc/api-documentation/html/gbfhtmlhref_8h-source.html new file mode 100644 index 0000000..24ae3ae --- /dev/null +++ b/doc/api-documentation/html/gbfhtmlhref_8h-source.html @@ -0,0 +1,46 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfhtmlhref.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfhtmlhref.h</h1><div class="fragment"><pre>00001 <font class="comment">/*-*************************************************************************</font> +00002 <font class="comment"> gbfhtmlhref.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : 2001-09-03</font> +00005 <font class="comment"> copyright : 2001 by CrossWire Bible Society</font> +00006 <font class="comment"> ***************************************************************************/</font> +00007 +00008 <font class="comment">/***************************************************************************</font> +00009 <font class="comment"> * *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00013 <font class="comment"> * (at your option) any later version. *</font> +00014 <font class="comment"> * *</font> +00015 <font class="comment"> ***************************************************************************/</font> +00016 +00017 <font class="preprocessor">#ifndef GBFHTMLHREF_H</font> +00018 <font class="preprocessor"></font><font class="preprocessor">#define GBFHTMLHREF_H</font> +00019 <font class="preprocessor"></font> +00020 <font class="preprocessor">#include <swbasicfilter.h></font> +00021 +00022 <font class="preprocessor">#include <defs.h></font> +00023 +<a name="l00026"></a><a class="code" href="class_g_b_f_h_t_m_l_h_r_e_f.html">00026</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_g_b_f_h_t_m_l_h_r_e_f.html">GBFHTMLHREF</a> : <font class="keyword">public</font> SWBasicFilter { +00027 <font class="keyword">protected</font>: +00028 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token, DualStringMap &userData); +00029 <font class="keyword">public</font>: +00030 GBFHTMLHREF (); +00031 }; +00032 +00033 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfhtmlhref_h-source.html b/doc/api-documentation/html/gbfhtmlhref_h-source.html new file mode 100644 index 0000000..941a173 --- /dev/null +++ b/doc/api-documentation/html/gbfhtmlhref_h-source.html @@ -0,0 +1,47 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfhtmlhref.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfhtmlhref.h</h1><div class="fragment"><pre>00001 <font class="comment">/*-*************************************************************************</font> +00002 <font class="comment"> gbfhtmlhref.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : 2001-09-03</font> +00005 <font class="comment"> copyright : 2001 by CrossWire Bible Society</font> +00006 <font class="comment"> ***************************************************************************/</font> +00007 +00008 <font class="comment">/***************************************************************************</font> +00009 <font class="comment"> * *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00013 <font class="comment"> * (at your option) any later version. *</font> +00014 <font class="comment"> * *</font> +00015 <font class="comment"> ***************************************************************************/</font> +00016 +00017 <font class="preprocessor">#ifndef GBFHTMLHREF_H</font> +00018 <font class="preprocessor"></font><font class="preprocessor">#define GBFHTMLHREF_H</font> +00019 <font class="preprocessor"></font> +00020 <font class="preprocessor">#include <swbasicfilter.h></font> +00021 +00022 <font class="preprocessor">#include <defs.h></font> +00023 +<a name="l00026"></a><a class="code" href="class_gbfhtmlhref.html">00026</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfhtmlhref.html">GBFHTMLHREF</a> : <font class="keyword">public</font> SWBasicFilter { +00027 <font class="keyword">protected</font>: +00028 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token, DualStringMap &userData); +00029 <font class="keyword">public</font>: +00030 GBFHTMLHREF (); +00031 }; +00032 +00033 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfmorph_8h-source.html b/doc/api-documentation/html/gbfmorph_8h-source.html new file mode 100644 index 0000000..4e23ca9 --- /dev/null +++ b/doc/api-documentation/html/gbfmorph_8h-source.html @@ -0,0 +1,70 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfmorph.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfmorph.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef GBFMORPH_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define GBFMORPH_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_g_b_f_morph.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_g_b_f_morph.html">GBFMorph</a>:<font class="keyword">public</font> SWFilter +00030 { +00031 <font class="keywordtype">bool</font> option; +00032 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00036 OptionsList options; +00037 <font class="keyword">public</font>: +00038 GBFMorph (); +00039 <font class="keyword">virtual</font> ~ GBFMorph (); +00040 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00041 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00042 <font class="keyword"> </font>{ +00043 <font class="keywordflow">return</font> optName; +00044 } +00045 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> optTip; +00048 } +00049 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00050 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00051 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> options; +00054 } +00055 }; +00056 +00057 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfmorph_h-source.html b/doc/api-documentation/html/gbfmorph_h-source.html new file mode 100644 index 0000000..d7be217 --- /dev/null +++ b/doc/api-documentation/html/gbfmorph_h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfmorph.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfmorph.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef GBFMORPH_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define GBFMORPH_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_gbfmorph.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfmorph.html">GBFMorph</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00030 { +00031 <font class="keywordtype">bool</font> option; +00032 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00036 OptionsList options; +00037 <font class="keyword">public</font>: +00038 GBFMorph (); +00039 <font class="keyword">virtual</font> ~ GBFMorph (); +00040 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +<a name="l00041"></a><a class="code" href="class_gbfmorph.html#a3">00041</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"></font> +00042 <font class="keyword"> </font>{ +00043 <font class="keywordflow">return</font> optName; +00044 } +<a name="l00045"></a><a class="code" href="class_gbfmorph.html#a4">00045</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"></font> +00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> optTip; +00048 } +00049 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00050 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00051"></a><a class="code" href="class_gbfmorph.html#a7">00051</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> options; +00054 } +00055 }; +00056 +00057 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfplain.h-source.html b/doc/api-documentation/html/gbfplain.h-source.html new file mode 100644 index 0000000..8c93475 --- /dev/null +++ b/doc/api-documentation/html/gbfplain.h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>gbfplain.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfplain.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * $Id: gbfplain.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFPLAIN_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFPLAIN_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_gbfplain.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfplain.html">GBFPlain</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 GBFPlain (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *key); +00035 }; +00036 +00037 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfplain_8h-source.html b/doc/api-documentation/html/gbfplain_8h-source.html new file mode 100644 index 0000000..e4067ee --- /dev/null +++ b/doc/api-documentation/html/gbfplain_8h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfplain.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfplain.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: gbfplain_8h-source.html,v 1.4 2002/01/22 14:20:27 jansorg Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFPLAIN_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFPLAIN_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_g_b_f_plain.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_g_b_f_plain.html">GBFPlain</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keyword">public</font>: +00033 GBFPlain (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfplain_h-source.html b/doc/api-documentation/html/gbfplain_h-source.html new file mode 100644 index 0000000..9869672 --- /dev/null +++ b/doc/api-documentation/html/gbfplain_h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfplain.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfplain.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: gbfplain_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFPLAIN_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFPLAIN_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_gbfplain.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfplain.html">GBFPlain</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 GBFPlain (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *key); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfrtf.h-source.html b/doc/api-documentation/html/gbfrtf.h-source.html new file mode 100644 index 0000000..3f9a22c --- /dev/null +++ b/doc/api-documentation/html/gbfrtf.h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>gbfrtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfrtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * $Id: gbfrtf.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFRTF_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFRTF_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_gbfrtf.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfrtf.html">GBFRTF</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 GBFRTF (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00035 }; +00036 +00037 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfrtf_8h-source.html b/doc/api-documentation/html/gbfrtf_8h-source.html new file mode 100644 index 0000000..7e8f292 --- /dev/null +++ b/doc/api-documentation/html/gbfrtf_8h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfrtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfrtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: gbfrtf_8h-source.html,v 1.4 2002/01/22 14:20:27 jansorg Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFRTF_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFRTF_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_g_b_f_r_t_f.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_g_b_f_r_t_f.html">GBFRTF</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keyword">public</font>: +00033 GBFRTF (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfrtf_h-source.html b/doc/api-documentation/html/gbfrtf_h-source.html new file mode 100644 index 0000000..aecd7ea --- /dev/null +++ b/doc/api-documentation/html/gbfrtf_h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfrtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfrtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: gbfrtf_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFRTF_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFRTF_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_gbfrtf.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfrtf.html">GBFRTF</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 GBFRTF (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfstrongs.h-source.html b/doc/api-documentation/html/gbfstrongs.h-source.html new file mode 100644 index 0000000..16dbfd0 --- /dev/null +++ b/doc/api-documentation/html/gbfstrongs.h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>gbfstrongs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfstrongs.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * $Id: gbfstrongs.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFSTRONGS_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFSTRONGS_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_gbfstrongs.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfstrongs.html">GBFStrongs</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 GBFStrongs (); +00040 <font class="keyword">virtual</font> ~ GBFStrongs (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +<a name="l00042"></a><a class="code" href="class_gbfstrongs.html#a3">00042</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"> +</font>00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +<a name="l00046"></a><a class="code" href="class_gbfstrongs.html#a4">00046</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"> +</font>00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00052"></a><a class="code" href="class_gbfstrongs.html#a7">00052</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"> +</font>00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfstrongs_8h-source.html b/doc/api-documentation/html/gbfstrongs_8h-source.html new file mode 100644 index 0000000..cae5495 --- /dev/null +++ b/doc/api-documentation/html/gbfstrongs_8h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfstrongs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfstrongs.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: gbfstrongs_8h-source.html,v 1.4 2002/01/22 14:20:27 jansorg Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFSTRONGS_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFSTRONGS_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_g_b_f_strongs.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_g_b_f_strongs.html">GBFStrongs</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 GBFStrongs (); +00040 <font class="keyword">virtual</font> ~ GBFStrongs (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00042 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +00046 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00052 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfstrongs_h-source.html b/doc/api-documentation/html/gbfstrongs_h-source.html new file mode 100644 index 0000000..fa4c019 --- /dev/null +++ b/doc/api-documentation/html/gbfstrongs_h-source.html @@ -0,0 +1,72 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfstrongs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfstrongs.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: gbfstrongs_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef GBFSTRONGS_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define GBFSTRONGS_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_gbfstrongs.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfstrongs.html">GBFStrongs</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 GBFStrongs (); +00040 <font class="keyword">virtual</font> ~ GBFStrongs (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +<a name="l00042"></a><a class="code" href="class_gbfstrongs.html#a3">00042</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +<a name="l00046"></a><a class="code" href="class_gbfstrongs.html#a4">00046</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00052"></a><a class="code" href="class_gbfstrongs.html#a7">00052</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfthml.h-source.html b/doc/api-documentation/html/gbfthml.h-source.html new file mode 100644 index 0000000..4e3cb51 --- /dev/null +++ b/doc/api-documentation/html/gbfthml.h-source.html @@ -0,0 +1,47 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>gbfthml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfthml.h</h1><div class="fragment"><pre>00001 <font class="comment">/*************************************************************************** +</font>00002 <font class="comment"> gbfthml.h - description +</font>00003 <font class="comment"> ------------------- +</font>00004 <font class="comment"> begin : 1999-10-28 +</font>00005 <font class="comment"> copyright : 1999 by Chris Little +</font>00006 <font class="comment"> email : chrislit@chiasma.org +</font>00007 <font class="comment"> ***************************************************************************/</font> +00008 +00009 <font class="comment">/*************************************************************************** +</font>00010 <font class="comment"> * * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify * +</font>00012 <font class="comment"> * it under the terms of the GNU General Public License as published by * +</font>00013 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or * +</font>00014 <font class="comment"> * (at your option) any later version. * +</font>00015 <font class="comment"> * * +</font>00016 <font class="comment"> ***************************************************************************/</font> +00017 +00018 <font class="preprocessor">#ifndef GBFTHML_H +</font>00019 <font class="preprocessor"></font><font class="preprocessor">#define GBFTHML_H +</font>00020 <font class="preprocessor"></font> +00021 <font class="preprocessor">#include <swfilter.h></font> +00022 +00023 <font class="preprocessor">#include <defs.h></font> +00024 +<a name="l00027"></a><a class="code" href="class_gbfthml.html">00027</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfthml.html">GBFThML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00028 { +00029 <font class="keyword">public</font>: +00030 GBFThML (); +00031 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00032 }; +00033 +00034 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfthml_8h-source.html b/doc/api-documentation/html/gbfthml_8h-source.html new file mode 100644 index 0000000..fc563b5 --- /dev/null +++ b/doc/api-documentation/html/gbfthml_8h-source.html @@ -0,0 +1,47 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfthml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfthml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> gbfthml.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : 1999-10-28</font> +00005 <font class="comment"> copyright : 1999 by Chris Little</font> +00006 <font class="comment"> email : chrislit@chiasma.org</font> +00007 <font class="comment"> ***************************************************************************/</font> +00008 +00009 <font class="comment">/***************************************************************************</font> +00010 <font class="comment"> * *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00012 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00013 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00014 <font class="comment"> * (at your option) any later version. *</font> +00015 <font class="comment"> * *</font> +00016 <font class="comment"> ***************************************************************************/</font> +00017 +00018 <font class="preprocessor">#ifndef GBFTHML_H</font> +00019 <font class="preprocessor"></font><font class="preprocessor">#define GBFTHML_H</font> +00020 <font class="preprocessor"></font> +00021 <font class="preprocessor">#include <swfilter.h></font> +00022 +00023 <font class="preprocessor">#include <defs.h></font> +00024 +<a name="l00027"></a><a class="code" href="class_g_b_f_th_m_l.html">00027</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_g_b_f_th_m_l.html">GBFThML</a>:<font class="keyword">public</font> SWFilter +00028 { +00029 <font class="keyword">public</font>: +00030 GBFThML (); +00031 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00032 }; +00033 +00034 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/gbfthml_h-source.html b/doc/api-documentation/html/gbfthml_h-source.html new file mode 100644 index 0000000..a9c62b8 --- /dev/null +++ b/doc/api-documentation/html/gbfthml_h-source.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>gbfthml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>gbfthml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> gbfthml.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : 1999-10-28</font> +00005 <font class="comment"> copyright : 1999 by Chris Little</font> +00006 <font class="comment"> email : chrislit@chiasma.org</font> +00007 <font class="comment"> ***************************************************************************/</font> +00008 +00009 <font class="comment">/***************************************************************************</font> +00010 <font class="comment"> * *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00012 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00013 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00014 <font class="comment"> * (at your option) any later version. *</font> +00015 <font class="comment"> * *</font> +00016 <font class="comment"> ***************************************************************************/</font> +00017 +00018 <font class="preprocessor">#ifndef GBFTHML_H</font> +00019 <font class="preprocessor"></font><font class="preprocessor">#define GBFTHML_H</font> +00020 <font class="preprocessor"></font> +00021 <font class="preprocessor">#include <swfilter.h></font> +00022 +00023 <font class="preprocessor">#include <defs.h></font> +00024 +<a name="l00027"></a><a class="code" href="class_gbfthml.html">00027</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_gbfthml.html">GBFThML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00028 { +00029 <font class="keyword">public</font>: +00030 GBFThML (); +00031 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00032 }; +00033 +00034 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/greek2greek_h-source.html b/doc/api-documentation/html/greek2greek_h-source.html new file mode 100644 index 0000000..1396ad6 --- /dev/null +++ b/doc/api-documentation/html/greek2greek_h-source.html @@ -0,0 +1,130 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Greek2Greek.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>Greek2Greek.h</h1><div class="fragment"><pre>00001 <font class="comment">//*****************************************************************************</font> +00002 <font class="comment">// Author : William Dicks ***</font> +00003 <font class="comment">// Date Created: 10 February 1998 ***</font> +00004 <font class="comment">// Purpose : Interface for Greek to b-Greek conversion and vice versa ***</font> +00005 <font class="comment">// File Name : Greek2Greek.h ***</font> +00006 <font class="comment">// ***</font> +00007 <font class="comment">// Author info : ---------------------------------------------------------- ***</font> +00008 <font class="comment">// Address : 23 Tieroogpark ***</font> +00009 <font class="comment">// : Hoewe Str ***</font> +00010 <font class="comment">// : Elarduspark X3 ***</font> +00011 <font class="comment">// : 0181 ***</font> +00012 <font class="comment">// : South Africa ***</font> +00013 <font class="comment">// Home Tel: +27 (0)12 345 3166 ***</font> +00014 <font class="comment">// Cell No : +27 (0)82 577 4424 ***</font> +00015 <font class="comment">// e-mail : wd@isis.co.za ***</font> +00016 <font class="comment">// Church WWW : http://www.hatfield.co.za ***</font> +00017 <font class="comment">//*****************************************************************************</font> +00018 <font class="comment">/*</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> * $Id: greek2greek_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00023 <font class="comment"> * CrossWire Bible Society</font> +00024 <font class="comment"> * P. O. Box 2528</font> +00025 <font class="comment"> * Tempe, AZ 85280-2528</font> +00026 <font class="comment"> *</font> +00027 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00028 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00029 <font class="comment"> * Free Software Foundation version 2.</font> +00030 <font class="comment"> *</font> +00031 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00032 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00033 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00034 <font class="comment"> * General Public License for more details.</font> +00035 <font class="comment"> *</font> +00036 <font class="comment"> */</font> +00037 +00038 <font class="preprocessor">#ifndef __GREEK2GREEK</font> +00039 <font class="preprocessor"></font><font class="preprocessor">#define __GREEK2GREEK</font> +00040 <font class="preprocessor"></font> +00041 <font class="comment">//*****************************************************************************</font> +00042 <font class="comment">// Used to convert a string created by using the Greek font supplied with the</font> +00043 <font class="comment">// Sword Project to a string that conforms to the b-Greek discussion list </font> +00044 <font class="comment">// method of transliteration.</font> +00045 <font class="comment">//*****************************************************************************</font> +00046 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Greek2bGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, +00047 <font class="keywordtype">int</font> nMaxResultBuflen); +00048 +00049 <font class="comment">//*****************************************************************************</font> +00050 <font class="comment">// Used to convert a string created by using the b-Greek method of </font> +00051 <font class="comment">// transliteration to a string that can be converted to a Greek-font readable </font> +00052 <font class="comment">// string.</font> +00053 <font class="comment">//*****************************************************************************</font> +00054 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> bGreek2Greek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, +00055 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, <font class="keywordtype">int</font> nMaxResultBuflen); +00056 +00057 <font class="comment">//*****************************************************************************</font> +00058 <font class="comment">// Parse a Greek font created string and return the b-Greek equivalent</font> +00059 <font class="comment">//*****************************************************************************</font> +00060 <font class="keywordtype">int</font> ParseGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, +00061 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, <font class="keywordtype">int</font> nMaxResultBuflen); +00062 +00063 <font class="comment">//*****************************************************************************</font> +00064 <font class="comment">// Parse a b-Greek string and return the Greek font equivalent</font> +00065 <font class="comment">//*****************************************************************************</font> +00066 <font class="keywordtype">int</font> ParsebGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sResult, +00067 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *sGreekText, <font class="keywordtype">int</font> nMaxResultBuflen); +00068 +00069 <font class="comment">//*****************************************************************************</font> +00070 <font class="comment">// Convert a unsigned character to a GREEK font unsigned character</font> +00071 <font class="comment">//*****************************************************************************</font> +00072 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> char2Font (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> letter, <font class="comment">// bGreek letter to convert to Font letter</font> +00073 <font class="keywordtype">bool</font> finalSigma, <font class="comment">// Is it a final SIGMA</font> +00074 <font class="keywordtype">bool</font> iota, <font class="comment">// TRUE = IOTA subscript; FALSE = No IOTA</font> +00075 <font class="keywordtype">bool</font> breathing, <font class="comment">// TRUE = add breathing; FALSE = no breathing</font> +00076 <font class="keywordtype">bool</font> rough); <font class="comment">// TRUE = rough breathing; False = smooth</font> +00077 +00078 <font class="comment">//*****************************************************************************</font> +00079 <font class="comment">// Convert a GREEK font unsigned character to a unsigned character</font> +00080 <font class="comment">//*****************************************************************************</font> +00081 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Font2char (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> letter, <font class="comment">// bGreek letter to convert to Font letter</font> +00082 <font class="keywordtype">bool</font> & iota, <font class="comment">// TRUE = IOTA subscript; FALSE = No IOTA</font> +00083 <font class="keywordtype">bool</font> & breathing, <font class="comment">// TRUE = add breathing; FALSE = no breathing</font> +00084 <font class="keywordtype">bool</font> & rough); <font class="comment">// TRUE = rough breathing; False = smooth</font> +00085 +00086 +00087 <font class="comment">//*****************************************************************************</font> +00088 <font class="comment">// Identify and return a bGreek letter from a special font char</font> +00089 <font class="comment">//*****************************************************************************</font> +00090 <font class="keywordtype">bool</font> getSpecialChar (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Font, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> &letter); +00091 +00092 <font class="comment">//*****************************************************************************</font> +00093 <font class="comment">// true if the font character is a special character; false it isn't</font> +00094 <font class="comment">//*****************************************************************************</font> +00095 <font class="keywordtype">bool</font> SpecialGreek (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Font); +00096 +00097 <font class="comment">//*****************************************************************************</font> +00098 <font class="comment">// Return Greek font puntuation from bGreek punstuation</font> +00099 <font class="comment">//*****************************************************************************</font> +00100 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> getGreekPunct (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> bGreek); +00101 +00102 <font class="comment">//*****************************************************************************</font> +00103 <font class="comment">// Return bGreek puntuation from Greek font punstuation</font> +00104 <font class="comment">//*****************************************************************************</font> +00105 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> getbGreekPunct (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Greek); +00106 +00107 <font class="comment">//*****************************************************************************</font> +00108 <font class="comment">// Is the character punctuation or a space: true it is, false it isn't</font> +00109 <font class="comment">//*****************************************************************************</font> +00110 <font class="keywordtype">bool</font> isPunctSpace (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> c); +00111 +00112 +00113 +00114 <font class="preprocessor">#endif // __GREEK2GREEK</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/greekchars_h-source.html b/doc/api-documentation/html/greekchars_h-source.html new file mode 100644 index 0000000..9e55c98 --- /dev/null +++ b/doc/api-documentation/html/greekchars_h-source.html @@ -0,0 +1,165 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>GreekChars.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>GreekChars.h</h1><div class="fragment"><pre>00001 <font class="comment">//*****************************************************************************</font> +00002 <font class="comment">// Author : William Dicks ***</font> +00003 <font class="comment">// Date Created: 10 February 1998 ***</font> +00004 <font class="comment">// Purpose : Enumeration for Greek to b-Greek conversion and vice ***</font> +00005 <font class="comment">// : versa. ***</font> +00006 <font class="comment">// File Name : GreekChars.h ***</font> +00007 <font class="comment">// ***</font> +00008 <font class="comment">// Author info : ---------------------------------------------------------- ***</font> +00009 <font class="comment">// Address : 23 Tieroogpark ***</font> +00010 <font class="comment">// : Hoewe Str ***</font> +00011 <font class="comment">// : Elarduspark X3 ***</font> +00012 <font class="comment">// : 0181 ***</font> +00013 <font class="comment">// : South Africa ***</font> +00014 <font class="comment">// Home Tel: +27 (0)12 345 3166 ***</font> +00015 <font class="comment">// Cell No : +27 (0)82 577 4424 ***</font> +00016 <font class="comment">// e-mail : wd@isis.co.za ***</font> +00017 <font class="comment">// Church WWW : http://www.hatfield.co.za ***</font> +00018 <font class="comment">//*****************************************************************************</font> +00019 <font class="comment">/*</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> * $Id: greekchars_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00024 <font class="comment"> * CrossWire Bible Society</font> +00025 <font class="comment"> * P. O. Box 2528</font> +00026 <font class="comment"> * Tempe, AZ 85280-2528</font> +00027 <font class="comment"> *</font> +00028 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00029 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00030 <font class="comment"> * Free Software Foundation version 2.</font> +00031 <font class="comment"> *</font> +00032 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00033 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00034 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00035 <font class="comment"> * General Public License for more details.</font> +00036 <font class="comment"> *</font> +00037 <font class="comment"> */</font> +00038 +00039 <font class="preprocessor">#ifndef __GREEKCHARS_H</font> +00040 <font class="preprocessor"></font><font class="preprocessor">#define __GREEKCHARS_H</font> +00041 <font class="preprocessor"></font> +00042 <font class="comment">// This enum represents the values of the characters used for the </font> +00043 <font class="comment">// transliteration as used on the b-greek discussion list.</font> +00044 +00045 <font class="keyword">enum</font> bGreekChars +00046 { +00047 ALPHA = 65, <font class="comment">// A</font> +00048 BETA, <font class="comment">// B</font> +00049 CHI, <font class="comment">// C</font> +00050 DELTA, <font class="comment">// D</font> +00051 EPSILON, <font class="comment">// E</font> +00052 PHI, <font class="comment">// F</font> +00053 GAMMA, <font class="comment">// G</font> +00054 ETA, <font class="comment">// H</font> +00055 IOTA, <font class="comment">// I</font> +00056 <font class="comment">// No J</font> +00057 KAPPA = 75, <font class="comment">// K</font> +00058 LAMBDA, <font class="comment">// L</font> +00059 MU, <font class="comment">// M</font> +00060 NU, <font class="comment">// N</font> +00061 OMICRON, <font class="comment">// O</font> +00062 PI, <font class="comment">// P</font> +00063 THETA, <font class="comment">// Q</font> +00064 RHO, <font class="comment">// R</font> +00065 SIGMA, <font class="comment">// S</font> +00066 TAU, <font class="comment">// T</font> +00067 UPSILON, <font class="comment">// U</font> +00068 <font class="comment">// No V</font> +00069 OMEGA = <font class="charliteral">'W'</font>, <font class="comment">// W</font> +00070 XI, <font class="comment">// X</font> +00071 PSI, <font class="comment">// Y</font> +00072 ZETA, <font class="comment">// Z</font> +00073 ROUGH = 104, <font class="comment">// h</font> +00074 IOTA_SUB <font class="comment">// i</font> +00075 }; +00076 +00077 <font class="comment">// This enum represents the values of the characters ib the Greek.ttf font,</font> +00078 <font class="comment">// and the comments on the right are the corresponding bGreek equivalents.</font> +00079 +00080 <font class="keyword">enum</font> GreekFontChars +00081 { +00082 gALPHA = <font class="charliteral">'a'</font>, <font class="comment">// A</font> +00083 gBETA, <font class="comment">// B</font> +00084 gCHI, <font class="comment">// C</font> +00085 gDELTA, <font class="comment">// D</font> +00086 gEPSILON, <font class="comment">// E</font> +00087 gPHI, <font class="comment">// F</font> +00088 gGAMMA, <font class="comment">// G</font> +00089 gETA, <font class="comment">// H</font> +00090 gIOTA, <font class="comment">// I</font> +00091 gSIGMA_END, <font class="comment">// j</font> +00092 gKAPPA, <font class="comment">// K</font> +00093 gLAMBDA, <font class="comment">// L</font> +00094 gMU, <font class="comment">// M</font> +00095 gNU, <font class="comment">// N</font> +00096 gOMICRON, <font class="comment">// O</font> +00097 gPI, <font class="comment">// P</font> +00098 gTHETA, <font class="comment">// Q</font> +00099 gRHO, <font class="comment">// R</font> +00100 gSIGMA, <font class="comment">// S</font> +00101 gTAU, <font class="comment">// T</font> +00102 gUPSILON, <font class="comment">// U</font> +00103 <font class="comment">// No V</font> +00104 gOMEGA = <font class="charliteral">'w'</font>, <font class="comment">// W</font> +00105 gXI, <font class="comment">// X</font> +00106 gPSI, <font class="comment">// Y</font> +00107 gZETA, <font class="comment">// Z</font> +00108 gROUGH_ALPHA = 161, <font class="comment">// hA</font> +00109 gROUGH_EPSILON = 152, <font class="comment">// hE</font> +00110 gROUGH_ETA = 185, <font class="comment">// hH</font> +00111 gROUGH_IOTA = 131, <font class="comment">// hH</font> +00112 gROUGH_OMICRON = 208, <font class="comment">// hH</font> +00113 gROUGH_RHO = 183, <font class="comment">// hR</font> +00114 gROUGH_UPSILON = 216, <font class="comment">// hU</font> +00115 gROUGH_OMEGA = 230, <font class="comment">// hW</font> +00116 gIOTA_ALPHA = <font class="charliteral">'v'</font>, <font class="comment">// Ai</font> +00117 gIOTA_ETA = <font class="charliteral">'V'</font>, <font class="comment">// Ei</font> +00118 gIOTA_OMEGA = <font class="charliteral">'J'</font>, <font class="comment">// Wi</font> +00119 gNON_ROUGH_ALPHA = 162, <font class="comment">// hA</font> +00120 gNON_ROUGH_EPSILON = 153, <font class="comment">// hE</font> +00121 gNON_ROUGH_ETA = 186, <font class="comment">// hH</font> +00122 gNON_ROUGH_IOTA = 132, <font class="comment">// hH</font> +00123 gNON_ROUGH_OMICRON = 209, <font class="comment">// hH</font> +00124 gNON_ROUGH_RHO = 184, <font class="comment">// hR</font> +00125 gNON_ROUGH_UPSILON = 217, <font class="comment">// hU</font> +00126 gNON_ROUGH_OMEGA = 231 <font class="comment">// hW</font> +00127 }; +00128 +00129 <font class="comment">// English puntuation as used on bGreek</font> +00130 +00131 <font class="keyword">enum</font> bGreekPunct +00132 { +00133 COMMA = <font class="charliteral">','</font>, +00134 STOP = <font class="charliteral">'.'</font>, +00135 SEMI_COLON = <font class="charliteral">';'</font>, +00136 QUESTION = <font class="charliteral">'?'</font> +00137 }; +00138 +00139 <font class="comment">// English puntuation as used in the Greek font</font> +00140 +00141 <font class="keyword">enum</font> GreekPunct +00142 { +00143 gCOMMA = <font class="charliteral">','</font>, +00144 gSTOP = <font class="charliteral">'.'</font>, +00145 gSEMI_COLON = <font class="charliteral">':'</font>, +00146 gQUESTION = <font class="charliteral">';'</font> +00147 }; +00148 +00149 <font class="preprocessor">#endif // __GREEKCHARS_H</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/hierarchy.html b/doc/api-documentation/html/hierarchy.html new file mode 100644 index 0000000..fe4067d --- /dev/null +++ b/doc/api-documentation/html/hierarchy.html @@ -0,0 +1,84 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Hierarchical Index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>The Sword Project Class Hierarchy</h1>This inheritance list is sorted roughly, but not completely, alphabetically:<ul> +<li><a class="el" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a> +<ul> +<li><a class="el" href="class_markup_filter_mgr.html">MarkupFilterMgr</a> +</ul> +<li><a class="el" href="class_g_b_f_footnotes.html">GBFFootnotes</a> +<li><a class="el" href="class_g_b_f_headings.html">GBFHeadings</a> +<li><a class="el" href="class_g_b_f_h_t_m_l.html">GBFHTML</a> +<li><a class="el" href="class_g_b_f_h_t_m_l_h_r_e_f.html">GBFHTMLHREF</a> +<li><a class="el" href="class_g_b_f_morph.html">GBFMorph</a> +<li><a class="el" href="class_g_b_f_plain.html">GBFPlain</a> +<li><a class="el" href="class_g_b_f_r_t_f.html">GBFRTF</a> +<li><a class="el" href="class_g_b_f_strongs.html">GBFStrongs</a> +<li><a class="el" href="class_g_b_f_th_m_l.html">GBFThML</a> +<li><a class="el" href="class_latin1_u_t_f16.html">Latin1UTF16</a> +<li><a class="el" href="class_latin1_u_t_f8.html">Latin1UTF8</a> +<li><a class="el" href="class_locale_mgr.html">LocaleMgr</a> +<li><a class="el" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a> +<li><a class="el" href="class_p_l_a_i_n_h_t_m_l.html">PLAINHTML</a> +<li><a class="el" href="class_r_t_f_h_t_m_l.html">RTFHTML</a> +<li><a class="el" href="class_r_w_p_h_t_m_l.html">RWPHTML</a> +<li><a class="el" href="class_r_w_p_r_t_f.html">RWPRTF</a> +<li><a class="el" href="class_s_c_s_u_u_t_f8.html">SCSUUTF8</a> +<li><a class="el" href="class_s_w_class.html">SWClass</a> +<li><a class="el" href="class_s_w_config.html">SWConfig</a> +<li><a class="el" href="class_s_w_display.html">SWDisplay</a> +<li><a class="el" href="class_s_w_input_method.html">SWInputMethod</a> +<ul> +<li><a class="el" href="class_hebrew_m_c_i_m.html">HebrewMCIM</a> +</ul> +<li><a class="el" href="class_s_w_locale.html">SWLocale</a> +<li><a class="el" href="class_s_w_mgr.html">SWMgr</a> +<li><a class="el" href="class_s_w_module.html">SWModule</a> +<ul> +<li><a class="el" href="class_s_w_com.html">SWCom</a> +<li><a class="el" href="class_s_w_l_d.html">SWLD</a> +<li><a class="el" href="class_s_w_text.html">SWText</a> +</ul> +<li><a class="el" href="class_s_w_object.html">SWObject</a> +<ul> +<li><a class="el" href="class_s_w_key.html">SWKey</a> +<ul> +<li><a class="el" href="class_list_key.html">ListKey</a> +<li><a class="el" href="class_str_key.html">StrKey</a> +<li><a class="el" href="class_verse_key.html">VerseKey</a> +</ul> +</ul> +<li><a class="el" href="class_th_m_l_footnotes.html">ThMLFootnotes</a> +<li><a class="el" href="class_th_m_l_g_b_f.html">ThMLGBF</a> +<li><a class="el" href="class_th_m_l_headings.html">ThMLHeadings</a> +<li><a class="el" href="class_th_m_l_h_t_m_l.html">ThMLHTML</a> +<li><a class="el" href="class_th_m_l_h_t_m_l_h_r_e_f.html">ThMLHTMLHREF</a> +<li><a class="el" href="class_th_m_l_lemma.html">ThMLLemma</a> +<li><a class="el" href="class_th_m_l_morph.html">ThMLMorph</a> +<li><a class="el" href="class_th_m_l_o_l_b.html">ThMLOLB</a> +<li><a class="el" href="class_th_m_l_plain.html">ThMLPlain</a> +<li><a class="el" href="class_th_m_l_r_t_f.html">ThMLRTF</a> +<li><a class="el" href="class_th_m_l_scripref.html">ThMLScripref</a> +<li><a class="el" href="class_th_m_l_strongs.html">ThMLStrongs</a> +<li><a class="el" href="class_th_m_l_variants.html">ThMLVariants</a> +<li><a class="el" href="class_unicode_r_t_f.html">UnicodeRTF</a> +<li><a class="el" href="class_u_t_f16_u_t_f8.html">UTF16UTF8</a> +<li><a class="el" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a> +<li><a class="el" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a> +<li><a class="el" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a> +<li><a class="el" href="class_u_t_f8_h_t_m_l.html">UTF8HTML</a> +<li><a class="el" href="class_u_t_f8_latin1.html">UTF8Latin1</a> +<li><a class="el" href="class_u_t_f8_u_t_f16.html">UTF8UTF16</a> +</ul> +<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/hrefcom.h-source.html b/doc/api-documentation/html/hrefcom.h-source.html new file mode 100644 index 0000000..1e36113 --- /dev/null +++ b/doc/api-documentation/html/hrefcom.h-source.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>hrefcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>hrefcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * hrefcom.h - code for class 'HREFCom'- a module that produces HTML HREFs +</font>00003 <font class="comment"> * pointing to actual text desired. Uses standard +</font>00004 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * $Id: hrefcom.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00007 <font class="comment"> * +</font>00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00009 <font class="comment"> * CrossWire Bible Society +</font>00010 <font class="comment"> * P. O. Box 2528 +</font>00011 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00012 <font class="comment"> * +</font>00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00014 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00015 <font class="comment"> * Free Software Foundation version 2. +</font>00016 <font class="comment"> * +</font>00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00020 <font class="comment"> * General Public License for more details. +</font>00021 <font class="comment"> * +</font>00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef HREFCOM_H +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#define HREFCOM_H +</font>00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <rawverse.h></font> +00028 <font class="preprocessor">#include <swcom.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT HREFCom:<font class="keyword">public</font> RawVerse, <font class="keyword">public</font> <a class="code" href="class_swcom.html">SWCom</a> +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 <font class="keywordtype">char</font> *prefix; +00036 +00037 <font class="keyword">public</font>: +00038 +00039 +00040 HREFCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *prefix, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = +00041 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00042 <font class="keyword">virtual</font> ~ HREFCom (); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a19">getRawEntry</a> (); +00044 }; +00045 +00046 +00047 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/hrefcom_8h-source.html b/doc/api-documentation/html/hrefcom_8h-source.html new file mode 100644 index 0000000..16ea273 --- /dev/null +++ b/doc/api-documentation/html/hrefcom_8h-source.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>hrefcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>hrefcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * hrefcom.h - code for class 'HREFCom'- a module that produces HTML HREFs</font> +00003 <font class="comment"> * pointing to actual text desired. Uses standard</font> +00004 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: hrefcom_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef HREFCOM_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define HREFCOM_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <rawverse.h></font> +00028 <font class="preprocessor">#include <swcom.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT HREFCom:<font class="keyword">public</font> RawVerse, <font class="keyword">public</font> <a class="code" href="class_s_w_com.html">SWCom</a> +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 <font class="keywordtype">char</font> *prefix; +00036 +00037 <font class="keyword">public</font>: +00038 +00039 +00040 HREFCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *prefix, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = +00041 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0); +00042 <font class="keyword">virtual</font> ~ HREFCom (); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a25">getRawEntry</a> (); +00044 }; +00045 +00046 +00047 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/hrefcom_h-source.html b/doc/api-documentation/html/hrefcom_h-source.html new file mode 100644 index 0000000..cb3dec3 --- /dev/null +++ b/doc/api-documentation/html/hrefcom_h-source.html @@ -0,0 +1,63 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>hrefcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>hrefcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * hrefcom.h - code for class 'HREFCom'- a module that produces HTML HREFs</font> +00003 <font class="comment"> * pointing to actual text desired. Uses standard</font> +00004 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: hrefcom_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef HREFCOM_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define HREFCOM_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <rawverse.h></font> +00028 <font class="preprocessor">#include <swcom.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT HREFCom:<font class="keyword">public</font> RawVerse, <font class="keyword">public</font> <a class="code" href="class_swcom.html">SWCom</a> +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 <font class="keywordtype">char</font> *prefix; +00036 +00037 <font class="keyword">public</font>: +00038 +00039 +00040 HREFCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *prefix, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = +00041 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00042 <font class="keyword">virtual</font> ~ HREFCom (); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a21">getRawEntry</a> (); +00044 }; +00045 +00046 +00047 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/index.html b/doc/api-documentation/html/index.html new file mode 100644 index 0000000..ff981ae --- /dev/null +++ b/doc/api-documentation/html/index.html @@ -0,0 +1,27 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>The Sword Project 1.5.3 - API documentation</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>The Sword Project 1.5.3 - API documentation</h1> +<p> +<h3 align="center">1.5.3</h3> This is the API documentation of the Sword project. it describes the structure of the Sword library and documents the functions of the classes. From time to time this documentation gives programming examples, too. +<p> +Sword provides an interface to different modules (Bibles/Commentaries/Lexicons) on disk. The object to work directly with the modules is <a class="el" href="class_s_w_module.html">SWModule</a>. Use the class <a class="el" href="class_s_w_mgr.html">SWMgr</a> to manage the modules. +<p> +If you want to write your own frontend for Sword please have a look at the already existing ones. Well knwon frontends are:<br> + -BibleCS for Windows (the sourcecode is availble in the CVS of crosswire.org)<br> + -GnomeSword (<a href="http://gnomesword.sourceforge.net/">http://gnomesword.sourceforge.net/</a>)<br> + -BibleTime (<a href="http://www.bibletime.de/">http://www.bibletime.de/</a>)<br> + +<p> +<hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/latin1utf16_8h-source.html b/doc/api-documentation/html/latin1utf16_8h-source.html new file mode 100644 index 0000000..f87b322 --- /dev/null +++ b/doc/api-documentation/html/latin1utf16_8h-source.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>latin1utf16.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>latin1utf16.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef LATIN1UTF16_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define LATIN1UTF16_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_latin1_u_t_f16.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_latin1_u_t_f16.html">Latin1UTF16</a>:<font class="keyword">public</font> SWFilter { +00030 <font class="keyword">public</font>: +00031 Latin1UTF16(); +00032 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/latin1utf16_h-source.html b/doc/api-documentation/html/latin1utf16_h-source.html new file mode 100644 index 0000000..542e1b9 --- /dev/null +++ b/doc/api-documentation/html/latin1utf16_h-source.html @@ -0,0 +1,49 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>latin1utf16.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>latin1utf16.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef LATIN1UTF16_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define LATIN1UTF16_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_latin1utf16.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_latin1utf16.html">Latin1UTF16</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> { +00030 <font class="keyword">public</font>: +00031 Latin1UTF16(); +00032 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *key); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/latin1utf8_8h-source.html b/doc/api-documentation/html/latin1utf8_8h-source.html new file mode 100644 index 0000000..0d0587b --- /dev/null +++ b/doc/api-documentation/html/latin1utf8_8h-source.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>latin1utf8.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>latin1utf8.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef LATIN1UTF8_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define LATIN1UTF8_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_latin1_u_t_f8.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_latin1_u_t_f8.html">Latin1UTF8</a>:<font class="keyword">public</font> SWFilter { +00030 <font class="keyword">public</font>: +00031 Latin1UTF8(); +00032 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/latin1utf8_h-source.html b/doc/api-documentation/html/latin1utf8_h-source.html new file mode 100644 index 0000000..f3e4836 --- /dev/null +++ b/doc/api-documentation/html/latin1utf8_h-source.html @@ -0,0 +1,49 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>latin1utf8.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>latin1utf8.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef LATIN1UTF8_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define LATIN1UTF8_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_latin1utf8.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_latin1utf8.html">Latin1UTF8</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> { +00030 <font class="keyword">public</font>: +00031 Latin1UTF8(); +00032 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *key); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/listkey.h-source.html b/doc/api-documentation/html/listkey.h-source.html new file mode 100644 index 0000000..694019f --- /dev/null +++ b/doc/api-documentation/html/listkey.h-source.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>listkey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>listkey.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * listkey.h - code for base class 'listkey'. listkey is the basis for all +</font>00003 <font class="comment"> * types of keys for indexing into modules +</font>00004 <font class="comment"> * (e.g. verse, word, +</font>00005 <font class="comment"> * place, etc.) +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * $Id: listkey.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00008 <font class="comment"> * +</font>00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00010 <font class="comment"> * CrossWire Bible Society +</font>00011 <font class="comment"> * P. O. Box 2528 +</font>00012 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00015 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00016 <font class="comment"> * Free Software Foundation version 2. +</font>00017 <font class="comment"> * +</font>00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00021 <font class="comment"> * General Public License for more details. +</font>00022 <font class="comment"> * +</font>00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef SWLSTKEY_H +</font>00026 <font class="preprocessor"></font><font class="preprocessor">#define SWLSTKEY_H +</font>00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <swkey.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +<a name="l00036"></a><a class="code" href="class_listkey.html">00036</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_listkey.html">ListKey</a> : <font class="keyword">public</font> <a class="code" href="class_swkey.html">SWKey</a> { +00037 +00038 <font class="keyword">static</font> SWClass classdef; +00039 <font class="keywordtype">void</font> init (); +00040 <font class="keyword">protected</font>: +00041 <font class="keywordtype">int</font> arraypos; +00042 <font class="keywordtype">int</font> arraymax; +00043 <font class="keywordtype">int</font> arraycnt; +00044 <a class="code" href="class_swkey.html">SWKey</a> **array; +00045 <font class="keyword">public</font>: +00050 <a class="code" href="class_listkey.html#a0">ListKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00051 <a class="code" href="class_listkey.html#a0">ListKey</a> (<a class="code" href="class_listkey.html">ListKey</a> <font class="keyword">const</font> &k); +00054 <font class="keyword">virtual</font> <a class="code" href="class_listkey.html#a2">~ ListKey</a> (); +00055 +00056 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swkey.html#a3">clone</a> () <font class="keyword">const</font>; +00059 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_listkey.html#a4">ClearList</a> (); +00063 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_listkey.html#a5">Count</a> (); +00066 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_listkey.html#a6">Remove</a> (); +00072 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_listkey.html#a7">SetToElement</a> (<font class="keywordtype">int</font> ielement, SW_POSITION = TOP); +00078 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_listkey.html#a8">GetElement</a> (<font class="keywordtype">int</font> pos = -1); +00082 <font class="keyword">virtual</font> <a class="code" href="class_listkey.html">ListKey</a> &<a class="code" href="class_listkey.html#a9"> operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> &ikey); +00087 <font class="keyword">virtual</font> <a class="code" href="class_listkey.html">ListKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(<font class="keyword">const</font> <a class="code" href="class_listkey.html">ListKey</a> & ikey); +<a name="l00088"></a><a class="code" href="class_listkey.html#a11">00088</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey)<font class="keyword"> </font>{ <font class="keywordflow">return</font> SWKey::operator = +00089 (ikey);} +<a name="l00090"></a><a class="code" href="class_listkey.html#a12">00090</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> </font>{ <font class="keywordflow">return</font> SWKey::operator = +00091 (ikey);} +00097 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(SW_POSITION); +00100 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a18"> operator -= </a>(<font class="keywordtype">int</font> decrement); +00103 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a19"> operator += </a>(<font class="keywordtype">int</font> increment); +00104 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable ()<font class="keyword"> +</font>00105 <font class="keyword"> </font>{ +00106 <font class="keywordflow">return</font> 1; +00107 } +<a name="l00108"></a><a class="code" href="class_listkey.html#a17">00108</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a23">Index</a> ()<font class="keyword"> const +</font>00109 <font class="keyword"> </font>{ +00110 <font class="keywordflow">return</font> arraypos; +00111 } +<a name="l00116"></a><a class="code" href="class_listkey.html#a18">00116</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a23">Index</a> (<font class="keywordtype">long</font> index)<font class="keyword"> +</font>00117 <font class="keyword"> </font>{ +00118 <a class="code" href="class_listkey.html#a7">SetToElement</a> (index); +00119 <font class="keywordflow">return</font> <a class="code" href="class_swkey.html#a23">Index</a> (); +00120 } +00121 }; +00122 +00123 +00124 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/listkey_8h-source.html b/doc/api-documentation/html/listkey_8h-source.html new file mode 100644 index 0000000..25153b4 --- /dev/null +++ b/doc/api-documentation/html/listkey_8h-source.html @@ -0,0 +1,87 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>listkey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>listkey.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * listkey.h - code for base class 'listkey'. listkey is the basis for all</font> +00003 <font class="comment"> * types of keys for indexing into modules</font> +00004 <font class="comment"> * (e.g. verse, word,</font> +00005 <font class="comment"> * place, etc.)</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * $Id: listkey_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00010 <font class="comment"> * CrossWire Bible Society</font> +00011 <font class="comment"> * P. O. Box 2528</font> +00012 <font class="comment"> * Tempe, AZ 85280-2528</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00016 <font class="comment"> * Free Software Foundation version 2.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00021 <font class="comment"> * General Public License for more details.</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef SWLSTKEY_H</font> +00026 <font class="preprocessor"></font><font class="preprocessor">#define SWLSTKEY_H</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <swkey.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +<a name="l00036"></a><a class="code" href="class_list_key.html">00036</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_list_key.html">ListKey</a> : <font class="keyword">public</font> <a class="code" href="class_s_w_key.html">SWKey</a> { +00037 +00038 <font class="keyword">static</font> <a class="code" href="class_s_w_class.html">SWClass</a> classdef; +00039 <font class="keywordtype">void</font> init (); +00040 <font class="keyword">protected</font>: +00041 <font class="keywordtype">int</font> arraypos; +00042 <font class="keywordtype">int</font> arraymax; +00043 <font class="keywordtype">int</font> arraycnt; +00044 <a class="code" href="class_s_w_key.html">SWKey</a> **array; +00045 <font class="keyword">public</font>: +00050 <a class="code" href="class_list_key.html#a0">ListKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00051 <a class="code" href="class_list_key.html#a0">ListKey</a> (<a class="code" href="class_list_key.html">ListKey</a> <font class="keyword">const</font> &k); +00054 <font class="keyword">virtual</font> <a class="code" href="class_list_key.html#a2">~ ListKey</a> (); +00055 +00056 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> *<a class="code" href="class_s_w_key.html#a3">clone</a> () <font class="keyword">const</font>; +00059 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_list_key.html#a4">ClearList</a> (); +00063 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_list_key.html#a5">Count</a> (); +00066 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_list_key.html#a6">Remove</a> (); +00072 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_list_key.html#a7">SetToElement</a> (<font class="keywordtype">int</font> ielement, SW_POSITION = TOP); +00078 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> *<a class="code" href="class_list_key.html#a8">GetElement</a> (<font class="keywordtype">int</font> pos = -1); +<a name="l00082"></a><a class="code" href="class_list_key.html#a9">00082</a> <a class="code" href="class_list_key.html">ListKey</a> & <a class="code" href="class_list_key.html#a9">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> &ikey)<font class="keyword"> </font>{ add(ikey); <font class="keywordflow">return</font> *<font class="keyword">this</font>; } +00083 <font class="keyword">virtual</font> <font class="keywordtype">void</font> add(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> &ikey); +00084 +00089 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_list_key.html">ListKey</a> & ikey); +<a name="l00090"></a><a class="code" href="class_list_key.html#a12">00090</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> & ikey)<font class="keyword"> </font>{ <a class="code" href="class_s_w_key.html#a8">SWKey::copyFrom</a>(ikey); } +00091 +00097 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_list_key.html#a13">setPosition</a>(SW_POSITION); +00100 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a13">decrement</a>(<font class="keywordtype">int</font> step); +00103 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a14">increment</a>(<font class="keywordtype">int</font> step); +00104 +00105 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable ()<font class="keyword"> </font>{ <font class="keywordflow">return</font> 1; } +<a name="l00106"></a><a class="code" href="class_list_key.html#a17">00106</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_s_w_key.html#a16">Index</a> ()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> arraypos; } +00107 +<a name="l00112"></a><a class="code" href="class_list_key.html#a18">00112</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_s_w_key.html#a16">Index</a> (<font class="keywordtype">long</font> index)<font class="keyword"> </font>{ <a class="code" href="class_list_key.html#a7">SetToElement</a> (index); <font class="keywordflow">return</font> <a class="code" href="class_s_w_key.html#a16">Index</a> (); } +00113 +00114 SWKEY_OPERATORS +00115 <a class="code" href="class_list_key.html">ListKey</a> & operator =(<font class="keyword">const</font> <a class="code" href="class_list_key.html">ListKey</a> &key)<font class="keyword"> </font>{ <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(key); <font class="keywordflow">return</font> *<font class="keyword">this</font>; } +00116 }; +00117 +00118 +00119 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/listkey_h-source.html b/doc/api-documentation/html/listkey_h-source.html new file mode 100644 index 0000000..6d21910 --- /dev/null +++ b/doc/api-documentation/html/listkey_h-source.html @@ -0,0 +1,88 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>listkey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>listkey.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * listkey.h - code for base class 'listkey'. listkey is the basis for all</font> +00003 <font class="comment"> * types of keys for indexing into modules</font> +00004 <font class="comment"> * (e.g. verse, word,</font> +00005 <font class="comment"> * place, etc.)</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * $Id: listkey_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00010 <font class="comment"> * CrossWire Bible Society</font> +00011 <font class="comment"> * P. O. Box 2528</font> +00012 <font class="comment"> * Tempe, AZ 85280-2528</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00016 <font class="comment"> * Free Software Foundation version 2.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00021 <font class="comment"> * General Public License for more details.</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef SWLSTKEY_H</font> +00026 <font class="preprocessor"></font><font class="preprocessor">#define SWLSTKEY_H</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <swkey.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +<a name="l00036"></a><a class="code" href="class_listkey.html">00036</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_listkey.html">ListKey</a> : <font class="keyword">public</font> <a class="code" href="class_swkey.html">SWKey</a> { +00037 +00038 <font class="keyword">static</font> <a class="code" href="class_swclass.html">SWClass</a> classdef; +00039 <font class="keywordtype">void</font> init (); +00040 <font class="keyword">protected</font>: +00041 <font class="keywordtype">int</font> arraypos; +00042 <font class="keywordtype">int</font> arraymax; +00043 <font class="keywordtype">int</font> arraycnt; +00044 <a class="code" href="class_swkey.html">SWKey</a> **array; +00045 <font class="keyword">public</font>: +00050 <a class="code" href="class_listkey.html#a0">ListKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00051 <a class="code" href="class_listkey.html#a0">ListKey</a> (<a class="code" href="class_listkey.html">ListKey</a> <font class="keyword">const</font> &k); +00054 <font class="keyword">virtual</font> <a class="code" href="class_listkey.html#a2">~ ListKey</a> (); +00055 +00056 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swkey.html#a3">clone</a> () <font class="keyword">const</font>; +00059 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_listkey.html#a4">ClearList</a> (); +00063 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_listkey.html#a5">Count</a> (); +00066 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_listkey.html#a6">Remove</a> (); +00072 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_listkey.html#a7">SetToElement</a> (<font class="keywordtype">int</font> ielement, SW_POSITION = TOP); +00078 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_listkey.html#a8">GetElement</a> (<font class="keywordtype">int</font> pos = -1); +<a name="l00082"></a><a class="code" href="class_listkey.html#a9">00082</a> <a class="code" href="class_listkey.html">ListKey</a> & <a class="code" href="class_listkey.html#a9">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> &ikey)<font class="keyword"> </font>{ add(ikey); <font class="keywordflow">return</font> *<font class="keyword">this</font>; } +00083 <font class="keyword">virtual</font> <font class="keywordtype">void</font> add(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> &ikey); +00084 +00089 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_listkey.html">ListKey</a> & ikey); +<a name="l00090"></a><a class="code" href="class_listkey.html#a12">00090</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> </font>{ <a class="code" href="class_swkey.html#a8">SWKey::copyFrom</a>(ikey); } +00091 +00097 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_listkey.html#a13">setPosition</a>(SW_POSITION); +00100 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a13">decrement</a>(<font class="keywordtype">int</font> step); +00103 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a14">increment</a>(<font class="keywordtype">int</font> step); +00104 +00105 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable ()<font class="keyword"> </font>{ <font class="keywordflow">return</font> 1; } +<a name="l00106"></a><a class="code" href="class_listkey.html#a17">00106</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a16">Index</a> ()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> arraypos; } +00107 +<a name="l00112"></a><a class="code" href="class_listkey.html#a18">00112</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a16">Index</a> (<font class="keywordtype">long</font> index)<font class="keyword"> </font>{ <a class="code" href="class_listkey.html#a7">SetToElement</a> (index); <font class="keywordflow">return</font> <a class="code" href="class_swkey.html#a16">Index</a> (); } +00113 +00114 SWKEY_OPERATORS +00115 <a class="code" href="class_listkey.html">ListKey</a> & operator =(<font class="keyword">const</font> <a class="code" href="class_listkey.html">ListKey</a> &key)<font class="keyword"> </font>{ <a class="code" href="class_swkey.html#a8">copyFrom</a>(key); <font class="keywordflow">return</font> *<font class="keyword">this</font>; } +00116 }; +00117 +00118 +00119 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/localemgr.h-source.html b/doc/api-documentation/html/localemgr.h-source.html new file mode 100644 index 0000000..b2a16ac --- /dev/null +++ b/doc/api-documentation/html/localemgr.h-source.html @@ -0,0 +1,80 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>localemgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>localemgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * localemgr.h - definition of class LocaleMgr used to interact with +</font>00003 <font class="comment"> * registered locales for a sword installation +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: localemgr.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef LOCALEMGR_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define LOCALEMGR_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <string></font> +00027 <font class="preprocessor">#include <map></font> +00028 <font class="preprocessor">#include <list></font> +00029 <font class="preprocessor">#include <swconfig.h></font> +00030 <font class="preprocessor">#include <swlocale.h></font> +00031 +00032 <font class="preprocessor">#include <defs.h></font> +00033 +00034 <font class="comment">// using namespace std;</font> +00035 +00036 <font class="keyword">typedef</font> map < string, SWLocale *, less < string > >LocaleMap; +00037 +<a name="l00049"></a><a class="code" href="class_localemgr.html">00049</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_localemgr.html">LocaleMgr</a> +00050 { +00051 <font class="keyword">private</font>: +00052 <font class="keywordtype">void</font> deleteLocales (); +00053 <font class="keywordtype">char</font> *defaultLocaleName; +00054 +00055 <font class="keyword">protected</font>: +00056 LocaleMap locales; +00057 <font class="keyword">virtual</font> <font class="keywordtype">void</font> loadConfigDir (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath); +00058 +00059 <font class="keyword">public</font>: +00063 <a class="code" href="class_localemgr.html#a0">LocaleMgr</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *iConfigPath = 0); +00064 +00068 <font class="keyword">virtual</font> <a class="code" href="class_localemgr.html#a1">~ LocaleMgr</a> (); +00069 +00075 <font class="keyword">virtual</font> <a class="code" href="class_swlocale.html">SWLocale</a> *<a class="code" href="class_localemgr.html#a2">getLocale</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *name); +00076 +00081 <font class="keyword">virtual</font> list < string > <a class="code" href="class_localemgr.html#a3">getAvailableLocales</a> (); +00082 +00090 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_localemgr.html#a4">translate</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *name, <font class="keyword">const</font> <font class="keywordtype">char</font> *text); +00091 +00096 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_localemgr.html#a5">getDefaultLocaleName</a> (); +00097 +00102 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_localemgr.html#a6">setDefaultLocaleName</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *name); +00103 +<a name="l00107"></a><a class="code" href="class_localemgr.html#p0">00107</a> <font class="keyword">static</font> <a class="code" href="class_localemgr.html">LocaleMgr</a> systemLocaleMgr; +00108 }; +00109 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/localemgr_8h-source.html b/doc/api-documentation/html/localemgr_8h-source.html new file mode 100644 index 0000000..2de35a5 --- /dev/null +++ b/doc/api-documentation/html/localemgr_8h-source.html @@ -0,0 +1,80 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>localemgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>localemgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * localemgr.h - definition of class LocaleMgr used to interact with</font> +00003 <font class="comment"> * registered locales for a sword installation</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: localemgr_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef LOCALEMGR_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define LOCALEMGR_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <string></font> +00027 <font class="preprocessor">#include <map></font> +00028 <font class="preprocessor">#include <list></font> +00029 <font class="preprocessor">#include <swconfig.h></font> +00030 <font class="preprocessor">#include <swlocale.h></font> +00031 +00032 <font class="preprocessor">#include <defs.h></font> +00033 +00034 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00035 +00036 <font class="keyword">typedef</font> map < string, SWLocale *, less < string > >LocaleMap; +00037 +<a name="l00049"></a><a class="code" href="class_locale_mgr.html">00049</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_locale_mgr.html">LocaleMgr</a> +00050 { +00051 <font class="keyword">private</font>: +00052 <font class="keywordtype">void</font> deleteLocales (); +00053 <font class="keywordtype">char</font> *defaultLocaleName; +00054 +00055 <font class="keyword">protected</font>: +00056 LocaleMap locales; +00057 <font class="keyword">virtual</font> <font class="keywordtype">void</font> loadConfigDir (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath); +00058 +00059 <font class="keyword">public</font>: +00063 <a class="code" href="class_locale_mgr.html#a0">LocaleMgr</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *iConfigPath = 0); +00064 +00068 <font class="keyword">virtual</font> <a class="code" href="class_locale_mgr.html#a1">~ LocaleMgr</a> (); +00069 +00075 <font class="keyword">virtual</font> <a class="code" href="class_s_w_locale.html">SWLocale</a> *<a class="code" href="class_locale_mgr.html#a2">getLocale</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *name); +00076 +00081 <font class="keyword">virtual</font> list < string > <a class="code" href="class_locale_mgr.html#a3">getAvailableLocales</a> (); +00082 +00090 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_locale_mgr.html#a4">translate</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *name, <font class="keyword">const</font> <font class="keywordtype">char</font> *text); +00091 +00096 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_locale_mgr.html#a5">getDefaultLocaleName</a> (); +00097 +00102 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_locale_mgr.html#a6">setDefaultLocaleName</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *name); +00103 +<a name="l00107"></a><a class="code" href="class_locale_mgr.html#p0">00107</a> <font class="keyword">static</font> <a class="code" href="class_locale_mgr.html">LocaleMgr</a> systemLocaleMgr; +00108 }; +00109 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/localemgr_h-source.html b/doc/api-documentation/html/localemgr_h-source.html new file mode 100644 index 0000000..5b4c74d --- /dev/null +++ b/doc/api-documentation/html/localemgr_h-source.html @@ -0,0 +1,81 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>localemgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>localemgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * localemgr.h - definition of class LocaleMgr used to interact with</font> +00003 <font class="comment"> * registered locales for a sword installation</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: localemgr_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef LOCALEMGR_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define LOCALEMGR_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <string></font> +00027 <font class="preprocessor">#include <map></font> +00028 <font class="preprocessor">#include <list></font> +00029 <font class="preprocessor">#include <swconfig.h></font> +00030 <font class="preprocessor">#include <swlocale.h></font> +00031 +00032 <font class="preprocessor">#include <defs.h></font> +00033 +00034 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00035 +00036 <font class="keyword">typedef</font> map < string, SWLocale *, less < string > >LocaleMap; +00037 +<a name="l00049"></a><a class="code" href="class_localemgr.html">00049</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_localemgr.html">LocaleMgr</a> +00050 { +00051 <font class="keyword">private</font>: +00052 <font class="keywordtype">void</font> deleteLocales (); +00053 <font class="keywordtype">char</font> *defaultLocaleName; +00054 +00055 <font class="keyword">protected</font>: +00056 LocaleMap locales; +00057 <font class="keyword">virtual</font> <font class="keywordtype">void</font> loadConfigDir (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath); +00058 +00059 <font class="keyword">public</font>: +00063 <a class="code" href="class_localemgr.html#a0">LocaleMgr</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *iConfigPath = 0); +00064 +00068 <font class="keyword">virtual</font> <a class="code" href="class_localemgr.html#a1">~ LocaleMgr</a> (); +00069 +00075 <font class="keyword">virtual</font> <a class="code" href="class_swlocale.html">SWLocale</a> *<a class="code" href="class_localemgr.html#a2">getLocale</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *name); +00076 +00081 <font class="keyword">virtual</font> list < string > <a class="code" href="class_localemgr.html#a3">getAvailableLocales</a> (); +00082 +00090 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_localemgr.html#a4">translate</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *name, <font class="keyword">const</font> <font class="keywordtype">char</font> *text); +00091 +00096 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_localemgr.html#a5">getDefaultLocaleName</a> (); +00097 +00102 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_localemgr.html#a6">setDefaultLocaleName</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *name); +00103 +<a name="l00107"></a><a class="code" href="class_localemgr.html#p0">00107</a> <font class="keyword">static</font> <a class="code" href="class_localemgr.html">LocaleMgr</a> systemLocaleMgr; +00108 }; +00109 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/lzsscomprs.h-source.html b/doc/api-documentation/html/lzsscomprs.h-source.html new file mode 100644 index 0000000..6b066fa --- /dev/null +++ b/doc/api-documentation/html/lzsscomprs.h-source.html @@ -0,0 +1,94 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>lzsscomprs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>lzsscomprs.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * lzsscomprs.h - definition of Class SWCompress used for data compression +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: lzsscomprs.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef LZSSCOMPRS_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define LZSSCOMPRS_H +</font>00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swcomprs.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="comment">// The following are constant sizes used by the compression algorithm.</font> +00030 <font class="comment">//</font> +00031 <font class="comment">// N - This is the size of the ring buffer. It is set</font> +00032 <font class="comment">// to 4K. It is important to note that a position</font> +00033 <font class="comment">// within the ring buffer requires 12 bits. </font> +00034 <font class="comment">//</font> +00035 <font class="comment">// F - This is the maximum length of a character sequence</font> +00036 <font class="comment">// that can be taken from the ring buffer. It is set</font> +00037 <font class="comment">// to 18. Note that a length must be 3 before it is</font> +00038 <font class="comment">// worthwhile to store a position/length pair, so the</font> +00039 <font class="comment">// length can be encoded in only 4 bits. Or, put yet</font> +00040 <font class="comment">// another way, it is not necessary to encode a length</font> +00041 <font class="comment">// of 0-18, it is necessary to encode a length of</font> +00042 <font class="comment">// 3-18, which requires 4 bits.</font> +00043 <font class="comment">// </font> +00044 <font class="comment">// THRESHOLD - It takes 2 bytes to store an offset and</font> +00045 <font class="comment">// a length. If a character sequence only</font> +00046 <font class="comment">// requires 1 or 2 characters to store </font> +00047 <font class="comment">// uncompressed, then it is better to store</font> +00048 <font class="comment">// it uncompressed than as an offset into</font> +00049 <font class="comment">// the ring buffer.</font> +00050 <font class="comment">//</font> +00051 <font class="comment">// Note that the 12 bits used to store the position and the 4 bits</font> +00052 <font class="comment">// used to store the length equal a total of 16 bits, or 2 bytes.</font> +00053 +00054 <font class="preprocessor">#define N 4096 +</font>00055 <font class="preprocessor"></font><font class="preprocessor">#define F 18 +</font>00056 <font class="preprocessor"></font><font class="preprocessor">#define THRESHOLD 3 +</font>00057 <font class="preprocessor"></font><font class="preprocessor">#define NOT_USED N +</font>00058 <font class="preprocessor"></font> +00059 +00060 +00061 <font class="keyword">class </font>SWDLLEXPORT LZSSCompress:<font class="keyword">public</font> SWCompress +00062 { +00063 <font class="keyword">static</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> m_ring_buffer[N + F - 1]; +00064 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_match_position; +00065 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_match_length; +00066 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_lson[N + 1]; +00067 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_rson[N + 257]; +00068 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_dad[N + 1]; +00069 <font class="keywordtype">void</font> InitTree (); +00070 <font class="keywordtype">void</font> InsertNode (<font class="keywordtype">short</font> <font class="keywordtype">int</font> Pos); +00071 <font class="keywordtype">void</font> DeleteNode (<font class="keywordtype">short</font> <font class="keywordtype">int</font> Node); +00072 <font class="keyword">public</font>: +00073 LZSSCompress (); +00074 <font class="keyword">virtual</font> ~ LZSSCompress (); +00075 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); +00076 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); +00077 }; +00078 +00079 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/lzsscomprs_8h-source.html b/doc/api-documentation/html/lzsscomprs_8h-source.html new file mode 100644 index 0000000..3aa2383 --- /dev/null +++ b/doc/api-documentation/html/lzsscomprs_8h-source.html @@ -0,0 +1,94 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>lzsscomprs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>lzsscomprs.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * lzsscomprs.h - definition of Class SWCompress used for data compression</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: lzsscomprs_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef LZSSCOMPRS_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define LZSSCOMPRS_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swcomprs.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="comment">// The following are constant sizes used by the compression algorithm.</font> +00030 <font class="comment">//</font> +00031 <font class="comment">// N - This is the size of the ring buffer. It is set</font> +00032 <font class="comment">// to 4K. It is important to note that a position</font> +00033 <font class="comment">// within the ring buffer requires 12 bits. </font> +00034 <font class="comment">//</font> +00035 <font class="comment">// F - This is the maximum length of a character sequence</font> +00036 <font class="comment">// that can be taken from the ring buffer. It is set</font> +00037 <font class="comment">// to 18. Note that a length must be 3 before it is</font> +00038 <font class="comment">// worthwhile to store a position/length pair, so the</font> +00039 <font class="comment">// length can be encoded in only 4 bits. Or, put yet</font> +00040 <font class="comment">// another way, it is not necessary to encode a length</font> +00041 <font class="comment">// of 0-18, it is necessary to encode a length of</font> +00042 <font class="comment">// 3-18, which requires 4 bits.</font> +00043 <font class="comment">// </font> +00044 <font class="comment">// THRESHOLD - It takes 2 bytes to store an offset and</font> +00045 <font class="comment">// a length. If a character sequence only</font> +00046 <font class="comment">// requires 1 or 2 characters to store </font> +00047 <font class="comment">// uncompressed, then it is better to store</font> +00048 <font class="comment">// it uncompressed than as an offset into</font> +00049 <font class="comment">// the ring buffer.</font> +00050 <font class="comment">//</font> +00051 <font class="comment">// Note that the 12 bits used to store the position and the 4 bits</font> +00052 <font class="comment">// used to store the length equal a total of 16 bits, or 2 bytes.</font> +00053 +00054 <font class="preprocessor">#define N 4096</font> +00055 <font class="preprocessor"></font><font class="preprocessor">#define F 18</font> +00056 <font class="preprocessor"></font><font class="preprocessor">#define THRESHOLD 3</font> +00057 <font class="preprocessor"></font><font class="preprocessor">#define NOT_USED N</font> +00058 <font class="preprocessor"></font> +00059 +00060 +00061 <font class="keyword">class </font>SWDLLEXPORT LZSSCompress:<font class="keyword">public</font> SWCompress +00062 { +00063 <font class="keyword">static</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> m_ring_buffer[N + F - 1]; +00064 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_match_position; +00065 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_match_length; +00066 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_lson[N + 1]; +00067 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_rson[N + 257]; +00068 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_dad[N + 1]; +00069 <font class="keywordtype">void</font> InitTree (); +00070 <font class="keywordtype">void</font> InsertNode (<font class="keywordtype">short</font> <font class="keywordtype">int</font> Pos); +00071 <font class="keywordtype">void</font> DeleteNode (<font class="keywordtype">short</font> <font class="keywordtype">int</font> Node); +00072 <font class="keyword">public</font>: +00073 LZSSCompress (); +00074 <font class="keyword">virtual</font> ~ LZSSCompress (); +00075 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); +00076 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); +00077 }; +00078 +00079 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/lzsscomprs_h-source.html b/doc/api-documentation/html/lzsscomprs_h-source.html new file mode 100644 index 0000000..d5e7623 --- /dev/null +++ b/doc/api-documentation/html/lzsscomprs_h-source.html @@ -0,0 +1,95 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>lzsscomprs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>lzsscomprs.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * lzsscomprs.h - definition of Class SWCompress used for data compression</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: lzsscomprs_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef LZSSCOMPRS_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define LZSSCOMPRS_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swcomprs.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="comment">// The following are constant sizes used by the compression algorithm.</font> +00030 <font class="comment">//</font> +00031 <font class="comment">// N - This is the size of the ring buffer. It is set</font> +00032 <font class="comment">// to 4K. It is important to note that a position</font> +00033 <font class="comment">// within the ring buffer requires 12 bits. </font> +00034 <font class="comment">//</font> +00035 <font class="comment">// F - This is the maximum length of a character sequence</font> +00036 <font class="comment">// that can be taken from the ring buffer. It is set</font> +00037 <font class="comment">// to 18. Note that a length must be 3 before it is</font> +00038 <font class="comment">// worthwhile to store a position/length pair, so the</font> +00039 <font class="comment">// length can be encoded in only 4 bits. Or, put yet</font> +00040 <font class="comment">// another way, it is not necessary to encode a length</font> +00041 <font class="comment">// of 0-18, it is necessary to encode a length of</font> +00042 <font class="comment">// 3-18, which requires 4 bits.</font> +00043 <font class="comment">// </font> +00044 <font class="comment">// THRESHOLD - It takes 2 bytes to store an offset and</font> +00045 <font class="comment">// a length. If a character sequence only</font> +00046 <font class="comment">// requires 1 or 2 characters to store </font> +00047 <font class="comment">// uncompressed, then it is better to store</font> +00048 <font class="comment">// it uncompressed than as an offset into</font> +00049 <font class="comment">// the ring buffer.</font> +00050 <font class="comment">//</font> +00051 <font class="comment">// Note that the 12 bits used to store the position and the 4 bits</font> +00052 <font class="comment">// used to store the length equal a total of 16 bits, or 2 bytes.</font> +00053 +00054 <font class="preprocessor">#define N 4096</font> +00055 <font class="preprocessor"></font><font class="preprocessor">#define F 18</font> +00056 <font class="preprocessor"></font><font class="preprocessor">#define THRESHOLD 3</font> +00057 <font class="preprocessor"></font><font class="preprocessor">#define NOT_USED N</font> +00058 <font class="preprocessor"></font> +00059 +00060 +00061 <font class="keyword">class </font>SWDLLEXPORT LZSSCompress:<font class="keyword">public</font> SWCompress +00062 { +00063 <font class="keyword">static</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> m_ring_buffer[N + F - 1]; +00064 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_match_position; +00065 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_match_length; +00066 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_lson[N + 1]; +00067 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_rson[N + 257]; +00068 <font class="keyword">static</font> <font class="keywordtype">short</font> <font class="keywordtype">int</font> m_dad[N + 1]; +00069 <font class="keywordtype">void</font> InitTree (); +00070 <font class="keywordtype">void</font> InsertNode (<font class="keywordtype">short</font> <font class="keywordtype">int</font> Pos); +00071 <font class="keywordtype">void</font> DeleteNode (<font class="keywordtype">short</font> <font class="keywordtype">int</font> Node); +00072 <font class="keyword">public</font>: +00073 LZSSCompress (); +00074 <font class="keyword">virtual</font> ~ LZSSCompress (); +00075 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); +00076 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); +00077 }; +00078 +00079 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/markupfiltmgr_8h-source.html b/doc/api-documentation/html/markupfiltmgr_8h-source.html new file mode 100644 index 0000000..a6283dc --- /dev/null +++ b/doc/api-documentation/html/markupfiltmgr_8h-source.html @@ -0,0 +1,65 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>markupfiltmgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>markupfiltmgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swmarkupmgr.h - definition of class SWMarkupMgr, subclass of</font> +00003 <font class="comment"> * used to transcode all module text to a requested</font> +00004 <font class="comment"> * markup.</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef MARKUPFILTMGR_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define MARKUPFILTMGR_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <encfiltmgr.h></font> +00026 +<a name="l00031"></a><a class="code" href="class_markup_filter_mgr.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_markup_filter_mgr.html">MarkupFilterMgr</a> : <font class="keyword">public</font> <a class="code" href="class_encoding_filter_mgr.html">EncodingFilterMgr</a> { +00032 <font class="keyword">protected</font>: +00033 SWFilter* fromthml; +00034 SWFilter* fromgbf; +00035 SWFilter* fromplain; +00036 SWFilter* fromosis; +00037 +00038 <font class="comment">/*</font> +00039 <font class="comment"> * current markup value</font> +00040 <font class="comment"> */</font> +00041 <font class="keywordtype">char</font> markup; +00042 +00043 <font class="keywordtype">void</font> CreateFilters(<font class="keywordtype">char</font> markup); +00044 <font class="keyword">public</font>: +00053 <a class="code" href="class_markup_filter_mgr.html#a0">MarkupFilterMgr</a>(<font class="keywordtype">char</font> markup = FMT_THML, <font class="keywordtype">char</font> encoding = ENC_UTF8); +00054 +00058 <a class="code" href="class_markup_filter_mgr.html#a1">~MarkupFilterMgr</a>(); +00059 +00065 <font class="keywordtype">char</font> <a class="code" href="class_markup_filter_mgr.html#a2">Markup</a>(<font class="keywordtype">char</font> m = FMT_UNKNOWN); +00066 +00072 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_markup_filter_mgr.html#a3">AddRenderFilters</a>(<a class="code" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section); +00073 }; +00074 +00075 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/null.gif b/doc/api-documentation/html/null.gif Binary files differnew file mode 100644 index 0000000..1d11fa9 --- /dev/null +++ b/doc/api-documentation/html/null.gif diff --git a/doc/api-documentation/html/pages.html b/doc/api-documentation/html/pages.html new file mode 100644 index 0000000..f41de99 --- /dev/null +++ b/doc/api-documentation/html/pages.html @@ -0,0 +1,19 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>Page Index</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu Apr 19 16:40:35 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center> +<hr><h1>The Sword Project Related Pages</h1>Here is a list of all related documentation pages:<ul> +<li><a class="el" href="frontend.html">How to write a frontend for the Sword library</a> + +</ul> +<hr><address><small>Generated at Thu Apr 19 16:40:35 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/plainfootnotes.h-source.html b/doc/api-documentation/html/plainfootnotes.h-source.html new file mode 100644 index 0000000..8fdf9ff --- /dev/null +++ b/doc/api-documentation/html/plainfootnotes.h-source.html @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>plainfootnotes.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>plainfootnotes.h</h1><div class="fragment"><pre>00001 <font class="comment">/*************************************************************************** +</font>00002 <font class="comment"> plainfootnotes.h - description +</font>00003 <font class="comment"> ------------------- +</font>00004 <font class="comment"> begin : Wed Oct 13 1999 +</font>00005 <font class="comment"> copyright : (C) 1999 by The team of BibleTime +</font>00006 <font class="comment"> email : info@bibletime.de +</font>00007 <font class="comment"> ***************************************************************************/</font> +00008 +00009 <font class="comment">/*************************************************************************** +</font>00010 <font class="comment"> * * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify * +</font>00012 <font class="comment"> * it under the terms of the GNU General Public License as published by * +</font>00013 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or * +</font>00014 <font class="comment"> * (at your option) any later version. * +</font>00015 <font class="comment"> * * +</font>00016 <font class="comment"> ***************************************************************************/</font> +00017 +00018 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/plainfootnotes.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ */</font> +00019 <font class="comment">/* $Revision: 1.10 $ */</font> +00020 +00021 <font class="preprocessor">#ifndef PLAINFOOTNOTES_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define PLAINFOOTNOTES_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <defs.h></font> +00025 +00026 <font class="keyword">class </font>QObject; +00027 <font class="preprocessor">#include <swfilter.h></font> +00028 <font class="keyword">class </font><a class="code" href="class_swkey.html">SWKey</a>; +00029 +<a name="l00033"></a><a class="code" href="class_plainfootnotes.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_plainfootnotes.html">PLAINFootnotes</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00034 { +00035 <font class="keywordtype">bool</font> option; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00037 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00038 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00039 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00040 OptionsList options; +00041 +00042 <font class="keyword">public</font>: +00043 PLAINFootnotes (); +00044 <font class="keyword">virtual</font> ~ PLAINFootnotes (); +00045 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key = +00046 0); +<a name="l00047"></a><a class="code" href="class_plainfootnotes.html#a3">00047</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"> +</font>00048 <font class="keyword"> </font>{ +00049 <font class="keywordflow">return</font> optName; +00050 } +<a name="l00051"></a><a class="code" href="class_plainfootnotes.html#a4">00051</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"> +</font>00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> optTip; +00054 } +00055 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00056 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00057"></a><a class="code" href="class_plainfootnotes.html#a7">00057</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"> +</font>00058 <font class="keyword"> </font>{ +00059 <font class="keywordflow">return</font> options; +00060 } +00061 }; +00062 +00063 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/plainfootnotes_8h-source.html b/doc/api-documentation/html/plainfootnotes_8h-source.html new file mode 100644 index 0000000..a887587 --- /dev/null +++ b/doc/api-documentation/html/plainfootnotes_8h-source.html @@ -0,0 +1,74 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>plainfootnotes.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>plainfootnotes.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> plainfootnotes.h - description </font> +00003 <font class="comment"> ------------------- </font> +00004 <font class="comment"> begin : Wed Oct 13 1999 </font> +00005 <font class="comment"> copyright : (C) 1999 by The team of BibleTime </font> +00006 <font class="comment"> email : info@bibletime.de </font> +00007 <font class="comment"> ***************************************************************************/</font> +00008 +00009 <font class="comment">/***************************************************************************</font> +00010 <font class="comment"> * *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00012 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00013 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00014 <font class="comment"> * (at your option) any later version. * </font> +00015 <font class="comment"> * *</font> +00016 <font class="comment"> ***************************************************************************/</font> +00017 +00018 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/plainfootnotes_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $ */</font> +00019 <font class="comment">/* $Revision: 1.4 $ */</font> +00020 +00021 <font class="preprocessor">#ifndef PLAINFOOTNOTES_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define PLAINFOOTNOTES_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <defs.h></font> +00025 +00026 <font class="keyword">class </font>QObject; +00027 <font class="preprocessor">#include <swfilter.h></font> +00028 <font class="keyword">class </font><a class="code" href="class_s_w_key.html">SWKey</a>; +00029 +<a name="l00033"></a><a class="code" href="class_p_l_a_i_n_footnotes.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_p_l_a_i_n_footnotes.html">PLAINFootnotes</a>:<font class="keyword">public</font> SWFilter +00034 { +00035 <font class="keywordtype">bool</font> option; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00037 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00038 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00039 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00040 OptionsList options; +00041 +00042 <font class="keyword">public</font>: +00043 PLAINFootnotes (); +00044 <font class="keyword">virtual</font> ~ PLAINFootnotes (); +00045 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00046 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optName; +00049 } +00050 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00051 <font class="keyword"> </font>{ +00052 <font class="keywordflow">return</font> optTip; +00053 } +00054 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00055 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00056 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00057 <font class="keyword"> </font>{ +00058 <font class="keywordflow">return</font> options; +00059 } +00060 }; +00061 +00062 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/plainfootnotes_h-source.html b/doc/api-documentation/html/plainfootnotes_h-source.html new file mode 100644 index 0000000..91aaf01 --- /dev/null +++ b/doc/api-documentation/html/plainfootnotes_h-source.html @@ -0,0 +1,76 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>plainfootnotes.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>plainfootnotes.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> plainfootnotes.h - description </font> +00003 <font class="comment"> ------------------- </font> +00004 <font class="comment"> begin : Wed Oct 13 1999 </font> +00005 <font class="comment"> copyright : (C) 1999 by The team of BibleTime </font> +00006 <font class="comment"> email : info@bibletime.de </font> +00007 <font class="comment"> ***************************************************************************/</font> +00008 +00009 <font class="comment">/***************************************************************************</font> +00010 <font class="comment"> * *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00012 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00013 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00014 <font class="comment"> * (at your option) any later version. * </font> +00015 <font class="comment"> * *</font> +00016 <font class="comment"> ***************************************************************************/</font> +00017 +00018 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/plainfootnotes_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $ */</font> +00019 <font class="comment">/* $Revision: 1.4 $ */</font> +00020 +00021 <font class="preprocessor">#ifndef PLAINFOOTNOTES_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define PLAINFOOTNOTES_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <defs.h></font> +00025 +00026 <font class="keyword">class </font>QObject; +00027 <font class="preprocessor">#include <swfilter.h></font> +00028 <font class="keyword">class </font><a class="code" href="class_swkey.html">SWKey</a>; +00029 +<a name="l00033"></a><a class="code" href="class_plainfootnotes.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_plainfootnotes.html">PLAINFootnotes</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00034 { +00035 <font class="keywordtype">bool</font> option; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00037 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00038 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00039 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00040 OptionsList options; +00041 +00042 <font class="keyword">public</font>: +00043 PLAINFootnotes (); +00044 <font class="keyword">virtual</font> ~ PLAINFootnotes (); +00045 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key = +00046 0); +<a name="l00047"></a><a class="code" href="class_plainfootnotes.html#a3">00047</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"></font> +00048 <font class="keyword"> </font>{ +00049 <font class="keywordflow">return</font> optName; +00050 } +<a name="l00051"></a><a class="code" href="class_plainfootnotes.html#a4">00051</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> optTip; +00054 } +00055 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00056 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00057"></a><a class="code" href="class_plainfootnotes.html#a7">00057</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"></font> +00058 <font class="keyword"> </font>{ +00059 <font class="keywordflow">return</font> options; +00060 } +00061 }; +00062 +00063 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/plainhtml.h-source.html b/doc/api-documentation/html/plainhtml.h-source.html new file mode 100644 index 0000000..26c2660 --- /dev/null +++ b/doc/api-documentation/html/plainhtml.h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>plainhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>plainhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/*************************************************************************** +</font>00002 <font class="comment"> rwphtml.h - description +</font>00003 <font class="comment"> ------------------- +</font>00004 <font class="comment"> begin : Tue Jun 15 15:34:26 CEST 1999 +</font>00005 <font class="comment"> +</font>00006 <font class="comment"> copyright : (C) 1999 by Torsten Uhlmann +</font>00007 <font class="comment"> email : TUhlmann@gmx.de +</font>00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/*************************************************************************** +</font>00011 <font class="comment"> * * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify * +</font>00013 <font class="comment"> * it under the terms of the GNU General Public License as published by * +</font>00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or * +</font>00015 <font class="comment"> * (at your option) any later version. * +</font>00016 <font class="comment"> * * +</font>00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/plainhtml.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ */</font> +00020 <font class="comment">/* $Revision: 1.10 $ */</font> +00021 +00022 <font class="preprocessor">#ifndef PLAINHTML_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define PLAINHTML_H +</font>00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swfilter.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +<a name="l00031"></a><a class="code" href="class_plainhtml.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_plainhtml.html">PLAINHTML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00032 { +00033 <font class="keyword">public</font>: +00034 PLAINHTML (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00036 }; +00037 +00038 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/plainhtml_8h-source.html b/doc/api-documentation/html/plainhtml_8h-source.html new file mode 100644 index 0000000..3e49f87 --- /dev/null +++ b/doc/api-documentation/html/plainhtml_8h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>plainhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>plainhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> rwphtml.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : Tue Jun 15 15:34:26 CEST 1999</font> +00005 <font class="comment"></font> +00006 <font class="comment"> copyright : (C) 1999 by Torsten Uhlmann</font> +00007 <font class="comment"> email : TUhlmann@gmx.de</font> +00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/***************************************************************************</font> +00011 <font class="comment"> * *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00013 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00015 <font class="comment"> * (at your option) any later version. *</font> +00016 <font class="comment"> * *</font> +00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/plainhtml_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $ */</font> +00020 <font class="comment">/* $Revision: 1.4 $ */</font> +00021 +00022 <font class="preprocessor">#ifndef PLAINHTML_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define PLAINHTML_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swfilter.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +<a name="l00031"></a><a class="code" href="class_p_l_a_i_n_h_t_m_l.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_p_l_a_i_n_h_t_m_l.html">PLAINHTML</a>:<font class="keyword">public</font> SWFilter +00032 { +00033 <font class="keyword">public</font>: +00034 PLAINHTML (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00036 }; +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/plainhtml_h-source.html b/doc/api-documentation/html/plainhtml_h-source.html new file mode 100644 index 0000000..042152a --- /dev/null +++ b/doc/api-documentation/html/plainhtml_h-source.html @@ -0,0 +1,52 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>plainhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>plainhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> rwphtml.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : Tue Jun 15 15:34:26 CEST 1999</font> +00005 <font class="comment"></font> +00006 <font class="comment"> copyright : (C) 1999 by Torsten Uhlmann</font> +00007 <font class="comment"> email : TUhlmann@gmx.de</font> +00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/***************************************************************************</font> +00011 <font class="comment"> * *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00013 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00015 <font class="comment"> * (at your option) any later version. *</font> +00016 <font class="comment"> * *</font> +00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/plainhtml_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $ */</font> +00020 <font class="comment">/* $Revision: 1.4 $ */</font> +00021 +00022 <font class="preprocessor">#ifndef PLAINHTML_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define PLAINHTML_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swfilter.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +<a name="l00031"></a><a class="code" href="class_plainhtml.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_plainhtml.html">PLAINHTML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00032 { +00033 <font class="keyword">public</font>: +00034 PLAINHTML (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00036 }; +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawcom.h-source.html b/doc/api-documentation/html/rawcom.h-source.html new file mode 100644 index 0000000..30c474f --- /dev/null +++ b/doc/api-documentation/html/rawcom.h-source.html @@ -0,0 +1,66 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rawcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * rawcom.h - code for class 'RawCom'- a module that reads raw commentary +</font>00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: rawcom.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWCOM_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWCOM_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <swcom.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT RawCom:<font class="keyword">public</font> RawVerse, <font class="keyword">public</font> <a class="code" href="class_swcom.html">SWCom</a> +00032 { +00033 <font class="keywordtype">char</font> *versebuf; +00034 +00035 <font class="keyword">public</font>: +00036 +00037 +00038 RawCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00039 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00040 <font class="keyword">virtual</font> ~ RawCom (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a19">getRawEntry</a> (); +00042 +00043 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a27"> operator += </a>(<font class="keywordtype">int</font> increment); +00044 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a26"> operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"> +</font>00045 <font class="keyword"> </font>{ +00046 <font class="keywordflow">return</font> this-><a class="code" href="class_swmodule.html#a27">operator += </a>(-decrement); +00047 } +00048 }; +00049 +00050 +00051 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawcom_8h-source.html b/doc/api-documentation/html/rawcom_8h-source.html new file mode 100644 index 0000000..ccccb1c --- /dev/null +++ b/doc/api-documentation/html/rawcom_8h-source.html @@ -0,0 +1,79 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawcom.h - code for class 'RawCom'- a module that reads raw commentary</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: rawcom_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWCOM_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWCOM_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <swcom.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT RawCom:<font class="keyword">public</font> RawVerse, <font class="keyword">public</font> <a class="code" href="class_s_w_com.html">SWCom</a> { +00032 <font class="keywordtype">char</font> *versebuf; +00033 +00034 <font class="keyword">public</font>: +00035 +00036 +00037 RawCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = 0, +00038 <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, +00039 <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); +00040 <font class="keyword">virtual</font> ~ RawCom (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a25">getRawEntry</a> (); +00042 +00043 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a34">operator += </a>(<font class="keywordtype">int</font> increment); +00044 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a33">operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"> </font>{ +00045 <font class="keywordflow">return</font> this-><a class="code" href="class_s_w_module.html#a34">operator += </a>(-decrement); +00046 } +00047 +00048 <font class="comment">// write interface ----------------------------</font> +00049 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a28">isWritable</a> ()<font class="keyword"></font> +00050 <font class="keyword"> </font>{ +00051 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00052 } +00053 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path)<font class="keyword"></font> +00054 <font class="keyword"> </font>{ +00055 <font class="keywordflow">return</font> RawVerse::createModule (path); +00056 } +00057 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a29">setentry</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf, <font class="keywordtype">long</font> len); <font class="comment">// Modify current module entry</font> +00058 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00059 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00060 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a32">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00061 <font class="comment">// end write interface ------------------------</font> +00062 +00063 }; +00064 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawcom_h-source.html b/doc/api-documentation/html/rawcom_h-source.html new file mode 100644 index 0000000..a864af8 --- /dev/null +++ b/doc/api-documentation/html/rawcom_h-source.html @@ -0,0 +1,65 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawcom.h - code for class 'RawCom'- a module that reads raw commentary</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: rawcom_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWCOM_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWCOM_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <swcom.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT RawCom:<font class="keyword">public</font> RawVerse, <font class="keyword">public</font> <a class="code" href="class_swcom.html">SWCom</a> { +00032 <font class="keywordtype">char</font> *versebuf; +00033 +00034 <font class="keyword">public</font>: +00035 +00036 +00037 RawCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = 0, +00038 <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00039 <font class="keyword">virtual</font> ~ RawCom (); +00040 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a21">getRawEntry</a> (); +00041 +00042 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a29">operator += </a>(<font class="keywordtype">int</font> increment); +00043 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a28">operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> this-><a class="code" href="class_swmodule.html#a29">operator += </a>(-decrement); +00045 } +00046 }; +00047 +00048 +00049 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawfiles.h-source.html b/doc/api-documentation/html/rawfiles.h-source.html new file mode 100644 index 0000000..166f32b --- /dev/null +++ b/doc/api-documentation/html/rawfiles.h-source.html @@ -0,0 +1,77 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rawfiles.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawfiles.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * rawfiles.h - code for class 'RawFiles'- a module that produces HTML HREFs +</font>00003 <font class="comment"> * pointing to actual text desired. Uses standard +</font>00004 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * $Id: rawfiles.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00007 <font class="comment"> * +</font>00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00009 <font class="comment"> * CrossWire Bible Society +</font>00010 <font class="comment"> * P. O. Box 2528 +</font>00011 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00012 <font class="comment"> * +</font>00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00014 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00015 <font class="comment"> * Free Software Foundation version 2. +</font>00016 <font class="comment"> * +</font>00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00020 <font class="comment"> * General Public License for more details. +</font>00021 <font class="comment"> * +</font>00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef RAWFILES_H +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#define RAWFILES_H +</font>00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <rawverse.h></font> +00028 <font class="preprocessor">#include <swcom.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawFiles:<font class="keyword">public</font> RawVerse, <font class="keyword">public</font> <a class="code" href="class_swcom.html">SWCom</a> +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 +00036 <font class="keywordtype">char</font> *getnextfilename (); +00037 +00038 <font class="keyword">public</font>: +00039 +00040 +00041 RawFiles (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00042 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00043 <font class="keyword">virtual</font> ~ RawFiles (); +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a19">getRawEntry</a> (); +00045 +00046 <font class="comment">// write interface ---------------------------- +</font>00050 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a22">isWritable</a> ()<font class="keyword"> </font>{ +00051 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00052 } +00053 +00058 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *); +00059 +00064 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *); +00065 +00070 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *); +00071 +00075 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a25">deleteEntry</a> (); +00076 <font class="comment">// end write interface ------------------------</font> +00077 }; +00078 +00079 +00080 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawfiles_8h-source.html b/doc/api-documentation/html/rawfiles_8h-source.html new file mode 100644 index 0000000..75d39e5 --- /dev/null +++ b/doc/api-documentation/html/rawfiles_8h-source.html @@ -0,0 +1,78 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawfiles.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawfiles.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawfiles.h - code for class 'RawFiles'- a module that produces HTML HREFs</font> +00003 <font class="comment"> * pointing to actual text desired. Uses standard</font> +00004 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: rawfiles_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef RAWFILES_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define RAWFILES_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <rawverse.h></font> +00028 <font class="preprocessor">#include <swcom.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawFiles:<font class="keyword">public</font> RawVerse, <font class="keyword">public</font> <a class="code" href="class_s_w_com.html">SWCom</a> +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 +00036 <font class="keywordtype">char</font> *getnextfilename (); +00037 +00038 <font class="keyword">public</font>: +00039 +00040 +00041 RawFiles (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00042 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, +00043 <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); +00044 <font class="keyword">virtual</font> ~RawFiles (); +00045 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a25">getRawEntry</a> (); +00046 +00047 <font class="comment">// write interface ----------------------------</font> +00051 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a28">isWritable</a> ()<font class="keyword"> </font>{ +00052 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00053 } +00054 +00059 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *); +00060 +00065 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *); +00066 +00071 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *); +00072 +00076 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a32">deleteEntry</a> (); +00077 <font class="comment">// end write interface ------------------------</font> +00078 }; +00079 +00080 +00081 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawfiles_h-source.html b/doc/api-documentation/html/rawfiles_h-source.html new file mode 100644 index 0000000..60b1da7 --- /dev/null +++ b/doc/api-documentation/html/rawfiles_h-source.html @@ -0,0 +1,78 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawfiles.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawfiles.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawfiles.h - code for class 'RawFiles'- a module that produces HTML HREFs</font> +00003 <font class="comment"> * pointing to actual text desired. Uses standard</font> +00004 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: rawfiles_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef RAWFILES_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define RAWFILES_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <rawverse.h></font> +00028 <font class="preprocessor">#include <swcom.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawFiles:<font class="keyword">public</font> RawVerse, <font class="keyword">public</font> <a class="code" href="class_swcom.html">SWCom</a> +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 +00036 <font class="keywordtype">char</font> *getnextfilename (); +00037 +00038 <font class="keyword">public</font>: +00039 +00040 +00041 RawFiles (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00042 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00043 <font class="keyword">virtual</font> ~RawFiles (); +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a21">getRawEntry</a> (); +00045 +00046 <font class="comment">// write interface ----------------------------</font> +00050 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a24">isWritable</a> ()<font class="keyword"> </font>{ +00051 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00052 } +00053 +00058 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *); +00059 +00064 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *); +00065 +00070 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *); +00071 +00075 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a27">deleteEntry</a> (); +00076 <font class="comment">// end write interface ------------------------</font> +00077 }; +00078 +00079 +00080 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawgbf.h-source.html b/doc/api-documentation/html/rawgbf.h-source.html new file mode 100644 index 0000000..713b6f1 --- /dev/null +++ b/doc/api-documentation/html/rawgbf.h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rawgbf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawgbf.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * rawgbf.h - code for class 'RawGBF'- a module that reads raw text files: +</font>00003 <font class="comment"> * ot and nt using indexs ??.bks ??.cps ??.vss +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: rawgbf.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWGBF_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWGBF_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <swtext.h></font> +00028 <font class="preprocessor">#include <swfilter.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawGBF:<font class="keyword">public</font> <a class="code" href="class_swtext.html">SWText</a>, <font class="keyword">public</font> RawVerse +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 +00036 <font class="keyword">public</font>: +00037 +00038 +00039 RawGBF (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00040 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00041 <font class="keyword">virtual</font> ~ RawGBF (); +00042 <font class="keyword">virtual</font> operator char *(); +00043 }; +00044 +00045 +00046 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawgbf_8h-source.html b/doc/api-documentation/html/rawgbf_8h-source.html new file mode 100644 index 0000000..3f9b9d8 --- /dev/null +++ b/doc/api-documentation/html/rawgbf_8h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawgbf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawgbf.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawgbf.h - code for class 'RawGBF'- a module that reads raw text files:</font> +00003 <font class="comment"> * ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: rawgbf_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWGBF_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWGBF_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <swtext.h></font> +00028 <font class="preprocessor">#include <swfilter.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawGBF:<font class="keyword">public</font> <a class="code" href="class_s_w_text.html">SWText</a>, <font class="keyword">public</font> RawVerse +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 +00036 <font class="keyword">public</font>: +00037 +00038 +00039 RawGBF (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00040 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0); +00041 <font class="keyword">virtual</font> ~ RawGBF (); +00042 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html#a24">operator char *</a>(); +00043 }; +00044 +00045 +00046 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawgbf_h-source.html b/doc/api-documentation/html/rawgbf_h-source.html new file mode 100644 index 0000000..3901dea --- /dev/null +++ b/doc/api-documentation/html/rawgbf_h-source.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawgbf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawgbf.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawgbf.h - code for class 'RawGBF'- a module that reads raw text files:</font> +00003 <font class="comment"> * ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: rawgbf_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWGBF_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWGBF_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <swtext.h></font> +00028 <font class="preprocessor">#include <swfilter.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawGBF:<font class="keyword">public</font> <a class="code" href="class_swtext.html">SWText</a>, <font class="keyword">public</font> RawVerse +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 +00036 <font class="keyword">public</font>: +00037 +00038 +00039 RawGBF (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00040 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00041 <font class="keyword">virtual</font> ~ RawGBF (); +00042 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html#a20">operator char *</a>(); +00043 }; +00044 +00045 +00046 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawld.h-source.html b/doc/api-documentation/html/rawld.h-source.html new file mode 100644 index 0000000..eed0cbc --- /dev/null +++ b/doc/api-documentation/html/rawld.h-source.html @@ -0,0 +1,81 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rawld.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawld.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * rawld.cpp - code for class 'RawLD'- a module that reads raw lexicon and +</font>00003 <font class="comment"> * dictionary files: *.dat *.idx +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: rawld.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWLD_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWLD_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawstr.h></font> +00027 <font class="preprocessor">#include <swld.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT RawLD:<font class="keyword">public</font> RawStr, <font class="keyword">public</font> <a class="code" href="class_swld.html">SWLD</a> +00032 { +00033 <font class="keywordtype">void</font> strongsPad (<font class="keywordtype">char</font> *buf); +00034 <font class="keywordtype">char</font> getEntry (<font class="keywordtype">long</font> away = 0); +00035 +00036 <font class="keyword">public</font>: +00037 +00038 +00039 RawLD (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00040 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00041 <font class="keyword">virtual</font> ~ RawLD (); +00042 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a19">getRawEntry</a> (); +00043 +00044 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a30"> operator = </a>(SW_POSITION pos); +00045 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a27"> operator += </a>(<font class="keywordtype">int</font> increment); +00046 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a26"> operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"> +</font>00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> this-><a class="code" href="class_swmodule.html#a27">operator += </a>(-decrement); +00049 } +00050 <font class="comment">// write interface ----------------------------</font> +00051 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a22">isWritable</a> ()<font class="keyword"> +</font>00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00054 } +00055 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path)<font class="keyword"> +</font>00056 <font class="keyword"> </font>{ +00057 <font class="keywordflow">return</font> RawStr::createModule (path); +00058 } +00059 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00060 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00061 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a25">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00062 <font class="comment">// end write interface ------------------------</font> +00063 }; +00064 +00065 +00066 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawld4.h-source.html b/doc/api-documentation/html/rawld4.h-source.html new file mode 100644 index 0000000..c32a058 --- /dev/null +++ b/doc/api-documentation/html/rawld4.h-source.html @@ -0,0 +1,81 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rawld4.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawld4.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * rawld.cpp - code for class 'RawLD'- a module that reads raw lexicon and +</font>00003 <font class="comment"> * dictionary files: *.dat *.idx +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: rawld4.h-source.html,v 1.1 2001/05/25 10:50:59 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWLD4_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWLD4_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawstr4.h></font> +00027 <font class="preprocessor">#include <swld.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT RawLD4:<font class="keyword">public</font> RawStr4, <font class="keyword">public</font> <a class="code" href="class_swld.html">SWLD</a> +00032 { +00033 <font class="keywordtype">void</font> strongsPad (<font class="keywordtype">char</font> *buf); +00034 <font class="keywordtype">char</font> getEntry (<font class="keywordtype">long</font> away = 0); +00035 +00036 <font class="keyword">public</font>: +00037 +00038 +00039 RawLD4(<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00040 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00041 <font class="keyword">virtual</font> ~ RawLD4(); +00042 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a19">getRawEntry</a> (); +00043 +00044 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a30"> operator = </a>(SW_POSITION pos); +00045 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a27"> operator += </a>(<font class="keywordtype">int</font> increment); +00046 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a26"> operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"> +</font>00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> this-><a class="code" href="class_swmodule.html#a27">operator += </a>(-decrement); +00049 } +00050 <font class="comment">// write interface ----------------------------</font> +00051 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a22">isWritable</a> ()<font class="keyword"> +</font>00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00054 } +00055 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path)<font class="keyword"> +</font>00056 <font class="keyword"> </font>{ +00057 <font class="keywordflow">return</font> RawStr4::createModule (path); +00058 } +00059 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00060 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00061 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a25">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00062 <font class="comment">// end write interface ------------------------</font> +00063 }; +00064 +00065 +00066 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawld4_8h-source.html b/doc/api-documentation/html/rawld4_8h-source.html new file mode 100644 index 0000000..c4e3c3f --- /dev/null +++ b/doc/api-documentation/html/rawld4_8h-source.html @@ -0,0 +1,79 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawld4.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawld4.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawld.cpp - code for class 'RawLD'- a module that reads raw lexicon and</font> +00003 <font class="comment"> * dictionary files: *.dat *.idx</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: rawld4_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWLD4_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWLD4_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawstr4.h></font> +00027 <font class="preprocessor">#include <swld.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT RawLD4:<font class="keyword">public</font> RawStr4, <font class="keyword">public</font> <a class="code" href="class_s_w_l_d.html">SWLD</a> +00032 { +00033 <font class="keywordtype">void</font> strongsPad (<font class="keywordtype">char</font> *buf); +00034 <font class="keywordtype">char</font> getEntry (<font class="keywordtype">long</font> away = 0); +00035 +00036 <font class="keyword">public</font>: +00037 +00038 +00039 RawLD4(<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00040 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, +00041 <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); +00042 <font class="keyword">virtual</font> ~RawLD4(); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a25">getRawEntry</a>(); +00044 +00045 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a37">operator =</a>(SW_POSITION pos); +00046 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a34">operator +=</a>(<font class="keywordtype">int</font> increment); +00047 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a33">operator -=</a>(<font class="keywordtype">int</font> decrement)<font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> this-><a class="code" href="class_s_w_module.html#a34">operator +=</a>(-decrement); +00049 } +00050 <font class="comment">// write interface ----------------------------</font> +00051 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a28">isWritable</a>()<font class="keyword"> </font>{ <font class="keywordflow">return</font> <font class="keyword">true</font>; } +00052 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path)<font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> RawStr4::createModule (path); +00054 } +00055 +00056 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a29">setentry</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf, <font class="keywordtype">long</font> len); <font class="comment">// Modify current module entry</font> +00057 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00058 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00059 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a32">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00060 <font class="comment">// end write interface ------------------------</font> +00061 }; +00062 +00063 +00064 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawld4_h-source.html b/doc/api-documentation/html/rawld4_h-source.html new file mode 100644 index 0000000..3f0ae40 --- /dev/null +++ b/doc/api-documentation/html/rawld4_h-source.html @@ -0,0 +1,77 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawld4.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawld4.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawld.cpp - code for class 'RawLD'- a module that reads raw lexicon and</font> +00003 <font class="comment"> * dictionary files: *.dat *.idx</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: rawld4_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWLD4_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWLD4_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawstr4.h></font> +00027 <font class="preprocessor">#include <swld.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT RawLD4:<font class="keyword">public</font> RawStr4, <font class="keyword">public</font> <a class="code" href="class_swld.html">SWLD</a> +00032 { +00033 <font class="keywordtype">void</font> strongsPad (<font class="keywordtype">char</font> *buf); +00034 <font class="keywordtype">char</font> getEntry (<font class="keywordtype">long</font> away = 0); +00035 +00036 <font class="keyword">public</font>: +00037 +00038 +00039 RawLD4(<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00040 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00041 <font class="keyword">virtual</font> ~RawLD4(); +00042 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a21">getRawEntry</a>(); +00043 +00044 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a32">operator =</a>(SW_POSITION pos); +00045 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a29">operator +=</a>(<font class="keywordtype">int</font> increment); +00046 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a28">operator -=</a>(<font class="keywordtype">int</font> decrement)<font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> this-><a class="code" href="class_swmodule.html#a29">operator +=</a>(-decrement); +00048 } +00049 <font class="comment">// write interface ----------------------------</font> +00050 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a24">isWritable</a>()<font class="keyword"> </font>{ <font class="keywordflow">return</font> <font class="keyword">true</font>; } +00051 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path)<font class="keyword"> </font>{ +00052 <font class="keywordflow">return</font> RawStr4::createModule (path); +00053 } +00054 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00055 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00056 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a27">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00057 <font class="comment">// end write interface ------------------------</font> +00058 }; +00059 +00060 +00061 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawld_8h-source.html b/doc/api-documentation/html/rawld_8h-source.html new file mode 100644 index 0000000..cd6dbdd --- /dev/null +++ b/doc/api-documentation/html/rawld_8h-source.html @@ -0,0 +1,84 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawld.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawld.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawld.cpp - code for class 'RawLD'- a module that reads raw lexicon and</font> +00003 <font class="comment"> * dictionary files: *.dat *.idx</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: rawld_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWLD_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWLD_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawstr.h></font> +00027 <font class="preprocessor">#include <swld.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT RawLD:<font class="keyword">public</font> RawStr, <font class="keyword">public</font> <a class="code" href="class_s_w_l_d.html">SWLD</a> +00032 { +00033 <font class="keywordtype">void</font> strongsPad (<font class="keywordtype">char</font> *buf); +00034 <font class="keywordtype">char</font> getEntry (<font class="keywordtype">long</font> away = 0); +00035 +00036 <font class="keyword">public</font>: +00037 +00038 +00039 RawLD (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00040 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, +00041 <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); +00042 <font class="keyword">virtual</font> ~ RawLD (); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a25">getRawEntry</a> (); +00044 +00045 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a37">operator = </a>(SW_POSITION pos); +00046 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a34">operator += </a>(<font class="keywordtype">int</font> increment); +00047 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a33">operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"></font> +00048 <font class="keyword"> </font>{ +00049 <font class="keywordflow">return</font> this-><a class="code" href="class_s_w_module.html#a34">operator += </a>(-decrement); +00050 } +00051 <font class="comment">// write interface ----------------------------</font> +00052 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a28">isWritable</a> ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00055 } +00056 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path)<font class="keyword"></font> +00057 <font class="keyword"> </font>{ +00058 <font class="keywordflow">return</font> RawStr::createModule (path); +00059 } +00060 +00061 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a29">setentry</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf, <font class="keywordtype">long</font> len); <font class="comment">// Modify current module entry</font> +00062 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00063 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00064 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a32">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00065 <font class="comment">// end write interface ------------------------</font> +00066 }; +00067 +00068 +00069 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawld_h-source.html b/doc/api-documentation/html/rawld_h-source.html new file mode 100644 index 0000000..d8249f1 --- /dev/null +++ b/doc/api-documentation/html/rawld_h-source.html @@ -0,0 +1,82 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawld.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawld.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawld.cpp - code for class 'RawLD'- a module that reads raw lexicon and</font> +00003 <font class="comment"> * dictionary files: *.dat *.idx</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: rawld_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWLD_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWLD_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawstr.h></font> +00027 <font class="preprocessor">#include <swld.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="keyword">class </font>SWDLLEXPORT RawLD:<font class="keyword">public</font> RawStr, <font class="keyword">public</font> <a class="code" href="class_swld.html">SWLD</a> +00032 { +00033 <font class="keywordtype">void</font> strongsPad (<font class="keywordtype">char</font> *buf); +00034 <font class="keywordtype">char</font> getEntry (<font class="keywordtype">long</font> away = 0); +00035 +00036 <font class="keyword">public</font>: +00037 +00038 +00039 RawLD (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00040 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00041 <font class="keyword">virtual</font> ~ RawLD (); +00042 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a21">getRawEntry</a> (); +00043 +00044 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a32">operator = </a>(SW_POSITION pos); +00045 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a29">operator += </a>(<font class="keywordtype">int</font> increment); +00046 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a28">operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> this-><a class="code" href="class_swmodule.html#a29">operator += </a>(-decrement); +00049 } +00050 <font class="comment">// write interface ----------------------------</font> +00051 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a24">isWritable</a> ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00054 } +00055 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path)<font class="keyword"></font> +00056 <font class="keyword"> </font>{ +00057 <font class="keywordflow">return</font> RawStr::createModule (path); +00058 } +00059 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00060 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00061 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a27">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00062 <font class="comment">// end write interface ------------------------</font> +00063 }; +00064 +00065 +00066 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawstr.h-source.html b/doc/api-documentation/html/rawstr.h-source.html new file mode 100644 index 0000000..b50def5 --- /dev/null +++ b/doc/api-documentation/html/rawstr.h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rawstr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawstr.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************** +</font>00002 <font class="comment"> * rawstr.h - code for class 'RawStr'- a module that reads raw text +</font>00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss +</font>00004 <font class="comment"> * and provides lookup and parsing functions based on +</font>00005 <font class="comment"> * class StrKey +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * $Id: rawstr.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00008 <font class="comment"> * +</font>00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00010 <font class="comment"> * CrossWire Bible Society +</font>00011 <font class="comment"> * P. O. Box 2528 +</font>00012 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00015 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00016 <font class="comment"> * Free Software Foundation version 2. +</font>00017 <font class="comment"> * +</font>00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00021 <font class="comment"> * General Public License for more details. +</font>00022 <font class="comment"> * +</font>00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef RAWSTR_H +</font>00026 <font class="preprocessor"></font><font class="preprocessor">#define RAWSTR_H +</font>00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <filemgr.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawStr +00033 { +00034 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawStr objects or derivitives</font> +00035 FileDesc *idxfd; +00036 FileDesc *datfd; +00037 <font class="keywordtype">char</font> *path; +00038 <font class="keywordtype">long</font> lastoff; +00039 +00040 <font class="keyword">protected</font>: +00041 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00042 <font class="keywordtype">void</font> settext (<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf); +00043 <font class="keywordtype">void</font> linkentry (<font class="keyword">const</font> <font class="keywordtype">char</font> *destkey, <font class="keyword">const</font> <font class="keywordtype">char</font> *srckey); +00044 <font class="keyword">public</font>: +00045 <font class="keywordtype">char</font> nl; +00046 RawStr (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = -1); +00047 <font class="keyword">virtual</font> ~ RawStr (); +00048 <font class="keywordtype">void</font> getidxbuf (<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00049 <font class="keywordtype">void</font> getidxbufdat (<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00050 <font class="keywordtype">char</font> findoffset (<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keywordtype">long</font> *start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> *size, +00051 <font class="keywordtype">long</font> away = 0, <font class="keywordtype">long</font> *idxoff = 0); +00052 <font class="keywordtype">void</font> gettext (<font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> size, <font class="keywordtype">char</font> *idxbuf, <font class="keywordtype">char</font> *buf); +00053 <font class="keyword">static</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path); +00054 }; +00055 +00056 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawstr4.h-source.html b/doc/api-documentation/html/rawstr4.h-source.html new file mode 100644 index 0000000..a337117 --- /dev/null +++ b/doc/api-documentation/html/rawstr4.h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rawstr4.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawstr4.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************** +</font>00002 <font class="comment"> * rawstr.h - code for class 'RawStr'- a module that reads raw text +</font>00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss +</font>00004 <font class="comment"> * and provides lookup and parsing functions based on +</font>00005 <font class="comment"> * class StrKey +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * $Id: rawstr4.h-source.html,v 1.1 2001/05/25 10:50:59 jansorg Exp $ +</font>00008 <font class="comment"> * +</font>00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00010 <font class="comment"> * CrossWire Bible Society +</font>00011 <font class="comment"> * P. O. Box 2528 +</font>00012 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00015 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00016 <font class="comment"> * Free Software Foundation version 2. +</font>00017 <font class="comment"> * +</font>00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00021 <font class="comment"> * General Public License for more details. +</font>00022 <font class="comment"> * +</font>00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef RAWSTR4_H +</font>00026 <font class="preprocessor"></font><font class="preprocessor">#define RAWSTR4_H +</font>00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <filemgr.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawStr4 +00033 { +00034 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawStr4 objects or derivitives</font> +00035 FileDesc *idxfd; +00036 FileDesc *datfd; +00037 <font class="keywordtype">char</font> *path; +00038 <font class="keywordtype">long</font> lastoff; +00039 +00040 <font class="keyword">protected</font>: +00041 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00042 <font class="keywordtype">void</font> settext (<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf); +00043 <font class="keywordtype">void</font> linkentry (<font class="keyword">const</font> <font class="keywordtype">char</font> *destkey, <font class="keyword">const</font> <font class="keywordtype">char</font> *srckey); +00044 <font class="keyword">public</font>: +00045 <font class="keywordtype">char</font> nl; +00046 RawStr4(<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = -1); +00047 <font class="keyword">virtual</font> ~ RawStr4(); +00048 <font class="keywordtype">void</font> getidxbuf (<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00049 <font class="keywordtype">void</font> getidxbufdat (<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00050 <font class="keywordtype">char</font> findoffset (<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keywordtype">long</font> *start, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> *size, +00051 <font class="keywordtype">long</font> away = 0, <font class="keywordtype">long</font> *idxoff = 0); +00052 <font class="keywordtype">void</font> gettext (<font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> size, <font class="keywordtype">char</font> *idxbuf, <font class="keywordtype">char</font> *buf); +00053 <font class="keyword">static</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path); +00054 }; +00055 +00056 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawstr4_8h-source.html b/doc/api-documentation/html/rawstr4_8h-source.html new file mode 100644 index 0000000..6e08243 --- /dev/null +++ b/doc/api-documentation/html/rawstr4_8h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawstr4.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawstr4.h</h1><div class="fragment"><pre>00001 <font class="comment">/*****************************************************************************</font> +00002 <font class="comment"> * rawstr.h - code for class 'RawStr'- a module that reads raw text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> * and provides lookup and parsing functions based on</font> +00005 <font class="comment"> * class StrKey</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * $Id: rawstr4_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00010 <font class="comment"> * CrossWire Bible Society</font> +00011 <font class="comment"> * P. O. Box 2528</font> +00012 <font class="comment"> * Tempe, AZ 85280-2528</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00016 <font class="comment"> * Free Software Foundation version 2.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00021 <font class="comment"> * General Public License for more details.</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef RAWSTR4_H</font> +00026 <font class="preprocessor"></font><font class="preprocessor">#define RAWSTR4_H</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <filemgr.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawStr4 +00033 { +00034 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawStr4 objects or derivitives</font> +00035 FileDesc *idxfd; +00036 FileDesc *datfd; +00037 <font class="keywordtype">char</font> *path; +00038 <font class="keywordtype">long</font> lastoff; +00039 +00040 <font class="keyword">protected</font>: +00041 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00042 <font class="keywordtype">void</font> settext (<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> len = 0); +00043 <font class="keywordtype">void</font> linkentry (<font class="keyword">const</font> <font class="keywordtype">char</font> *destkey, <font class="keyword">const</font> <font class="keywordtype">char</font> *srckey); +00044 <font class="keyword">public</font>: +00045 <font class="keywordtype">char</font> nl; +00046 RawStr4(<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = -1); +00047 <font class="keyword">virtual</font> ~ RawStr4(); +00048 <font class="keywordtype">void</font> getidxbuf (<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00049 <font class="keywordtype">void</font> getidxbufdat (<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00050 <font class="keywordtype">signed</font> <font class="keywordtype">char</font> findoffset (<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keywordtype">long</font> *start, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> *size, +00051 <font class="keywordtype">long</font> away = 0, <font class="keywordtype">long</font> *idxoff = 0); +00052 <font class="keywordtype">void</font> gettext (<font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> size, <font class="keywordtype">char</font> *idxbuf, <font class="keywordtype">char</font> *buf); +00053 <font class="keyword">static</font> <font class="keywordtype">signed</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path); +00054 }; +00055 +00056 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawstr4_h-source.html b/doc/api-documentation/html/rawstr4_h-source.html new file mode 100644 index 0000000..8feb3ce --- /dev/null +++ b/doc/api-documentation/html/rawstr4_h-source.html @@ -0,0 +1,72 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawstr4.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawstr4.h</h1><div class="fragment"><pre>00001 <font class="comment">/*****************************************************************************</font> +00002 <font class="comment"> * rawstr.h - code for class 'RawStr'- a module that reads raw text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> * and provides lookup and parsing functions based on</font> +00005 <font class="comment"> * class StrKey</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * $Id: rawstr4_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00010 <font class="comment"> * CrossWire Bible Society</font> +00011 <font class="comment"> * P. O. Box 2528</font> +00012 <font class="comment"> * Tempe, AZ 85280-2528</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00016 <font class="comment"> * Free Software Foundation version 2.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00021 <font class="comment"> * General Public License for more details.</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef RAWSTR4_H</font> +00026 <font class="preprocessor"></font><font class="preprocessor">#define RAWSTR4_H</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <filemgr.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawStr4 +00033 { +00034 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawStr4 objects or derivitives</font> +00035 FileDesc *idxfd; +00036 FileDesc *datfd; +00037 <font class="keywordtype">char</font> *path; +00038 <font class="keywordtype">long</font> lastoff; +00039 +00040 <font class="keyword">protected</font>: +00041 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00042 <font class="keywordtype">void</font> settext (<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf); +00043 <font class="keywordtype">void</font> linkentry (<font class="keyword">const</font> <font class="keywordtype">char</font> *destkey, <font class="keyword">const</font> <font class="keywordtype">char</font> *srckey); +00044 <font class="keyword">public</font>: +00045 <font class="keywordtype">char</font> nl; +00046 RawStr4(<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = -1); +00047 <font class="keyword">virtual</font> ~ RawStr4(); +00048 <font class="keywordtype">void</font> getidxbuf (<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00049 <font class="keywordtype">void</font> getidxbufdat (<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00050 <font class="keywordtype">char</font> findoffset (<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keywordtype">long</font> *start, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> *size, +00051 <font class="keywordtype">long</font> away = 0, <font class="keywordtype">long</font> *idxoff = 0); +00052 <font class="keywordtype">void</font> gettext (<font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> size, <font class="keywordtype">char</font> *idxbuf, <font class="keywordtype">char</font> *buf); +00053 <font class="keyword">static</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path); +00054 }; +00055 +00056 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawstr_8h-source.html b/doc/api-documentation/html/rawstr_8h-source.html new file mode 100644 index 0000000..6a94f08 --- /dev/null +++ b/doc/api-documentation/html/rawstr_8h-source.html @@ -0,0 +1,69 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawstr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawstr.h</h1><div class="fragment"><pre>00001 <font class="comment">/*****************************************************************************</font> +00002 <font class="comment"> * rawstr.h - code for class 'RawStr'- a module that reads raw text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> * and provides lookup and parsing functions based on</font> +00005 <font class="comment"> * class StrKey</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * $Id: rawstr_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00010 <font class="comment"> * CrossWire Bible Society</font> +00011 <font class="comment"> * P. O. Box 2528</font> +00012 <font class="comment"> * Tempe, AZ 85280-2528</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00016 <font class="comment"> * Free Software Foundation version 2.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00021 <font class="comment"> * General Public License for more details.</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef RAWSTR_H</font> +00026 <font class="preprocessor"></font><font class="preprocessor">#define RAWSTR_H</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <filemgr.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawStr { +00033 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawStr objects or derivitives</font> +00034 FileDesc *idxfd; +00035 FileDesc *datfd; +00036 <font class="keywordtype">char</font> *path; +00037 <font class="keywordtype">long</font> lastoff; +00038 +00039 <font class="keyword">protected</font>: +00040 <font class="keywordtype">void</font> preptext(<font class="keywordtype">char</font> *buf); +00041 <font class="keywordtype">void</font> settext(<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> len = 0); +00042 <font class="keywordtype">void</font> linkentry(<font class="keyword">const</font> <font class="keywordtype">char</font> *destkey, <font class="keyword">const</font> <font class="keywordtype">char</font> *srckey); +00043 <font class="keyword">public</font>: +00044 <font class="keywordtype">char</font> nl; +00045 RawStr(<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = -1); +00046 <font class="keyword">virtual</font> ~RawStr (); +00047 <font class="keywordtype">void</font> getidxbuf(<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00048 <font class="keywordtype">void</font> getidxbufdat(<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00049 <font class="keywordtype">signed</font> <font class="keywordtype">char</font> findoffset(<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keywordtype">long</font> *start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> *size, <font class="keywordtype">long</font> away = 0, <font class="keywordtype">long</font> *idxoff = 0); +00050 <font class="keywordtype">void</font> gettext(<font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> size, <font class="keywordtype">char</font> *idxbuf, <font class="keywordtype">char</font> *buf); +00051 <font class="keyword">static</font> <font class="keywordtype">signed</font> <font class="keywordtype">char</font> createModule(<font class="keyword">const</font> <font class="keywordtype">char</font> *path); +00052 }; +00053 +00054 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawstr_h-source.html b/doc/api-documentation/html/rawstr_h-source.html new file mode 100644 index 0000000..0a5c59a --- /dev/null +++ b/doc/api-documentation/html/rawstr_h-source.html @@ -0,0 +1,72 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawstr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawstr.h</h1><div class="fragment"><pre>00001 <font class="comment">/*****************************************************************************</font> +00002 <font class="comment"> * rawstr.h - code for class 'RawStr'- a module that reads raw text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> * and provides lookup and parsing functions based on</font> +00005 <font class="comment"> * class StrKey</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * $Id: rawstr_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00010 <font class="comment"> * CrossWire Bible Society</font> +00011 <font class="comment"> * P. O. Box 2528</font> +00012 <font class="comment"> * Tempe, AZ 85280-2528</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00016 <font class="comment"> * Free Software Foundation version 2.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00021 <font class="comment"> * General Public License for more details.</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef RAWSTR_H</font> +00026 <font class="preprocessor"></font><font class="preprocessor">#define RAWSTR_H</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <filemgr.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawStr +00033 { +00034 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawStr objects or derivitives</font> +00035 FileDesc *idxfd; +00036 FileDesc *datfd; +00037 <font class="keywordtype">char</font> *path; +00038 <font class="keywordtype">long</font> lastoff; +00039 +00040 <font class="keyword">protected</font>: +00041 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00042 <font class="keywordtype">void</font> settext (<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf); +00043 <font class="keywordtype">void</font> linkentry (<font class="keyword">const</font> <font class="keywordtype">char</font> *destkey, <font class="keyword">const</font> <font class="keywordtype">char</font> *srckey); +00044 <font class="keyword">public</font>: +00045 <font class="keywordtype">char</font> nl; +00046 RawStr (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = -1); +00047 <font class="keyword">virtual</font> ~ RawStr (); +00048 <font class="keywordtype">void</font> getidxbuf (<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00049 <font class="keywordtype">void</font> getidxbufdat (<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf); +00050 <font class="keywordtype">char</font> findoffset (<font class="keyword">const</font> <font class="keywordtype">char</font> *key, <font class="keywordtype">long</font> *start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> *size, +00051 <font class="keywordtype">long</font> away = 0, <font class="keywordtype">long</font> *idxoff = 0); +00052 <font class="keywordtype">void</font> gettext (<font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> size, <font class="keywordtype">char</font> *idxbuf, <font class="keywordtype">char</font> *buf); +00053 <font class="keyword">static</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path); +00054 }; +00055 +00056 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:32 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawtext.h-source.html b/doc/api-documentation/html/rawtext.h-source.html new file mode 100644 index 0000000..a7c80ab --- /dev/null +++ b/doc/api-documentation/html/rawtext.h-source.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rawtext.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawtext.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * rawtext.h - code for class 'RawText'- a module that reads raw text files: +</font>00003 <font class="comment"> * ot and nt using indexs ??.bks ??.cps ??.vss +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: rawtext.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWTEXT_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWTEXT_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <rawstr.h></font> +00028 <font class="preprocessor">#include <swtext.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawText:<font class="keyword">public</font> <a class="code" href="class_swtext.html">SWText</a>, <font class="keyword">public</font> RawVerse +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 RawStr *fastSearch[2]; +00036 +00037 <font class="keyword">public</font>: +00038 +00039 +00040 RawText (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00041 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00042 <font class="keyword">virtual</font> ~ RawText (); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a19">getRawEntry</a> (); +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> createSearchFramework (); +00045 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> hasSearchFramework ()<font class="keyword"> +</font>00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00048 } +00049 <font class="preprocessor">#ifdef __VISUALC__ +</font>00050 <font class="preprocessor"></font> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a30"> operator = </a>(SW_POSITION); +00051 <font class="preprocessor">#else +</font>00052 <font class="preprocessor"></font> <font class="keyword">virtual</font> RawText &<a class="code" href="class_swmodule.html#a30"> operator = </a>(SW_POSITION); +00053 <font class="preprocessor">#endif +</font>00054 <font class="preprocessor"></font> <font class="keyword">virtual</font> <a class="code" href="class_listkey.html">ListKey</a> & <a class="code" href="class_swmodule.html#a13">Search</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType = 0, <font class="keywordtype">int</font> flags = +00055 0, <a class="code" href="class_swkey.html">SWKey</a> * scope = +00056 0, <font class="keywordtype">bool</font> * justCheckIfSupported = +00057 0, <font class="keywordtype">void</font> (*percent) (<font class="keywordtype">char</font>, <font class="keywordtype">void</font> *) = +00058 &SWModule::nullPercent, <font class="keywordtype">void</font> *percentUserData = +00059 0); +00060 +00061 <font class="comment">// write interface ----------------------------</font> +00062 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a22">isWritable</a> ()<font class="keyword"> +</font>00063 <font class="keyword"> </font>{ +00064 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00065 } +00066 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path)<font class="keyword"> +</font>00067 <font class="keyword"> </font>{ +00068 <font class="keywordflow">return</font> RawVerse::createModule (path); +00069 } +00070 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00071 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00072 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a25">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00073 <font class="comment">// end write interface ------------------------</font> +00074 }; +00075 +00076 +00077 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawtext_8h-source.html b/doc/api-documentation/html/rawtext_8h-source.html new file mode 100644 index 0000000..c4b50e2 --- /dev/null +++ b/doc/api-documentation/html/rawtext_8h-source.html @@ -0,0 +1,93 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawtext.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawtext.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawtext.h - code for class 'RawText'- a module that reads raw text files:</font> +00003 <font class="comment"> * ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: rawtext_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWTEXT_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWTEXT_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <rawstr.h></font> +00028 <font class="preprocessor">#include <swtext.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawText:<font class="keyword">public</font> <a class="code" href="class_s_w_text.html">SWText</a>, <font class="keyword">public</font> RawVerse +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 RawStr *fastSearch[2]; +00036 +00037 <font class="keyword">public</font>: +00038 +00039 +00040 RawText (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, +00041 <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); +00042 <font class="keyword">virtual</font> ~ RawText (); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a25">getRawEntry</a> (); +00044 <font class="keyword">virtual</font> <font class="keywordtype">signed</font> <font class="keywordtype">char</font> createSearchFramework (); +00045 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> hasSearchFramework ()<font class="keyword"></font> +00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00048 } +00049 <font class="preprocessor">#ifdef _MSC_VER</font> +00050 <font class="preprocessor"></font> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a37">operator = </a>(SW_POSITION); +00051 <font class="preprocessor">#else</font> +00052 <font class="preprocessor"></font> <font class="keyword">virtual</font> RawText & <a class="code" href="class_s_w_module.html#a37">operator = </a>(SW_POSITION); +00053 <font class="preprocessor">#endif</font> +00054 <font class="preprocessor"></font> <font class="keyword">virtual</font> <a class="code" href="class_list_key.html">ListKey</a> & <a class="code" href="class_s_w_module.html#a19">Search</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType = 0, <font class="keywordtype">int</font> flags = +00055 0, <a class="code" href="class_s_w_key.html">SWKey</a> * scope = +00056 0, <font class="keywordtype">bool</font> * justCheckIfSupported = +00057 0, <font class="keywordtype">void</font> (*percent) (<font class="keywordtype">char</font>, <font class="keywordtype">void</font> *) = +00058 &SWModule::nullPercent, <font class="keywordtype">void</font> *percentUserData = +00059 0); +00060 +00061 <font class="comment">// write interface ----------------------------</font> +00062 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a28">isWritable</a> ()<font class="keyword"></font> +00063 <font class="keyword"> </font>{ +00064 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00065 } +00066 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path)<font class="keyword"></font> +00067 <font class="keyword"> </font>{ +00068 <font class="keywordflow">return</font> RawVerse::createModule (path); +00069 } +00070 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a29">setentry</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf, <font class="keywordtype">long</font> len); <font class="comment">// Modify current module entry</font> +00071 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00072 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00073 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a32">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00074 <font class="comment">// end write interface ------------------------</font> +00075 }; +00076 +00077 +00078 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawtext_h-source.html b/doc/api-documentation/html/rawtext_h-source.html new file mode 100644 index 0000000..faf5601 --- /dev/null +++ b/doc/api-documentation/html/rawtext_h-source.html @@ -0,0 +1,92 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawtext.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawtext.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawtext.h - code for class 'RawText'- a module that reads raw text files:</font> +00003 <font class="comment"> * ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: rawtext_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef RAWTEXT_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define RAWTEXT_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <rawstr.h></font> +00028 <font class="preprocessor">#include <swtext.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT RawText:<font class="keyword">public</font> <a class="code" href="class_swtext.html">SWText</a>, <font class="keyword">public</font> RawVerse +00033 { +00034 <font class="keywordtype">char</font> *versebuf; +00035 RawStr *fastSearch[2]; +00036 +00037 <font class="keyword">public</font>: +00038 +00039 +00040 RawText (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00041 <font class="keyword">virtual</font> ~ RawText (); +00042 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a21">getRawEntry</a> (); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> createSearchFramework (); +00044 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> hasSearchFramework ()<font class="keyword"></font> +00045 <font class="keyword"> </font>{ +00046 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00047 } +00048 <font class="preprocessor">#ifdef __VISUALC__</font> +00049 <font class="preprocessor"></font> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a32">operator = </a>(SW_POSITION); +00050 <font class="preprocessor">#else</font> +00051 <font class="preprocessor"></font> <font class="keyword">virtual</font> RawText & <a class="code" href="class_swmodule.html#a32">operator = </a>(SW_POSITION); +00052 <font class="preprocessor">#endif</font> +00053 <font class="preprocessor"></font> <font class="keyword">virtual</font> <a class="code" href="class_listkey.html">ListKey</a> & <a class="code" href="class_swmodule.html#a15">Search</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType = 0, <font class="keywordtype">int</font> flags = +00054 0, <a class="code" href="class_swkey.html">SWKey</a> * scope = +00055 0, <font class="keywordtype">bool</font> * justCheckIfSupported = +00056 0, <font class="keywordtype">void</font> (*percent) (<font class="keywordtype">char</font>, <font class="keywordtype">void</font> *) = +00057 &SWModule::nullPercent, <font class="keywordtype">void</font> *percentUserData = +00058 0); +00059 +00060 <font class="comment">// write interface ----------------------------</font> +00061 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a24">isWritable</a> ()<font class="keyword"></font> +00062 <font class="keyword"> </font>{ +00063 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00064 } +00065 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path)<font class="keyword"></font> +00066 <font class="keyword"> </font>{ +00067 <font class="keywordflow">return</font> RawVerse::createModule (path); +00068 } +00069 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00070 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00071 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a27">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00072 <font class="comment">// end write interface ------------------------</font> +00073 }; +00074 +00075 +00076 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawverse.h-source.html b/doc/api-documentation/html/rawverse.h-source.html new file mode 100644 index 0000000..3f4c1f8 --- /dev/null +++ b/doc/api-documentation/html/rawverse.h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rawverse.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawverse.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * rawverse.h - code for class 'RawVerse'- a module that reads raw text +</font>00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss +</font>00004 <font class="comment"> * and provides lookup and parsing functions based on +</font>00005 <font class="comment"> * class VerseKey +</font>00006 <font class="comment"> */</font> +00007 +00008 <font class="preprocessor">#ifndef RAWVERSE_H +</font>00009 <font class="preprocessor"></font><font class="preprocessor">#define RAWVERSE_H +</font>00010 <font class="preprocessor"></font> +00011 <font class="preprocessor">#include <filemgr.h></font> +00012 <font class="preprocessor">#include <fcntl.h></font> +00013 +00014 <font class="preprocessor">#include <defs.h></font> +00015 +00016 <font class="keyword">class </font>SWDLLEXPORT RawVerse +00017 { +00018 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawVerse objects or derivitives</font> +00019 FileDesc *idxfp[2]; +00020 FileDesc *textfp[2]; +00021 +00022 <font class="keyword">protected</font>: +00023 <font class="keywordtype">char</font> *path; +00024 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00025 <font class="keywordtype">void</font> settext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf); +00026 <font class="keywordtype">void</font> linkentry (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> destidxoff, <font class="keywordtype">long</font> srcidxoff); +00027 +00028 <font class="keyword">public</font>: +00029 <font class="keywordtype">char</font> nl; +00030 RawVerse (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = -1); +00031 <font class="keyword">virtual</font> ~ RawVerse (); +00032 <font class="keywordtype">void</font> findoffset (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keywordtype">long</font> *start, +00033 <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> *end); +00034 <font class="keywordtype">void</font> gettext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> size, <font class="keywordtype">char</font> *buf); +00035 <font class="keyword">static</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path); +00036 }; +00037 +00038 +00039 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawverse_8h-source.html b/doc/api-documentation/html/rawverse_8h-source.html new file mode 100644 index 0000000..7ac62f6 --- /dev/null +++ b/doc/api-documentation/html/rawverse_8h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawverse.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawverse.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawverse.h - code for class 'RawVerse'- a module that reads raw text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> * and provides lookup and parsing functions based on</font> +00005 <font class="comment"> * class VerseKey</font> +00006 <font class="comment"> */</font> +00007 +00008 <font class="preprocessor">#ifndef RAWVERSE_H</font> +00009 <font class="preprocessor"></font><font class="preprocessor">#define RAWVERSE_H</font> +00010 <font class="preprocessor"></font> +00011 <font class="preprocessor">#include <filemgr.h></font> +00012 <font class="preprocessor">#include <fcntl.h></font> +00013 +00014 <font class="preprocessor">#include <defs.h></font> +00015 +00016 <font class="keyword">class </font>SWDLLEXPORT RawVerse +00017 { +00018 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawVerse objects or derivitives</font> +00019 FileDesc *idxfp[2]; +00020 FileDesc *textfp[2]; +00021 +00022 <font class="keyword">protected</font>: +00023 <font class="keywordtype">char</font> *path; +00024 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00025 <font class="keywordtype">void</font> settext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> len = 0); +00026 <font class="keywordtype">void</font> linkentry (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> destidxoff, <font class="keywordtype">long</font> srcidxoff); +00027 +00028 <font class="keyword">public</font>: +00029 <font class="keywordtype">char</font> nl; +00030 RawVerse (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = -1); +00031 <font class="keyword">virtual</font> ~ RawVerse (); +00032 <font class="keywordtype">void</font> findoffset (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keywordtype">long</font> *start, +00033 <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> *end); +00034 <font class="keywordtype">void</font> gettext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> size, <font class="keywordtype">char</font> *buf); +00035 <font class="keyword">static</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path); +00036 }; +00037 +00038 +00039 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rawverse_h-source.html b/doc/api-documentation/html/rawverse_h-source.html new file mode 100644 index 0000000..3851ad3 --- /dev/null +++ b/doc/api-documentation/html/rawverse_h-source.html @@ -0,0 +1,55 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rawverse.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rawverse.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawverse.h - code for class 'RawVerse'- a module that reads raw text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> * and provides lookup and parsing functions based on</font> +00005 <font class="comment"> * class VerseKey</font> +00006 <font class="comment"> */</font> +00007 +00008 <font class="preprocessor">#ifndef RAWVERSE_H</font> +00009 <font class="preprocessor"></font><font class="preprocessor">#define RAWVERSE_H</font> +00010 <font class="preprocessor"></font> +00011 <font class="preprocessor">#include <filemgr.h></font> +00012 <font class="preprocessor">#include <fcntl.h></font> +00013 +00014 <font class="preprocessor">#include <defs.h></font> +00015 +00016 <font class="keyword">class </font>SWDLLEXPORT RawVerse +00017 { +00018 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawVerse objects or derivitives</font> +00019 FileDesc *idxfp[2]; +00020 FileDesc *textfp[2]; +00021 +00022 <font class="keyword">protected</font>: +00023 <font class="keywordtype">char</font> *path; +00024 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00025 <font class="keywordtype">void</font> settext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf); +00026 <font class="keywordtype">void</font> linkentry (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> destidxoff, <font class="keywordtype">long</font> srcidxoff); +00027 +00028 <font class="keyword">public</font>: +00029 <font class="keywordtype">char</font> nl; +00030 RawVerse (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = -1); +00031 <font class="keyword">virtual</font> ~ RawVerse (); +00032 <font class="keywordtype">void</font> findoffset (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keywordtype">long</font> *start, +00033 <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> *end); +00034 <font class="keywordtype">void</font> gettext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> size, <font class="keywordtype">char</font> *buf); +00035 <font class="keyword">static</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path); +00036 }; +00037 +00038 +00039 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/regex.h-source.html b/doc/api-documentation/html/regex.h-source.html new file mode 100644 index 0000000..58ab7bb --- /dev/null +++ b/doc/api-documentation/html/regex.h-source.html @@ -0,0 +1,560 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>regex.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>regex.h</h1><div class="fragment"><pre>00001 <font class="comment">/* Definitions for data structures and routines for the regular +</font>00002 <font class="comment"> expression library, version 0.12. +</font>00003 <font class="comment"> Copyright (C) 1985,89,90,91,92,93,95,96,97 Free Software Foundation, Inc. +</font>00004 <font class="comment"> +</font>00005 <font class="comment"> the C library, however. The master source lives in /gd/gnu/lib. +</font>00006 <font class="comment"> +</font>00007 <font class="comment">NOTE: The canonical source of this file is maintained with the +</font>00008 <font class="comment">GNU C Library. Bugs can be reported to bug-glibc@prep.ai.mit.edu. +</font>00009 <font class="comment"> +</font>00010 <font class="comment">This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment">under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment">Free Software Foundation; either version 2, or (at your option) any +</font>00013 <font class="comment">later version. +</font>00014 <font class="comment"> +</font>00015 <font class="comment">This program is distributed in the hope that it will be useful, +</font>00016 <font class="comment">but WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +</font>00018 <font class="comment">GNU General Public License for more details. +</font>00019 <font class="comment"> +</font>00020 <font class="comment">You should have received a copy of the GNU General Public License +</font>00021 <font class="comment">along with this program; if not, write to the Free Software Foundation, +</font>00022 <font class="comment">Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */</font> +00023 +00024 <font class="preprocessor">#ifndef _REGEX_H +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#define _REGEX_H 1 +</font>00026 <font class="preprocessor"></font> +00027 <font class="comment">/* Allow the use in C++ code. */</font> +00028 <font class="preprocessor">#ifdef __cplusplus +</font>00029 <font class="preprocessor"></font><font class="keyword">extern</font> <font class="stringliteral">"C"</font> +00030 { +00031 <font class="preprocessor">#endif +</font>00032 <font class="preprocessor"></font> +00033 <font class="comment">/* POSIX says that <sys/types.h> must be included (by the caller) before +</font>00034 <font class="comment"> <regex.h>. */</font> +00035 +00036 <font class="preprocessor">#if !defined (_POSIX_C_SOURCE) && !defined (_POSIX_SOURCE) && defined (VMS) +</font>00037 <font class="preprocessor"></font><font class="comment">/* VMS doesn't have `size_t' in <sys/types.h>, even though POSIX says it +</font>00038 <font class="comment"> should be there. */</font> +00039 <font class="preprocessor">#include <stddef.h></font> +00040 <font class="preprocessor">#endif +</font>00041 <font class="preprocessor"></font> +00042 <font class="comment">/* The following two types have to be signed and unsigned integer type +</font>00043 <font class="comment"> wide enough to hold a value of a pointer. For most ANSI compilers +</font>00044 <font class="comment"> ptrdiff_t and size_t should be likely OK. Still size of these two +</font>00045 <font class="comment"> types is 2 for Microsoft C. Ugh... */</font> +00046 <font class="keyword">typedef</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> s_reg_t; +00047 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> active_reg_t; +00048 +00049 <font class="comment">/* The following bits are used to determine the regexp syntax we +</font>00050 <font class="comment"> recognize. The set/not-set meanings are chosen so that Emacs syntax +</font>00051 <font class="comment"> remains the value 0. The bits are given in alphabetical order, and +</font>00052 <font class="comment"> the definitions shifted by one from the previous bit; thus, when we +</font>00053 <font class="comment"> add or remove a bit, only one other definition need change. */</font> +00054 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> reg_syntax_t; +00055 +00056 <font class="comment">/* If this bit is not set, then \ inside a bracket expression is literal. +</font>00057 <font class="comment"> If set, then such a \ quotes the following character. */</font> +00058 <font class="preprocessor">#define RE_BACKSLASH_ESCAPE_IN_LISTS ((unsigned long int) 1) +</font>00059 <font class="preprocessor"></font> +00060 <font class="comment">/* If this bit is not set, then + and ? are operators, and \+ and \? are +</font>00061 <font class="comment"> literals. +</font>00062 <font class="comment"> If set, then \+ and \? are operators and + and ? are literals. */</font> +00063 <font class="preprocessor">#define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1) +</font>00064 <font class="preprocessor"></font> +00065 <font class="comment">/* If this bit is set, then character classes are supported. They are: +</font>00066 <font class="comment"> [:alpha:], [:upper:], [:lower:], [:digit:], [:alnum:], [:xdigit:], +</font>00067 <font class="comment"> [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:]. +</font>00068 <font class="comment"> If not set, then character classes are not supported. */</font> +00069 <font class="preprocessor">#define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1) +</font>00070 <font class="preprocessor"></font> +00071 <font class="comment">/* If this bit is set, then ^ and $ are always anchors (outside bracket +</font>00072 <font class="comment"> expressions, of course). +</font>00073 <font class="comment"> If this bit is not set, then it depends: +</font>00074 <font class="comment"> ^ is an anchor if it is at the beginning of a regular +</font>00075 <font class="comment"> expression or after an open-group or an alternation operator; +</font>00076 <font class="comment"> $ is an anchor if it is at the end of a regular expression, or +</font>00077 <font class="comment"> before a close-group or an alternation operator. +</font>00078 <font class="comment"> +</font>00079 <font class="comment"> This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because +</font>00080 <font class="comment"> POSIX draft 11.2 says that * etc. in leading positions is undefined. +</font>00081 <font class="comment"> We already implemented a previous draft which made those constructs +</font>00082 <font class="comment"> invalid, though, so we haven't changed the code back. */</font> +00083 <font class="preprocessor">#define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1) +</font>00084 <font class="preprocessor"></font> +00085 <font class="comment">/* If this bit is set, then special characters are always special +</font>00086 <font class="comment"> regardless of where they are in the pattern. +</font>00087 <font class="comment"> If this bit is not set, then special characters are special only in +</font>00088 <font class="comment"> some contexts; otherwise they are ordinary. Specifically, +</font>00089 <font class="comment"> * + ? and intervals are only special when not after the beginning, +</font>00090 <font class="comment"> open-group, or alternation operator. */</font> +00091 <font class="preprocessor">#define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1) +</font>00092 <font class="preprocessor"></font> +00093 <font class="comment">/* If this bit is set, then *, +, ?, and { cannot be first in an re or +</font>00094 <font class="comment"> immediately after an alternation or begin-group operator. */</font> +00095 <font class="preprocessor">#define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1) +</font>00096 <font class="preprocessor"></font> +00097 <font class="comment">/* If this bit is set, then . matches newline. +</font>00098 <font class="comment"> If not set, then it doesn't. */</font> +00099 <font class="preprocessor">#define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1) +</font>00100 <font class="preprocessor"></font> +00101 <font class="comment">/* If this bit is set, then . doesn't match NUL. +</font>00102 <font class="comment"> If not set, then it does. */</font> +00103 <font class="preprocessor">#define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1) +</font>00104 <font class="preprocessor"></font> +00105 <font class="comment">/* If this bit is set, nonmatching lists [^...] do not match newline. +</font>00106 <font class="comment"> If not set, they do. */</font> +00107 <font class="preprocessor">#define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1) +</font>00108 <font class="preprocessor"></font> +00109 <font class="comment">/* If this bit is set, either \{...\} or {...} defines an +</font>00110 <font class="comment"> interval, depending on RE_NO_BK_BRACES. +</font>00111 <font class="comment"> If not set, \{, \}, {, and } are literals. */</font> +00112 <font class="preprocessor">#define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1) +</font>00113 <font class="preprocessor"></font> +00114 <font class="comment">/* If this bit is set, +, ? and | aren't recognized as operators. +</font>00115 <font class="comment"> If not set, they are. */</font> +00116 <font class="preprocessor">#define RE_LIMITED_OPS (RE_INTERVALS << 1) +</font>00117 <font class="preprocessor"></font> +00118 <font class="comment">/* If this bit is set, newline is an alternation operator. +</font>00119 <font class="comment"> If not set, newline is literal. */</font> +00120 <font class="preprocessor">#define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1) +</font>00121 <font class="preprocessor"></font> +00122 <font class="comment">/* If this bit is set, then `{...}' defines an interval, and \{ and \} +</font>00123 <font class="comment"> are literals. +</font>00124 <font class="comment"> If not set, then `\{...\}' defines an interval. */</font> +00125 <font class="preprocessor">#define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1) +</font>00126 <font class="preprocessor"></font> +00127 <font class="comment">/* If this bit is set, (...) defines a group, and \( and \) are literals. +</font>00128 <font class="comment"> If not set, \(...\) defines a group, and ( and ) are literals. */</font> +00129 <font class="preprocessor">#define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1) +</font>00130 <font class="preprocessor"></font> +00131 <font class="comment">/* If this bit is set, then <digit> matches <digit>. +</font>00132 <font class="comment"> If not set, then <digit> is a back-reference. */</font> +00133 <font class="preprocessor">#define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1) +</font>00134 <font class="preprocessor"></font> +00135 <font class="comment">/* If this bit is set, then | is an alternation operator, and \| is literal. +</font>00136 <font class="comment"> If not set, then \| is an alternation operator, and | is literal. */</font> +00137 <font class="preprocessor">#define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1) +</font>00138 <font class="preprocessor"></font> +00139 <font class="comment">/* If this bit is set, then an ending range point collating higher +</font>00140 <font class="comment"> than the starting range point, as in [z-a], is invalid. +</font>00141 <font class="comment"> If not set, then when ending range point collates higher than the +</font>00142 <font class="comment"> starting range point, the range is ignored. */</font> +00143 <font class="preprocessor">#define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1) +</font>00144 <font class="preprocessor"></font> +00145 <font class="comment">/* If this bit is set, then an unmatched ) is ordinary. +</font>00146 <font class="comment"> If not set, then an unmatched ) is invalid. */</font> +00147 <font class="preprocessor">#define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_EMPTY_RANGES << 1) +</font>00148 <font class="preprocessor"></font> +00149 <font class="comment">/* If this bit is set, succeed as soon as we match the whole pattern, +</font>00150 <font class="comment"> without further backtracking. */</font> +00151 <font class="preprocessor">#define RE_NO_POSIX_BACKTRACKING (RE_UNMATCHED_RIGHT_PAREN_ORD << 1) +</font>00152 <font class="preprocessor"></font> +00153 <font class="comment">/* If this bit is set, do not process the GNU regex operators. +</font>00154 <font class="comment"> If not set, then the GNU regex operators are recognized. */</font> +00155 <font class="preprocessor">#define RE_NO_GNU_OPS (RE_NO_POSIX_BACKTRACKING << 1) +</font>00156 <font class="preprocessor"></font> +00157 <font class="comment">/* If this bit is set, turn on internal regex debugging. +</font>00158 <font class="comment"> If not set, and debugging was on, turn it off. +</font>00159 <font class="comment"> This only works if regex.c is compiled -DDEBUG. +</font>00160 <font class="comment"> We define this bit always, so that all that's needed to turn on +</font>00161 <font class="comment"> debugging is to recompile regex.c; the calling code can always have +</font>00162 <font class="comment"> this bit set, and it won't affect anything in the normal case. */</font> +00163 <font class="preprocessor">#define RE_DEBUG (RE_NO_GNU_OPS << 1) +</font>00164 <font class="preprocessor"></font> +00165 <font class="comment">/* This global variable defines the particular regexp syntax to use (for +</font>00166 <font class="comment"> some interfaces). When a regexp is compiled, the syntax used is +</font>00167 <font class="comment"> stored in the pattern buffer, so changing this does not affect +</font>00168 <font class="comment"> already-compiled regexps. */</font> +00169 <font class="keyword">extern</font> reg_syntax_t re_syntax_options; +00170 +00171 <font class="comment">/* Define combinations of the above bits for the standard possibilities. +</font>00172 <font class="comment"> (The [[[ comments delimit what gets put into the Texinfo file, so +</font>00173 <font class="comment"> don't delete them!) */</font> +00174 <font class="comment">/* [[[begin syntaxes]]] */</font> +00175 <font class="preprocessor">#define RE_SYNTAX_EMACS 0 +</font>00176 <font class="preprocessor"></font> +00177 <font class="preprocessor">#define RE_SYNTAX_AWK \ +</font>00178 <font class="preprocessor"> (RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DOT_NOT_NULL \ +</font>00179 <font class="preprocessor"> | RE_NO_BK_PARENS | RE_NO_BK_REFS \ +</font>00180 <font class="preprocessor"> | RE_NO_BK_VBAR | RE_NO_EMPTY_RANGES \ +</font>00181 <font class="preprocessor"> | RE_DOT_NEWLINE | RE_CONTEXT_INDEP_ANCHORS \ +</font>00182 <font class="preprocessor"> | RE_UNMATCHED_RIGHT_PAREN_ORD | RE_NO_GNU_OPS) +</font>00183 <font class="preprocessor"></font> +00184 <font class="preprocessor">#define RE_SYNTAX_GNU_AWK \ +</font>00185 <font class="preprocessor"> ((RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DEBUG) \ +</font>00186 <font class="preprocessor"> & ~(RE_DOT_NOT_NULL | RE_INTERVALS | RE_CONTEXT_INDEP_OPS)) +</font>00187 <font class="preprocessor"></font> +00188 <font class="preprocessor">#define RE_SYNTAX_POSIX_AWK \ +</font>00189 <font class="preprocessor"> (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS \ +</font>00190 <font class="preprocessor"> | RE_INTERVALS | RE_NO_GNU_OPS) +</font>00191 <font class="preprocessor"></font> +00192 <font class="preprocessor">#define RE_SYNTAX_GREP \ +</font>00193 <font class="preprocessor"> (RE_BK_PLUS_QM | RE_CHAR_CLASSES \ +</font>00194 <font class="preprocessor"> | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS \ +</font>00195 <font class="preprocessor"> | RE_NEWLINE_ALT) +</font>00196 <font class="preprocessor"></font> +00197 <font class="preprocessor">#define RE_SYNTAX_EGREP \ +</font>00198 <font class="preprocessor"> (RE_CHAR_CLASSES | RE_CONTEXT_INDEP_ANCHORS \ +</font>00199 <font class="preprocessor"> | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE \ +</font>00200 <font class="preprocessor"> | RE_NEWLINE_ALT | RE_NO_BK_PARENS \ +</font>00201 <font class="preprocessor"> | RE_NO_BK_VBAR) +</font>00202 <font class="preprocessor"></font> +00203 <font class="preprocessor">#define RE_SYNTAX_POSIX_EGREP \ +</font>00204 <font class="preprocessor"> (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES) +</font>00205 <font class="preprocessor"></font> +00206 <font class="comment">/* P1003.2/D11.2, section 4.20.7.1, lines 5078ff. */</font> +00207 <font class="preprocessor">#define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC +</font>00208 <font class="preprocessor"></font> +00209 <font class="preprocessor">#define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC +</font>00210 <font class="preprocessor"></font> +00211 <font class="comment">/* Syntax bits common to both basic and extended POSIX regex syntax. */</font> +00212 <font class="preprocessor">#define _RE_SYNTAX_POSIX_COMMON \ +</font>00213 <font class="preprocessor"> (RE_CHAR_CLASSES | RE_DOT_NEWLINE | RE_DOT_NOT_NULL \ +</font>00214 <font class="preprocessor"> | RE_INTERVALS | RE_NO_EMPTY_RANGES) +</font>00215 <font class="preprocessor"></font> +00216 <font class="preprocessor">#define RE_SYNTAX_POSIX_BASIC \ +</font>00217 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM) +</font>00218 <font class="preprocessor"></font> +00219 <font class="comment">/* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes +</font>00220 <font class="comment"> RE_LIMITED_OPS, i.e., \? \+ \| are not recognized. Actually, this +</font>00221 <font class="comment"> isn't minimal, since other operators, such as \`, aren't disabled. */</font> +00222 <font class="preprocessor">#define RE_SYNTAX_POSIX_MINIMAL_BASIC \ +</font>00223 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS) +</font>00224 <font class="preprocessor"></font> +00225 <font class="preprocessor">#define RE_SYNTAX_POSIX_EXTENDED \ +</font>00226 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \ +</font>00227 <font class="preprocessor"> | RE_CONTEXT_INDEP_OPS | RE_NO_BK_BRACES \ +</font>00228 <font class="preprocessor"> | RE_NO_BK_PARENS | RE_NO_BK_VBAR \ +</font>00229 <font class="preprocessor"> | RE_UNMATCHED_RIGHT_PAREN_ORD) +</font>00230 <font class="preprocessor"></font> +00231 <font class="comment">/* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INVALID_OPS +</font>00232 <font class="comment"> replaces RE_CONTEXT_INDEP_OPS and RE_NO_BK_REFS is added. */</font> +00233 <font class="preprocessor">#define RE_SYNTAX_POSIX_MINIMAL_EXTENDED \ +</font>00234 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \ +</font>00235 <font class="preprocessor"> | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES \ +</font>00236 <font class="preprocessor"> | RE_NO_BK_PARENS | RE_NO_BK_REFS \ +</font>00237 <font class="preprocessor"> | RE_NO_BK_VBAR | RE_UNMATCHED_RIGHT_PAREN_ORD) +</font>00238 <font class="preprocessor"></font><font class="comment">/* [[[end syntaxes]]] */</font> +00239 +00240 <font class="comment">/* Maximum number of duplicates an interval can allow. Some systems +</font>00241 <font class="comment"> (erroneously) define this in other header files, but we want our +</font>00242 <font class="comment"> value, so remove any previous define. */</font> +00243 <font class="preprocessor">#ifdef RE_DUP_MAX +</font>00244 <font class="preprocessor"></font><font class="preprocessor">#undef RE_DUP_MAX +</font>00245 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00246 <font class="preprocessor"></font><font class="comment">/* If sizeof(int) == 2, then ((1 << 15) - 1) overflows. */</font> +00247 <font class="preprocessor">#define RE_DUP_MAX (0x7fff) +</font>00248 <font class="preprocessor"></font> +00249 +00250 <font class="comment">/* POSIX `cflags' bits (i.e., information for `regcomp'). */</font> +00251 +00252 <font class="comment">/* If this bit is set, then use extended regular expression syntax. +</font>00253 <font class="comment"> If not set, then use basic regular expression syntax. */</font> +00254 <font class="preprocessor">#define REG_EXTENDED 1 +</font>00255 <font class="preprocessor"></font> +00256 <font class="comment">/* If this bit is set, then ignore case when matching. +</font>00257 <font class="comment"> If not set, then case is significant. */</font> +00258 <font class="preprocessor">#define REG_ICASE (REG_EXTENDED << 1) +</font>00259 <font class="preprocessor"></font> +00260 <font class="comment">/* If this bit is set, then anchors do not match at newline +</font>00261 <font class="comment"> characters in the string. +</font>00262 <font class="comment"> If not set, then anchors do match at newlines. */</font> +00263 <font class="preprocessor">#define REG_NEWLINE (REG_ICASE << 1) +</font>00264 <font class="preprocessor"></font> +00265 <font class="comment">/* If this bit is set, then report only success or fail in regexec. +</font>00266 <font class="comment"> If not set, then returns differ between not matching and errors. */</font> +00267 <font class="preprocessor">#define REG_NOSUB (REG_NEWLINE << 1) +</font>00268 <font class="preprocessor"></font> +00269 +00270 <font class="comment">/* POSIX `eflags' bits (i.e., information for regexec). */</font> +00271 +00272 <font class="comment">/* If this bit is set, then the beginning-of-line operator doesn't match +</font>00273 <font class="comment"> the beginning of the string (presumably because it's not the +</font>00274 <font class="comment"> beginning of a line). +</font>00275 <font class="comment"> If not set, then the beginning-of-line operator does match the +</font>00276 <font class="comment"> beginning of the string. */</font> +00277 <font class="preprocessor">#define REG_NOTBOL 1 +</font>00278 <font class="preprocessor"></font> +00279 <font class="comment">/* Like REG_NOTBOL, except for the end-of-line. */</font> +00280 <font class="preprocessor">#define REG_NOTEOL (1 << 1) +</font>00281 <font class="preprocessor"></font> +00282 +00283 <font class="comment">/* If any error codes are removed, changed, or added, update the +</font>00284 <font class="comment"> `re_error_msg' table in regex.c. */</font> +00285 <font class="keyword">typedef</font> <font class="keyword">enum</font> +00286 { +00287 REG_NOERROR = 0, <font class="comment">/* Success. */</font> +00288 REG_NOMATCH, <font class="comment">/* Didn't find a match (for regexec). */</font> +00289 +00290 <font class="comment">/* POSIX regcomp return error codes. (In the order listed in the +</font>00291 <font class="comment"> standard.) */</font> +00292 REG_BADPAT, <font class="comment">/* Invalid pattern. */</font> +00293 REG_ECOLLATE, <font class="comment">/* Not implemented. */</font> +00294 REG_ECTYPE, <font class="comment">/* Invalid character class name. */</font> +00295 REG_EESCAPE, <font class="comment">/* Trailing backslash. */</font> +00296 REG_ESUBREG, <font class="comment">/* Invalid back reference. */</font> +00297 REG_EBRACK, <font class="comment">/* Unmatched left bracket. */</font> +00298 REG_EPAREN, <font class="comment">/* Parenthesis imbalance. */</font> +00299 REG_EBRACE, <font class="comment">/* Unmatched \{. */</font> +00300 REG_BADBR, <font class="comment">/* Invalid contents of \{\}. */</font> +00301 REG_ERANGE, <font class="comment">/* Invalid range end. */</font> +00302 REG_ESPACE, <font class="comment">/* Ran out of memory. */</font> +00303 REG_BADRPT, <font class="comment">/* No preceding re for repetition op. */</font> +00304 +00305 <font class="comment">/* Error codes we've added. */</font> +00306 REG_EEND, <font class="comment">/* Premature end. */</font> +00307 REG_ESIZE, <font class="comment">/* Compiled pattern bigger than 2^16 bytes. */</font> +00308 REG_ERPAREN <font class="comment">/* Unmatched ) or \); not returned from regcomp. */</font> +00309 } +00310 reg_errcode_t; +00311 +00312 <font class="comment">/* This data structure represents a compiled pattern. Before calling +</font>00313 <font class="comment"> the pattern compiler, the fields `buffer', `allocated', `fastmap', +</font>00314 <font class="comment"> `translate', and `no_sub' can be set. After the pattern has been +</font>00315 <font class="comment"> compiled, the `re_nsub' field is available. All other fields are +</font>00316 <font class="comment"> private to the regex routines. */</font> +00317 +00318 <font class="preprocessor">#ifndef RE_TRANSLATE_TYPE +</font>00319 <font class="preprocessor"></font><font class="preprocessor">#define RE_TRANSLATE_TYPE char * +</font>00320 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00321 <font class="preprocessor"></font> +00322 <font class="keyword">struct </font>re_pattern_buffer +00323 { +00324 <font class="comment">/* [[[begin pattern_buffer]]] */</font> +00325 <font class="comment">/* Space that holds the compiled pattern. It is declared as +</font>00326 <font class="comment"> `unsigned char *' because its elements are +</font>00327 <font class="comment"> sometimes used as array indexes. */</font> +00328 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *buffer; +00329 +00330 <font class="comment">/* Number of bytes to which `buffer' points. */</font> +00331 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> allocated; +00332 +00333 <font class="comment">/* Number of bytes actually used in `buffer'. */</font> +00334 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> used; +00335 +00336 <font class="comment">/* Syntax setting with which the pattern was compiled. */</font> +00337 reg_syntax_t syntax; +00338 +00339 <font class="comment">/* Pointer to a fastmap, if any, otherwise zero. re_search uses +</font>00340 <font class="comment"> the fastmap, if there is one, to skip over impossible +</font>00341 <font class="comment"> starting points for matches. */</font> +00342 <font class="keywordtype">char</font> *fastmap; +00343 +00344 <font class="comment">/* Either a translate table to apply to all characters before +</font>00345 <font class="comment"> comparing them, or zero for no translation. The translation +</font>00346 <font class="comment"> is applied to a pattern when it is compiled and to a string +</font>00347 <font class="comment"> when it is matched. */</font> +00348 RE_TRANSLATE_TYPE translate; +00349 +00350 <font class="comment">/* Number of subexpressions found by the compiler. */</font> +00351 size_t re_nsub; +00352 +00353 <font class="comment">/* Zero if this pattern cannot match the empty string, one else. +</font>00354 <font class="comment"> Well, in truth it's used only in `re_search_2', to see +</font>00355 <font class="comment"> whether or not we should use the fastmap, so we don't set +</font>00356 <font class="comment"> this absolutely perfectly; see `re_compile_fastmap' (the +</font>00357 <font class="comment"> `duplicate' case). */</font> +00358 <font class="keywordtype">unsigned</font> can_be_null:1; +00359 +00360 <font class="comment">/* If REGS_UNALLOCATED, allocate space in the `regs' structure +</font>00361 <font class="comment"> for `max (RE_NREGS, re_nsub + 1)' groups. +</font>00362 <font class="comment"> If REGS_REALLOCATE, reallocate space if necessary. +</font>00363 <font class="comment"> If REGS_FIXED, use what's there. */</font> +00364 <font class="preprocessor">#define REGS_UNALLOCATED 0 +</font>00365 <font class="preprocessor"></font><font class="preprocessor">#define REGS_REALLOCATE 1 +</font>00366 <font class="preprocessor"></font><font class="preprocessor">#define REGS_FIXED 2 +</font>00367 <font class="preprocessor"></font> <font class="keywordtype">unsigned</font> regs_allocated:2; +00368 +00369 <font class="comment">/* Set to zero when `regex_compile' compiles a pattern; set to one +</font>00370 <font class="comment"> by `re_compile_fastmap' if it updates the fastmap. */</font> +00371 <font class="keywordtype">unsigned</font> fastmap_accurate:1; +00372 +00373 <font class="comment">/* If set, `re_match_2' does not return information about +</font>00374 <font class="comment"> subexpressions. */</font> +00375 <font class="keywordtype">unsigned</font> no_sub:1; +00376 +00377 <font class="comment">/* If set, a beginning-of-line anchor doesn't match at the +</font>00378 <font class="comment"> beginning of the string. */</font> +00379 <font class="keywordtype">unsigned</font> not_bol:1; +00380 +00381 <font class="comment">/* Similarly for an end-of-line anchor. */</font> +00382 <font class="keywordtype">unsigned</font> not_eol:1; +00383 +00384 <font class="comment">/* If true, an anchor at a newline matches. */</font> +00385 <font class="keywordtype">unsigned</font> newline_anchor:1; +00386 +00387 <font class="comment">/* [[[end pattern_buffer]]] */</font> +00388 }; +00389 +00390 <font class="keyword">typedef</font> <font class="keyword">struct </font>re_pattern_buffer regex_t; +00391 +00392 <font class="comment">/* Type for byte offsets within the string. POSIX mandates this. */</font> +00393 <font class="keyword">typedef</font> <font class="keywordtype">int</font> regoff_t; +00394 +00395 +00396 <font class="comment">/* This is the structure we store register match data in. See +</font>00397 <font class="comment"> regex.texinfo for a full description of what registers match. */</font> +00398 <font class="keyword">struct </font>re_registers +00399 { +00400 <font class="keywordtype">unsigned</font> num_regs; +00401 regoff_t *start; +00402 regoff_t *end; +00403 }; +00404 +00405 +00406 <font class="comment">/* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer, +</font>00407 <font class="comment"> `re_match_2' returns information about at least this many registers +</font>00408 <font class="comment"> the first time a `regs' structure is passed. */</font> +00409 <font class="preprocessor">#ifndef RE_NREGS +</font>00410 <font class="preprocessor"></font><font class="preprocessor">#define RE_NREGS 30 +</font>00411 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00412 <font class="preprocessor"></font> +00413 +00414 <font class="comment">/* POSIX specification for registers. Aside from the different names than +</font>00415 <font class="comment"> `re_registers', POSIX uses an array of structures, instead of a +</font>00416 <font class="comment"> structure of arrays. */</font> +00417 <font class="keyword">typedef</font> <font class="keyword">struct +</font>00418 <font class="keyword"> </font>{ +00419 regoff_t rm_so; <font class="comment">/* Byte offset from string's start to substring's start. */</font> +00420 regoff_t rm_eo; <font class="comment">/* Byte offset from string's start to substring's end. */</font> +00421 } +00422 regmatch_t; +00423 +00424 <font class="comment">/* Declarations for routines. */</font> +00425 +00426 <font class="comment">/* To avoid duplicating every routine declaration -- once with a +</font>00427 <font class="comment"> prototype (if we are ANSI), and once without (if we aren't) -- we +</font>00428 <font class="comment"> use the following macro to declare argument types. This +</font>00429 <font class="comment"> unfortunately clutters up the declarations a bit, but I think it's +</font>00430 <font class="comment"> worth it. */</font> +00431 <font class="preprocessor">#ifndef __STDC__ +</font>00432 <font class="preprocessor"></font><font class="preprocessor">#define __STDC__ 1 +</font>00433 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00434 <font class="preprocessor"></font><font class="preprocessor">#if __STDC__ +</font>00435 <font class="preprocessor"></font> +00436 <font class="preprocessor">#define _RE_ARGS(args) args +</font>00437 <font class="preprocessor"></font> +00438 <font class="preprocessor">#else </font><font class="comment">/* not __STDC__ */</font> +00439 +00440 <font class="preprocessor">#define _RE_ARGS(args) () +</font>00441 <font class="preprocessor"></font> +00442 <font class="preprocessor">#endif </font><font class="comment">/* not __STDC__ */</font> +00443 +00444 <font class="comment">/* Sets the current default syntax to SYNTAX, and return the old syntax. +</font>00445 <font class="comment"> You can also simply assign to the `re_syntax_options' variable. */</font> +00446 <font class="keyword">extern</font> reg_syntax_t re_set_syntax _RE_ARGS ((reg_syntax_t syntax)); +00447 +00448 <font class="comment">/* Compile the regular expression PATTERN, with length LENGTH +</font>00449 <font class="comment"> and syntax given by the global `re_syntax_options', into the buffer +</font>00450 <font class="comment"> BUFFER. Return NULL if successful, and an error string if not. */</font> +00451 <font class="keyword">extern</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *re_compile_pattern +00452 _RE_ARGS ((<font class="keyword">const</font> <font class="keywordtype">char</font> *pattern, size_t length, +00453 <font class="keyword">struct</font> re_pattern_buffer * buffer)); +00454 +00455 +00456 <font class="comment">/* Compile a fastmap for the compiled pattern in BUFFER; used to +</font>00457 <font class="comment"> accelerate searches. Return 0 if successful and -2 if was an +</font>00458 <font class="comment"> internal error. */</font> +00459 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_compile_fastmap +00460 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer)); +00461 +00462 +00463 <font class="comment">/* Search in the string STRING (with length LENGTH) for the pattern +</font>00464 <font class="comment"> compiled into BUFFER. Start searching at position START, for RANGE +</font>00465 <font class="comment"> characters. Return the starting position of the match, -1 for no +</font>00466 <font class="comment"> match, or -2 for an internal error. Also return register +</font>00467 <font class="comment"> information in REGS (if REGS and BUFFER->no_sub are nonzero). */</font> +00468 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_search +00469 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string, +00470 <font class="keywordtype">int</font> length, <font class="keywordtype">int</font> start, <font class="keywordtype">int</font> range, <font class="keyword">struct</font> re_registers * regs)); +00471 +00472 +00473 <font class="comment">/* Like `re_search', but search in the concatenation of STRING1 and +</font>00474 <font class="comment"> STRING2. Also, stop searching at index START + STOP. */</font> +00475 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_search_2 +00476 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string1, +00477 <font class="keywordtype">int</font> length1, <font class="keyword">const</font> <font class="keywordtype">char</font> *string2, <font class="keywordtype">int</font> length2, +00478 <font class="keywordtype">int</font> start, <font class="keywordtype">int</font> range, <font class="keyword">struct</font> re_registers * regs, <font class="keywordtype">int</font> stop)); +00479 +00480 +00481 <font class="comment">/* Like `re_search', but return how many characters in STRING the regexp +</font>00482 <font class="comment"> in BUFFER matched, starting at position START. */</font> +00483 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_match +00484 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string, +00485 <font class="keywordtype">int</font> length, <font class="keywordtype">int</font> start, <font class="keyword">struct</font> re_registers * regs)); +00486 +00487 +00488 <font class="comment">/* Relates to `re_match' as `re_search_2' relates to `re_search'. */</font> +00489 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_match_2 +00490 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string1, +00491 <font class="keywordtype">int</font> length1, <font class="keyword">const</font> <font class="keywordtype">char</font> *string2, <font class="keywordtype">int</font> length2, +00492 <font class="keywordtype">int</font> start, <font class="keyword">struct</font> re_registers * regs, <font class="keywordtype">int</font> stop)); +00493 +00494 +00495 <font class="comment">/* Set REGS to hold NUM_REGS registers, storing them in STARTS and +</font>00496 <font class="comment"> ENDS. Subsequent matches using BUFFER and REGS will use this memory +</font>00497 <font class="comment"> for recording register information. STARTS and ENDS must be +</font>00498 <font class="comment"> allocated with malloc, and must each be at least `NUM_REGS * sizeof +</font>00499 <font class="comment"> (regoff_t)' bytes long. +</font>00500 <font class="comment"> +</font>00501 <font class="comment"> If NUM_REGS == 0, then subsequent matches should allocate their own +</font>00502 <font class="comment"> register data. +</font>00503 <font class="comment"> +</font>00504 <font class="comment"> Unless this function is called, the first search or match using +</font>00505 <font class="comment"> PATTERN_BUFFER will allocate its own register data, without +</font>00506 <font class="comment"> freeing the old data. */</font> +00507 <font class="keyword">extern</font> <font class="keywordtype">void</font> re_set_registers +00508 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">struct</font> re_registers * regs, +00509 <font class="keywordtype">unsigned</font> num_regs, regoff_t * starts, regoff_t * ends)); +00510 +00511 <font class="preprocessor">#ifdef _REGEX_RE_COMP +</font>00512 <font class="preprocessor"></font><font class="preprocessor">#ifndef _CRAY +</font>00513 <font class="preprocessor"></font><font class="comment">/* 4.2 bsd compatibility. */</font> +00514 <font class="keyword">extern</font> <font class="keywordtype">char</font> *re_comp _RE_ARGS ((<font class="keyword">const</font> <font class="keywordtype">char</font> *)); +00515 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_exec _RE_ARGS ((<font class="keyword">const</font> <font class="keywordtype">char</font> *)); +00516 <font class="preprocessor">#endif +</font>00517 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00518 <font class="preprocessor"></font> +00519 <font class="comment">/* POSIX compatibility. */</font> +00520 <font class="keyword">extern</font> <font class="keywordtype">int</font> regcomp +00521 _RE_ARGS ((regex_t * preg, <font class="keyword">const</font> <font class="keywordtype">char</font> *pattern, <font class="keywordtype">int</font> cflags)); +00522 <font class="keyword">extern</font> <font class="keywordtype">int</font> regexec +00523 _RE_ARGS ( +00524 (<font class="keyword">const</font> regex_t * preg, <font class="keyword">const</font> <font class="keywordtype">char</font> *string, size_t nmatch, +00525 regmatch_t pmatch[], <font class="keywordtype">int</font> eflags)); +00526 <font class="keyword">extern</font> size_t regerror +00527 _RE_ARGS ( +00528 (<font class="keywordtype">int</font> errcode, <font class="keyword">const</font> regex_t * preg, <font class="keywordtype">char</font> *errbuf, +00529 size_t errbuf_size)); +00530 <font class="keyword">extern</font> <font class="keywordtype">void</font> regfree _RE_ARGS ((regex_t * preg)); +00531 +00532 +00533 <font class="preprocessor">#ifdef __cplusplus +</font>00534 <font class="preprocessor"></font>} +00535 <font class="preprocessor">#endif </font><font class="comment">/* C++ */</font> +00536 +00537 <font class="preprocessor">#endif </font><font class="comment">/* regex.h */</font> +00538 +00539 <font class="comment">/* +</font>00540 <font class="comment">Local variables: +</font>00541 <font class="comment">make-backup-files: t +</font>00542 <font class="comment">version-control: t +</font>00543 <font class="comment">trim-versions-without-asking: nil +</font>00544 <font class="comment">End: +</font>00545 <font class="comment">*/</font> +</div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/regex_8h-source.html b/doc/api-documentation/html/regex_8h-source.html new file mode 100644 index 0000000..1e4ac7c --- /dev/null +++ b/doc/api-documentation/html/regex_8h-source.html @@ -0,0 +1,560 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>regex.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>regex.h</h1><div class="fragment"><pre>00001 <font class="comment">/* Definitions for data structures and routines for the regular</font> +00002 <font class="comment"> expression library, version 0.12.</font> +00003 <font class="comment"> Copyright (C) 1985,89,90,91,92,93,95,96,97 Free Software Foundation, Inc.</font> +00004 <font class="comment"></font> +00005 <font class="comment"> the C library, however. The master source lives in /gd/gnu/lib.</font> +00006 <font class="comment"></font> +00007 <font class="comment">NOTE: The canonical source of this file is maintained with the </font> +00008 <font class="comment">GNU C Library. Bugs can be reported to bug-glibc@prep.ai.mit.edu.</font> +00009 <font class="comment"></font> +00010 <font class="comment">This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment">under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment">Free Software Foundation; either version 2, or (at your option) any</font> +00013 <font class="comment">later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment">This program is distributed in the hope that it will be useful,</font> +00016 <font class="comment">but WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</font> +00018 <font class="comment">GNU General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment">You should have received a copy of the GNU General Public License</font> +00021 <font class="comment">along with this program; if not, write to the Free Software Foundation, </font> +00022 <font class="comment">Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */</font> +00023 +00024 <font class="preprocessor">#ifndef _REGEX_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define _REGEX_H 1</font> +00026 <font class="preprocessor"></font> +00027 <font class="comment">/* Allow the use in C++ code. */</font> +00028 <font class="preprocessor">#ifdef __cplusplus</font> +00029 <font class="preprocessor"></font><font class="keyword">extern</font> <font class="stringliteral">"C"</font> +00030 { +00031 <font class="preprocessor">#endif</font> +00032 <font class="preprocessor"></font> +00033 <font class="comment">/* POSIX says that <sys/types.h> must be included (by the caller) before</font> +00034 <font class="comment"> <regex.h>. */</font> +00035 +00036 <font class="preprocessor">#if !defined (_POSIX_C_SOURCE) && !defined (_POSIX_SOURCE) && defined (VMS)</font> +00037 <font class="preprocessor"></font><font class="comment">/* VMS doesn't have `size_t' in <sys/types.h>, even though POSIX says it</font> +00038 <font class="comment"> should be there. */</font> +00039 <font class="preprocessor">#include <stddef.h></font> +00040 <font class="preprocessor">#endif</font> +00041 <font class="preprocessor"></font> +00042 <font class="comment">/* The following two types have to be signed and unsigned integer type</font> +00043 <font class="comment"> wide enough to hold a value of a pointer. For most ANSI compilers</font> +00044 <font class="comment"> ptrdiff_t and size_t should be likely OK. Still size of these two</font> +00045 <font class="comment"> types is 2 for Microsoft C. Ugh... */</font> +00046 <font class="keyword">typedef</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> s_reg_t; +00047 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> active_reg_t; +00048 +00049 <font class="comment">/* The following bits are used to determine the regexp syntax we</font> +00050 <font class="comment"> recognize. The set/not-set meanings are chosen so that Emacs syntax</font> +00051 <font class="comment"> remains the value 0. The bits are given in alphabetical order, and</font> +00052 <font class="comment"> the definitions shifted by one from the previous bit; thus, when we</font> +00053 <font class="comment"> add or remove a bit, only one other definition need change. */</font> +00054 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> reg_syntax_t; +00055 +00056 <font class="comment">/* If this bit is not set, then \ inside a bracket expression is literal.</font> +00057 <font class="comment"> If set, then such a \ quotes the following character. */</font> +00058 <font class="preprocessor">#define RE_BACKSLASH_ESCAPE_IN_LISTS ((unsigned long int) 1)</font> +00059 <font class="preprocessor"></font> +00060 <font class="comment">/* If this bit is not set, then + and ? are operators, and \+ and \? are</font> +00061 <font class="comment"> literals.</font> +00062 <font class="comment"> If set, then \+ and \? are operators and + and ? are literals. */</font> +00063 <font class="preprocessor">#define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)</font> +00064 <font class="preprocessor"></font> +00065 <font class="comment">/* If this bit is set, then character classes are supported. They are:</font> +00066 <font class="comment"> [:alpha:], [:upper:], [:lower:], [:digit:], [:alnum:], [:xdigit:],</font> +00067 <font class="comment"> [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:].</font> +00068 <font class="comment"> If not set, then character classes are not supported. */</font> +00069 <font class="preprocessor">#define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1)</font> +00070 <font class="preprocessor"></font> +00071 <font class="comment">/* If this bit is set, then ^ and $ are always anchors (outside bracket</font> +00072 <font class="comment"> expressions, of course).</font> +00073 <font class="comment"> If this bit is not set, then it depends:</font> +00074 <font class="comment"> ^ is an anchor if it is at the beginning of a regular</font> +00075 <font class="comment"> expression or after an open-group or an alternation operator;</font> +00076 <font class="comment"> $ is an anchor if it is at the end of a regular expression, or</font> +00077 <font class="comment"> before a close-group or an alternation operator.</font> +00078 <font class="comment"></font> +00079 <font class="comment"> This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because</font> +00080 <font class="comment"> POSIX draft 11.2 says that * etc. in leading positions is undefined.</font> +00081 <font class="comment"> We already implemented a previous draft which made those constructs</font> +00082 <font class="comment"> invalid, though, so we haven't changed the code back. */</font> +00083 <font class="preprocessor">#define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1)</font> +00084 <font class="preprocessor"></font> +00085 <font class="comment">/* If this bit is set, then special characters are always special</font> +00086 <font class="comment"> regardless of where they are in the pattern.</font> +00087 <font class="comment"> If this bit is not set, then special characters are special only in</font> +00088 <font class="comment"> some contexts; otherwise they are ordinary. Specifically,</font> +00089 <font class="comment"> * + ? and intervals are only special when not after the beginning,</font> +00090 <font class="comment"> open-group, or alternation operator. */</font> +00091 <font class="preprocessor">#define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1)</font> +00092 <font class="preprocessor"></font> +00093 <font class="comment">/* If this bit is set, then *, +, ?, and { cannot be first in an re or</font> +00094 <font class="comment"> immediately after an alternation or begin-group operator. */</font> +00095 <font class="preprocessor">#define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1)</font> +00096 <font class="preprocessor"></font> +00097 <font class="comment">/* If this bit is set, then . matches newline.</font> +00098 <font class="comment"> If not set, then it doesn't. */</font> +00099 <font class="preprocessor">#define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1)</font> +00100 <font class="preprocessor"></font> +00101 <font class="comment">/* If this bit is set, then . doesn't match NUL.</font> +00102 <font class="comment"> If not set, then it does. */</font> +00103 <font class="preprocessor">#define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1)</font> +00104 <font class="preprocessor"></font> +00105 <font class="comment">/* If this bit is set, nonmatching lists [^...] do not match newline.</font> +00106 <font class="comment"> If not set, they do. */</font> +00107 <font class="preprocessor">#define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1)</font> +00108 <font class="preprocessor"></font> +00109 <font class="comment">/* If this bit is set, either \{...\} or {...} defines an</font> +00110 <font class="comment"> interval, depending on RE_NO_BK_BRACES.</font> +00111 <font class="comment"> If not set, \{, \}, {, and } are literals. */</font> +00112 <font class="preprocessor">#define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)</font> +00113 <font class="preprocessor"></font> +00114 <font class="comment">/* If this bit is set, +, ? and | aren't recognized as operators.</font> +00115 <font class="comment"> If not set, they are. */</font> +00116 <font class="preprocessor">#define RE_LIMITED_OPS (RE_INTERVALS << 1)</font> +00117 <font class="preprocessor"></font> +00118 <font class="comment">/* If this bit is set, newline is an alternation operator.</font> +00119 <font class="comment"> If not set, newline is literal. */</font> +00120 <font class="preprocessor">#define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1)</font> +00121 <font class="preprocessor"></font> +00122 <font class="comment">/* If this bit is set, then `{...}' defines an interval, and \{ and \}</font> +00123 <font class="comment"> are literals.</font> +00124 <font class="comment"> If not set, then `\{...\}' defines an interval. */</font> +00125 <font class="preprocessor">#define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1)</font> +00126 <font class="preprocessor"></font> +00127 <font class="comment">/* If this bit is set, (...) defines a group, and \( and \) are literals.</font> +00128 <font class="comment"> If not set, \(...\) defines a group, and ( and ) are literals. */</font> +00129 <font class="preprocessor">#define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1)</font> +00130 <font class="preprocessor"></font> +00131 <font class="comment">/* If this bit is set, then <digit> matches <digit>.</font> +00132 <font class="comment"> If not set, then <digit> is a back-reference. */</font> +00133 <font class="preprocessor">#define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1)</font> +00134 <font class="preprocessor"></font> +00135 <font class="comment">/* If this bit is set, then | is an alternation operator, and \| is literal.</font> +00136 <font class="comment"> If not set, then \| is an alternation operator, and | is literal. */</font> +00137 <font class="preprocessor">#define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)</font> +00138 <font class="preprocessor"></font> +00139 <font class="comment">/* If this bit is set, then an ending range point collating higher</font> +00140 <font class="comment"> than the starting range point, as in [z-a], is invalid.</font> +00141 <font class="comment"> If not set, then when ending range point collates higher than the</font> +00142 <font class="comment"> starting range point, the range is ignored. */</font> +00143 <font class="preprocessor">#define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1)</font> +00144 <font class="preprocessor"></font> +00145 <font class="comment">/* If this bit is set, then an unmatched ) is ordinary.</font> +00146 <font class="comment"> If not set, then an unmatched ) is invalid. */</font> +00147 <font class="preprocessor">#define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_EMPTY_RANGES << 1)</font> +00148 <font class="preprocessor"></font> +00149 <font class="comment">/* If this bit is set, succeed as soon as we match the whole pattern,</font> +00150 <font class="comment"> without further backtracking. */</font> +00151 <font class="preprocessor">#define RE_NO_POSIX_BACKTRACKING (RE_UNMATCHED_RIGHT_PAREN_ORD << 1)</font> +00152 <font class="preprocessor"></font> +00153 <font class="comment">/* If this bit is set, do not process the GNU regex operators.</font> +00154 <font class="comment"> If not set, then the GNU regex operators are recognized. */</font> +00155 <font class="preprocessor">#define RE_NO_GNU_OPS (RE_NO_POSIX_BACKTRACKING << 1)</font> +00156 <font class="preprocessor"></font> +00157 <font class="comment">/* If this bit is set, turn on internal regex debugging.</font> +00158 <font class="comment"> If not set, and debugging was on, turn it off.</font> +00159 <font class="comment"> This only works if regex.c is compiled -DDEBUG.</font> +00160 <font class="comment"> We define this bit always, so that all that's needed to turn on</font> +00161 <font class="comment"> debugging is to recompile regex.c; the calling code can always have</font> +00162 <font class="comment"> this bit set, and it won't affect anything in the normal case. */</font> +00163 <font class="preprocessor">#define RE_DEBUG (RE_NO_GNU_OPS << 1)</font> +00164 <font class="preprocessor"></font> +00165 <font class="comment">/* This global variable defines the particular regexp syntax to use (for</font> +00166 <font class="comment"> some interfaces). When a regexp is compiled, the syntax used is</font> +00167 <font class="comment"> stored in the pattern buffer, so changing this does not affect</font> +00168 <font class="comment"> already-compiled regexps. */</font> +00169 <font class="keyword">extern</font> reg_syntax_t re_syntax_options; +00170 +00171 <font class="comment">/* Define combinations of the above bits for the standard possibilities.</font> +00172 <font class="comment"> (The [[[ comments delimit what gets put into the Texinfo file, so</font> +00173 <font class="comment"> don't delete them!) */</font> +00174 <font class="comment">/* [[[begin syntaxes]]] */</font> +00175 <font class="preprocessor">#define RE_SYNTAX_EMACS 0</font> +00176 <font class="preprocessor"></font> +00177 <font class="preprocessor">#define RE_SYNTAX_AWK \</font> +00178 <font class="preprocessor"> (RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DOT_NOT_NULL \</font> +00179 <font class="preprocessor"> | RE_NO_BK_PARENS | RE_NO_BK_REFS \</font> +00180 <font class="preprocessor"> | RE_NO_BK_VBAR | RE_NO_EMPTY_RANGES \</font> +00181 <font class="preprocessor"> | RE_DOT_NEWLINE | RE_CONTEXT_INDEP_ANCHORS \</font> +00182 <font class="preprocessor"> | RE_UNMATCHED_RIGHT_PAREN_ORD | RE_NO_GNU_OPS)</font> +00183 <font class="preprocessor"></font> +00184 <font class="preprocessor">#define RE_SYNTAX_GNU_AWK \</font> +00185 <font class="preprocessor"> ((RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DEBUG) \</font> +00186 <font class="preprocessor"> & ~(RE_DOT_NOT_NULL | RE_INTERVALS | RE_CONTEXT_INDEP_OPS))</font> +00187 <font class="preprocessor"></font> +00188 <font class="preprocessor">#define RE_SYNTAX_POSIX_AWK \</font> +00189 <font class="preprocessor"> (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS \</font> +00190 <font class="preprocessor"> | RE_INTERVALS | RE_NO_GNU_OPS)</font> +00191 <font class="preprocessor"></font> +00192 <font class="preprocessor">#define RE_SYNTAX_GREP \</font> +00193 <font class="preprocessor"> (RE_BK_PLUS_QM | RE_CHAR_CLASSES \</font> +00194 <font class="preprocessor"> | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS \</font> +00195 <font class="preprocessor"> | RE_NEWLINE_ALT)</font> +00196 <font class="preprocessor"></font> +00197 <font class="preprocessor">#define RE_SYNTAX_EGREP \</font> +00198 <font class="preprocessor"> (RE_CHAR_CLASSES | RE_CONTEXT_INDEP_ANCHORS \</font> +00199 <font class="preprocessor"> | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE \</font> +00200 <font class="preprocessor"> | RE_NEWLINE_ALT | RE_NO_BK_PARENS \</font> +00201 <font class="preprocessor"> | RE_NO_BK_VBAR)</font> +00202 <font class="preprocessor"></font> +00203 <font class="preprocessor">#define RE_SYNTAX_POSIX_EGREP \</font> +00204 <font class="preprocessor"> (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES)</font> +00205 <font class="preprocessor"></font> +00206 <font class="comment">/* P1003.2/D11.2, section 4.20.7.1, lines 5078ff. */</font> +00207 <font class="preprocessor">#define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC</font> +00208 <font class="preprocessor"></font> +00209 <font class="preprocessor">#define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC</font> +00210 <font class="preprocessor"></font> +00211 <font class="comment">/* Syntax bits common to both basic and extended POSIX regex syntax. */</font> +00212 <font class="preprocessor">#define _RE_SYNTAX_POSIX_COMMON \</font> +00213 <font class="preprocessor"> (RE_CHAR_CLASSES | RE_DOT_NEWLINE | RE_DOT_NOT_NULL \</font> +00214 <font class="preprocessor"> | RE_INTERVALS | RE_NO_EMPTY_RANGES)</font> +00215 <font class="preprocessor"></font> +00216 <font class="preprocessor">#define RE_SYNTAX_POSIX_BASIC \</font> +00217 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM)</font> +00218 <font class="preprocessor"></font> +00219 <font class="comment">/* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes</font> +00220 <font class="comment"> RE_LIMITED_OPS, i.e., \? \+ \| are not recognized. Actually, this</font> +00221 <font class="comment"> isn't minimal, since other operators, such as \`, aren't disabled. */</font> +00222 <font class="preprocessor">#define RE_SYNTAX_POSIX_MINIMAL_BASIC \</font> +00223 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS)</font> +00224 <font class="preprocessor"></font> +00225 <font class="preprocessor">#define RE_SYNTAX_POSIX_EXTENDED \</font> +00226 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \</font> +00227 <font class="preprocessor"> | RE_CONTEXT_INDEP_OPS | RE_NO_BK_BRACES \</font> +00228 <font class="preprocessor"> | RE_NO_BK_PARENS | RE_NO_BK_VBAR \</font> +00229 <font class="preprocessor"> | RE_UNMATCHED_RIGHT_PAREN_ORD)</font> +00230 <font class="preprocessor"></font> +00231 <font class="comment">/* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INVALID_OPS</font> +00232 <font class="comment"> replaces RE_CONTEXT_INDEP_OPS and RE_NO_BK_REFS is added. */</font> +00233 <font class="preprocessor">#define RE_SYNTAX_POSIX_MINIMAL_EXTENDED \</font> +00234 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \</font> +00235 <font class="preprocessor"> | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES \</font> +00236 <font class="preprocessor"> | RE_NO_BK_PARENS | RE_NO_BK_REFS \</font> +00237 <font class="preprocessor"> | RE_NO_BK_VBAR | RE_UNMATCHED_RIGHT_PAREN_ORD)</font> +00238 <font class="preprocessor"></font><font class="comment">/* [[[end syntaxes]]] */</font> +00239 +00240 <font class="comment">/* Maximum number of duplicates an interval can allow. Some systems</font> +00241 <font class="comment"> (erroneously) define this in other header files, but we want our</font> +00242 <font class="comment"> value, so remove any previous define. */</font> +00243 <font class="preprocessor">#ifdef RE_DUP_MAX</font> +00244 <font class="preprocessor"></font><font class="preprocessor">#undef RE_DUP_MAX</font> +00245 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00246 <font class="preprocessor"></font><font class="comment">/* If sizeof(int) == 2, then ((1 << 15) - 1) overflows. */</font> +00247 <font class="preprocessor">#define RE_DUP_MAX (0x7fff)</font> +00248 <font class="preprocessor"></font> +00249 +00250 <font class="comment">/* POSIX `cflags' bits (i.e., information for `regcomp'). */</font> +00251 +00252 <font class="comment">/* If this bit is set, then use extended regular expression syntax.</font> +00253 <font class="comment"> If not set, then use basic regular expression syntax. */</font> +00254 <font class="preprocessor">#define REG_EXTENDED 1</font> +00255 <font class="preprocessor"></font> +00256 <font class="comment">/* If this bit is set, then ignore case when matching.</font> +00257 <font class="comment"> If not set, then case is significant. */</font> +00258 <font class="preprocessor">#define REG_ICASE (REG_EXTENDED << 1)</font> +00259 <font class="preprocessor"></font> +00260 <font class="comment">/* If this bit is set, then anchors do not match at newline</font> +00261 <font class="comment"> characters in the string.</font> +00262 <font class="comment"> If not set, then anchors do match at newlines. */</font> +00263 <font class="preprocessor">#define REG_NEWLINE (REG_ICASE << 1)</font> +00264 <font class="preprocessor"></font> +00265 <font class="comment">/* If this bit is set, then report only success or fail in regexec.</font> +00266 <font class="comment"> If not set, then returns differ between not matching and errors. */</font> +00267 <font class="preprocessor">#define REG_NOSUB (REG_NEWLINE << 1)</font> +00268 <font class="preprocessor"></font> +00269 +00270 <font class="comment">/* POSIX `eflags' bits (i.e., information for regexec). */</font> +00271 +00272 <font class="comment">/* If this bit is set, then the beginning-of-line operator doesn't match</font> +00273 <font class="comment"> the beginning of the string (presumably because it's not the</font> +00274 <font class="comment"> beginning of a line).</font> +00275 <font class="comment"> If not set, then the beginning-of-line operator does match the</font> +00276 <font class="comment"> beginning of the string. */</font> +00277 <font class="preprocessor">#define REG_NOTBOL 1</font> +00278 <font class="preprocessor"></font> +00279 <font class="comment">/* Like REG_NOTBOL, except for the end-of-line. */</font> +00280 <font class="preprocessor">#define REG_NOTEOL (1 << 1)</font> +00281 <font class="preprocessor"></font> +00282 +00283 <font class="comment">/* If any error codes are removed, changed, or added, update the</font> +00284 <font class="comment"> `re_error_msg' table in regex.c. */</font> +00285 <font class="keyword">typedef</font> <font class="keyword">enum</font> +00286 { +00287 REG_NOERROR = 0, <font class="comment">/* Success. */</font> +00288 REG_NOMATCH, <font class="comment">/* Didn't find a match (for regexec). */</font> +00289 +00290 <font class="comment">/* POSIX regcomp return error codes. (In the order listed in the</font> +00291 <font class="comment"> standard.) */</font> +00292 REG_BADPAT, <font class="comment">/* Invalid pattern. */</font> +00293 REG_ECOLLATE, <font class="comment">/* Not implemented. */</font> +00294 REG_ECTYPE, <font class="comment">/* Invalid character class name. */</font> +00295 REG_EESCAPE, <font class="comment">/* Trailing backslash. */</font> +00296 REG_ESUBREG, <font class="comment">/* Invalid back reference. */</font> +00297 REG_EBRACK, <font class="comment">/* Unmatched left bracket. */</font> +00298 REG_EPAREN, <font class="comment">/* Parenthesis imbalance. */</font> +00299 REG_EBRACE, <font class="comment">/* Unmatched \{. */</font> +00300 REG_BADBR, <font class="comment">/* Invalid contents of \{\}. */</font> +00301 REG_ERANGE, <font class="comment">/* Invalid range end. */</font> +00302 REG_ESPACE, <font class="comment">/* Ran out of memory. */</font> +00303 REG_BADRPT, <font class="comment">/* No preceding re for repetition op. */</font> +00304 +00305 <font class="comment">/* Error codes we've added. */</font> +00306 REG_EEND, <font class="comment">/* Premature end. */</font> +00307 REG_ESIZE, <font class="comment">/* Compiled pattern bigger than 2^16 bytes. */</font> +00308 REG_ERPAREN <font class="comment">/* Unmatched ) or \); not returned from regcomp. */</font> +00309 } +00310 reg_errcode_t; +00311 +00312 <font class="comment">/* This data structure represents a compiled pattern. Before calling</font> +00313 <font class="comment"> the pattern compiler, the fields `buffer', `allocated', `fastmap',</font> +00314 <font class="comment"> `translate', and `no_sub' can be set. After the pattern has been</font> +00315 <font class="comment"> compiled, the `re_nsub' field is available. All other fields are</font> +00316 <font class="comment"> private to the regex routines. */</font> +00317 +00318 <font class="preprocessor">#ifndef RE_TRANSLATE_TYPE</font> +00319 <font class="preprocessor"></font><font class="preprocessor">#define RE_TRANSLATE_TYPE char *</font> +00320 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00321 <font class="preprocessor"></font> +00322 <font class="keyword">struct </font>re_pattern_buffer +00323 { +00324 <font class="comment">/* [[[begin pattern_buffer]]] */</font> +00325 <font class="comment">/* Space that holds the compiled pattern. It is declared as</font> +00326 <font class="comment"> `unsigned char *' because its elements are</font> +00327 <font class="comment"> sometimes used as array indexes. */</font> +00328 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *buffer; +00329 +00330 <font class="comment">/* Number of bytes to which `buffer' points. */</font> +00331 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> allocated; +00332 +00333 <font class="comment">/* Number of bytes actually used in `buffer'. */</font> +00334 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> used; +00335 +00336 <font class="comment">/* Syntax setting with which the pattern was compiled. */</font> +00337 reg_syntax_t syntax; +00338 +00339 <font class="comment">/* Pointer to a fastmap, if any, otherwise zero. re_search uses</font> +00340 <font class="comment"> the fastmap, if there is one, to skip over impossible</font> +00341 <font class="comment"> starting points for matches. */</font> +00342 <font class="keywordtype">char</font> *fastmap; +00343 +00344 <font class="comment">/* Either a translate table to apply to all characters before</font> +00345 <font class="comment"> comparing them, or zero for no translation. The translation</font> +00346 <font class="comment"> is applied to a pattern when it is compiled and to a string</font> +00347 <font class="comment"> when it is matched. */</font> +00348 RE_TRANSLATE_TYPE translate; +00349 +00350 <font class="comment">/* Number of subexpressions found by the compiler. */</font> +00351 size_t re_nsub; +00352 +00353 <font class="comment">/* Zero if this pattern cannot match the empty string, one else.</font> +00354 <font class="comment"> Well, in truth it's used only in `re_search_2', to see</font> +00355 <font class="comment"> whether or not we should use the fastmap, so we don't set</font> +00356 <font class="comment"> this absolutely perfectly; see `re_compile_fastmap' (the</font> +00357 <font class="comment"> `duplicate' case). */</font> +00358 <font class="keywordtype">unsigned</font> can_be_null:1; +00359 +00360 <font class="comment">/* If REGS_UNALLOCATED, allocate space in the `regs' structure</font> +00361 <font class="comment"> for `max (RE_NREGS, re_nsub + 1)' groups.</font> +00362 <font class="comment"> If REGS_REALLOCATE, reallocate space if necessary.</font> +00363 <font class="comment"> If REGS_FIXED, use what's there. */</font> +00364 <font class="preprocessor">#define REGS_UNALLOCATED 0</font> +00365 <font class="preprocessor"></font><font class="preprocessor">#define REGS_REALLOCATE 1</font> +00366 <font class="preprocessor"></font><font class="preprocessor">#define REGS_FIXED 2</font> +00367 <font class="preprocessor"></font> <font class="keywordtype">unsigned</font> regs_allocated:2; +00368 +00369 <font class="comment">/* Set to zero when `regex_compile' compiles a pattern; set to one</font> +00370 <font class="comment"> by `re_compile_fastmap' if it updates the fastmap. */</font> +00371 <font class="keywordtype">unsigned</font> fastmap_accurate:1; +00372 +00373 <font class="comment">/* If set, `re_match_2' does not return information about</font> +00374 <font class="comment"> subexpressions. */</font> +00375 <font class="keywordtype">unsigned</font> no_sub:1; +00376 +00377 <font class="comment">/* If set, a beginning-of-line anchor doesn't match at the</font> +00378 <font class="comment"> beginning of the string. */</font> +00379 <font class="keywordtype">unsigned</font> not_bol:1; +00380 +00381 <font class="comment">/* Similarly for an end-of-line anchor. */</font> +00382 <font class="keywordtype">unsigned</font> not_eol:1; +00383 +00384 <font class="comment">/* If true, an anchor at a newline matches. */</font> +00385 <font class="keywordtype">unsigned</font> newline_anchor:1; +00386 +00387 <font class="comment">/* [[[end pattern_buffer]]] */</font> +00388 }; +00389 +00390 <font class="keyword">typedef</font> <font class="keyword">struct </font>re_pattern_buffer regex_t; +00391 +00392 <font class="comment">/* Type for byte offsets within the string. POSIX mandates this. */</font> +00393 <font class="keyword">typedef</font> <font class="keywordtype">int</font> regoff_t; +00394 +00395 +00396 <font class="comment">/* This is the structure we store register match data in. See</font> +00397 <font class="comment"> regex.texinfo for a full description of what registers match. */</font> +00398 <font class="keyword">struct </font>re_registers +00399 { +00400 <font class="keywordtype">unsigned</font> num_regs; +00401 regoff_t *start; +00402 regoff_t *end; +00403 }; +00404 +00405 +00406 <font class="comment">/* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer,</font> +00407 <font class="comment"> `re_match_2' returns information about at least this many registers</font> +00408 <font class="comment"> the first time a `regs' structure is passed. */</font> +00409 <font class="preprocessor">#ifndef RE_NREGS</font> +00410 <font class="preprocessor"></font><font class="preprocessor">#define RE_NREGS 30</font> +00411 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00412 <font class="preprocessor"></font> +00413 +00414 <font class="comment">/* POSIX specification for registers. Aside from the different names than</font> +00415 <font class="comment"> `re_registers', POSIX uses an array of structures, instead of a</font> +00416 <font class="comment"> structure of arrays. */</font> +00417 <font class="keyword">typedef</font> <font class="keyword">struct</font> +00418 <font class="keyword"> </font>{ +00419 regoff_t rm_so; <font class="comment">/* Byte offset from string's start to substring's start. */</font> +00420 regoff_t rm_eo; <font class="comment">/* Byte offset from string's start to substring's end. */</font> +00421 } +00422 regmatch_t; +00423 +00424 <font class="comment">/* Declarations for routines. */</font> +00425 +00426 <font class="comment">/* To avoid duplicating every routine declaration -- once with a</font> +00427 <font class="comment"> prototype (if we are ANSI), and once without (if we aren't) -- we</font> +00428 <font class="comment"> use the following macro to declare argument types. This</font> +00429 <font class="comment"> unfortunately clutters up the declarations a bit, but I think it's</font> +00430 <font class="comment"> worth it. */</font> +00431 <font class="preprocessor">#ifndef __STDC__</font> +00432 <font class="preprocessor"></font><font class="preprocessor">#define __STDC__ 1</font> +00433 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00434 <font class="preprocessor"></font><font class="preprocessor">#if __STDC__</font> +00435 <font class="preprocessor"></font> +00436 <font class="preprocessor">#define _RE_ARGS(args) args</font> +00437 <font class="preprocessor"></font> +00438 <font class="preprocessor">#else </font><font class="comment">/* not __STDC__ */</font> +00439 +00440 <font class="preprocessor">#define _RE_ARGS(args) ()</font> +00441 <font class="preprocessor"></font> +00442 <font class="preprocessor">#endif </font><font class="comment">/* not __STDC__ */</font> +00443 +00444 <font class="comment">/* Sets the current default syntax to SYNTAX, and return the old syntax.</font> +00445 <font class="comment"> You can also simply assign to the `re_syntax_options' variable. */</font> +00446 <font class="keyword">extern</font> reg_syntax_t re_set_syntax _RE_ARGS ((reg_syntax_t syntax)); +00447 +00448 <font class="comment">/* Compile the regular expression PATTERN, with length LENGTH</font> +00449 <font class="comment"> and syntax given by the global `re_syntax_options', into the buffer</font> +00450 <font class="comment"> BUFFER. Return NULL if successful, and an error string if not. */</font> +00451 <font class="keyword">extern</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *re_compile_pattern +00452 _RE_ARGS ((<font class="keyword">const</font> <font class="keywordtype">char</font> *pattern, size_t length, +00453 <font class="keyword">struct</font> re_pattern_buffer * buffer)); +00454 +00455 +00456 <font class="comment">/* Compile a fastmap for the compiled pattern in BUFFER; used to</font> +00457 <font class="comment"> accelerate searches. Return 0 if successful and -2 if was an</font> +00458 <font class="comment"> internal error. */</font> +00459 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_compile_fastmap +00460 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer)); +00461 +00462 +00463 <font class="comment">/* Search in the string STRING (with length LENGTH) for the pattern</font> +00464 <font class="comment"> compiled into BUFFER. Start searching at position START, for RANGE</font> +00465 <font class="comment"> characters. Return the starting position of the match, -1 for no</font> +00466 <font class="comment"> match, or -2 for an internal error. Also return register</font> +00467 <font class="comment"> information in REGS (if REGS and BUFFER->no_sub are nonzero). */</font> +00468 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_search +00469 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string, +00470 <font class="keywordtype">int</font> length, <font class="keywordtype">int</font> start, <font class="keywordtype">int</font> range, <font class="keyword">struct</font> re_registers * regs)); +00471 +00472 +00473 <font class="comment">/* Like `re_search', but search in the concatenation of STRING1 and</font> +00474 <font class="comment"> STRING2. Also, stop searching at index START + STOP. */</font> +00475 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_search_2 +00476 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string1, +00477 <font class="keywordtype">int</font> length1, <font class="keyword">const</font> <font class="keywordtype">char</font> *string2, <font class="keywordtype">int</font> length2, +00478 <font class="keywordtype">int</font> start, <font class="keywordtype">int</font> range, <font class="keyword">struct</font> re_registers * regs, <font class="keywordtype">int</font> stop)); +00479 +00480 +00481 <font class="comment">/* Like `re_search', but return how many characters in STRING the regexp</font> +00482 <font class="comment"> in BUFFER matched, starting at position START. */</font> +00483 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_match +00484 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string, +00485 <font class="keywordtype">int</font> length, <font class="keywordtype">int</font> start, <font class="keyword">struct</font> re_registers * regs)); +00486 +00487 +00488 <font class="comment">/* Relates to `re_match' as `re_search_2' relates to `re_search'. */</font> +00489 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_match_2 +00490 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string1, +00491 <font class="keywordtype">int</font> length1, <font class="keyword">const</font> <font class="keywordtype">char</font> *string2, <font class="keywordtype">int</font> length2, +00492 <font class="keywordtype">int</font> start, <font class="keyword">struct</font> re_registers * regs, <font class="keywordtype">int</font> stop)); +00493 +00494 +00495 <font class="comment">/* Set REGS to hold NUM_REGS registers, storing them in STARTS and</font> +00496 <font class="comment"> ENDS. Subsequent matches using BUFFER and REGS will use this memory</font> +00497 <font class="comment"> for recording register information. STARTS and ENDS must be</font> +00498 <font class="comment"> allocated with malloc, and must each be at least `NUM_REGS * sizeof</font> +00499 <font class="comment"> (regoff_t)' bytes long.</font> +00500 <font class="comment"></font> +00501 <font class="comment"> If NUM_REGS == 0, then subsequent matches should allocate their own</font> +00502 <font class="comment"> register data.</font> +00503 <font class="comment"></font> +00504 <font class="comment"> Unless this function is called, the first search or match using</font> +00505 <font class="comment"> PATTERN_BUFFER will allocate its own register data, without</font> +00506 <font class="comment"> freeing the old data. */</font> +00507 <font class="keyword">extern</font> <font class="keywordtype">void</font> re_set_registers +00508 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">struct</font> re_registers * regs, +00509 <font class="keywordtype">unsigned</font> num_regs, regoff_t * starts, regoff_t * ends)); +00510 +00511 <font class="preprocessor">#ifdef _REGEX_RE_COMP</font> +00512 <font class="preprocessor"></font><font class="preprocessor">#ifndef _CRAY</font> +00513 <font class="preprocessor"></font><font class="comment">/* 4.2 bsd compatibility. */</font> +00514 <font class="keyword">extern</font> <font class="keywordtype">char</font> *re_comp _RE_ARGS ((<font class="keyword">const</font> <font class="keywordtype">char</font> *)); +00515 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_exec _RE_ARGS ((<font class="keyword">const</font> <font class="keywordtype">char</font> *)); +00516 <font class="preprocessor">#endif</font> +00517 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00518 <font class="preprocessor"></font> +00519 <font class="comment">/* POSIX compatibility. */</font> +00520 <font class="keyword">extern</font> <font class="keywordtype">int</font> regcomp +00521 _RE_ARGS ((regex_t * preg, <font class="keyword">const</font> <font class="keywordtype">char</font> *pattern, <font class="keywordtype">int</font> cflags)); +00522 <font class="keyword">extern</font> <font class="keywordtype">int</font> regexec +00523 _RE_ARGS ( +00524 (<font class="keyword">const</font> regex_t * preg, <font class="keyword">const</font> <font class="keywordtype">char</font> *string, size_t nmatch, +00525 regmatch_t pmatch[], <font class="keywordtype">int</font> eflags)); +00526 <font class="keyword">extern</font> size_t regerror +00527 _RE_ARGS ( +00528 (<font class="keywordtype">int</font> errcode, <font class="keyword">const</font> regex_t * preg, <font class="keywordtype">char</font> *errbuf, +00529 size_t errbuf_size)); +00530 <font class="keyword">extern</font> <font class="keywordtype">void</font> regfree _RE_ARGS ((regex_t * preg)); +00531 +00532 +00533 <font class="preprocessor">#ifdef __cplusplus</font> +00534 <font class="preprocessor"></font>} +00535 <font class="preprocessor">#endif </font><font class="comment">/* C++ */</font> +00536 +00537 <font class="preprocessor">#endif </font><font class="comment">/* regex.h */</font> +00538 +00539 <font class="comment">/*</font> +00540 <font class="comment">Local variables:</font> +00541 <font class="comment">make-backup-files: t</font> +00542 <font class="comment">version-control: t</font> +00543 <font class="comment">trim-versions-without-asking: nil</font> +00544 <font class="comment">End:</font> +00545 <font class="comment">*/</font> +</pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/regex_h-source.html b/doc/api-documentation/html/regex_h-source.html new file mode 100644 index 0000000..a2ea1fd --- /dev/null +++ b/doc/api-documentation/html/regex_h-source.html @@ -0,0 +1,561 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>regex.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>regex.h</h1><div class="fragment"><pre>00001 <font class="comment">/* Definitions for data structures and routines for the regular</font> +00002 <font class="comment"> expression library, version 0.12.</font> +00003 <font class="comment"> Copyright (C) 1985,89,90,91,92,93,95,96,97 Free Software Foundation, Inc.</font> +00004 <font class="comment"></font> +00005 <font class="comment"> the C library, however. The master source lives in /gd/gnu/lib.</font> +00006 <font class="comment"></font> +00007 <font class="comment">NOTE: The canonical source of this file is maintained with the </font> +00008 <font class="comment">GNU C Library. Bugs can be reported to bug-glibc@prep.ai.mit.edu.</font> +00009 <font class="comment"></font> +00010 <font class="comment">This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment">under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment">Free Software Foundation; either version 2, or (at your option) any</font> +00013 <font class="comment">later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment">This program is distributed in the hope that it will be useful,</font> +00016 <font class="comment">but WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</font> +00018 <font class="comment">GNU General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment">You should have received a copy of the GNU General Public License</font> +00021 <font class="comment">along with this program; if not, write to the Free Software Foundation, </font> +00022 <font class="comment">Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */</font> +00023 +00024 <font class="preprocessor">#ifndef _REGEX_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define _REGEX_H 1</font> +00026 <font class="preprocessor"></font> +00027 <font class="comment">/* Allow the use in C++ code. */</font> +00028 <font class="preprocessor">#ifdef __cplusplus</font> +00029 <font class="preprocessor"></font><font class="keyword">extern</font> <font class="stringliteral">"C"</font> +00030 { +00031 <font class="preprocessor">#endif</font> +00032 <font class="preprocessor"></font> +00033 <font class="comment">/* POSIX says that <sys/types.h> must be included (by the caller) before</font> +00034 <font class="comment"> <regex.h>. */</font> +00035 +00036 <font class="preprocessor">#if !defined (_POSIX_C_SOURCE) && !defined (_POSIX_SOURCE) && defined (VMS)</font> +00037 <font class="preprocessor"></font><font class="comment">/* VMS doesn't have `size_t' in <sys/types.h>, even though POSIX says it</font> +00038 <font class="comment"> should be there. */</font> +00039 <font class="preprocessor">#include <stddef.h></font> +00040 <font class="preprocessor">#endif</font> +00041 <font class="preprocessor"></font> +00042 <font class="comment">/* The following two types have to be signed and unsigned integer type</font> +00043 <font class="comment"> wide enough to hold a value of a pointer. For most ANSI compilers</font> +00044 <font class="comment"> ptrdiff_t and size_t should be likely OK. Still size of these two</font> +00045 <font class="comment"> types is 2 for Microsoft C. Ugh... */</font> +00046 <font class="keyword">typedef</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> s_reg_t; +00047 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> active_reg_t; +00048 +00049 <font class="comment">/* The following bits are used to determine the regexp syntax we</font> +00050 <font class="comment"> recognize. The set/not-set meanings are chosen so that Emacs syntax</font> +00051 <font class="comment"> remains the value 0. The bits are given in alphabetical order, and</font> +00052 <font class="comment"> the definitions shifted by one from the previous bit; thus, when we</font> +00053 <font class="comment"> add or remove a bit, only one other definition need change. */</font> +00054 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> reg_syntax_t; +00055 +00056 <font class="comment">/* If this bit is not set, then \ inside a bracket expression is literal.</font> +00057 <font class="comment"> If set, then such a \ quotes the following character. */</font> +00058 <font class="preprocessor">#define RE_BACKSLASH_ESCAPE_IN_LISTS ((unsigned long int) 1)</font> +00059 <font class="preprocessor"></font> +00060 <font class="comment">/* If this bit is not set, then + and ? are operators, and \+ and \? are</font> +00061 <font class="comment"> literals.</font> +00062 <font class="comment"> If set, then \+ and \? are operators and + and ? are literals. */</font> +00063 <font class="preprocessor">#define RE_BK_PLUS_QM (RE_BACKSLASH_ESCAPE_IN_LISTS << 1)</font> +00064 <font class="preprocessor"></font> +00065 <font class="comment">/* If this bit is set, then character classes are supported. They are:</font> +00066 <font class="comment"> [:alpha:], [:upper:], [:lower:], [:digit:], [:alnum:], [:xdigit:],</font> +00067 <font class="comment"> [:space:], [:print:], [:punct:], [:graph:], and [:cntrl:].</font> +00068 <font class="comment"> If not set, then character classes are not supported. */</font> +00069 <font class="preprocessor">#define RE_CHAR_CLASSES (RE_BK_PLUS_QM << 1)</font> +00070 <font class="preprocessor"></font> +00071 <font class="comment">/* If this bit is set, then ^ and $ are always anchors (outside bracket</font> +00072 <font class="comment"> expressions, of course).</font> +00073 <font class="comment"> If this bit is not set, then it depends:</font> +00074 <font class="comment"> ^ is an anchor if it is at the beginning of a regular</font> +00075 <font class="comment"> expression or after an open-group or an alternation operator;</font> +00076 <font class="comment"> $ is an anchor if it is at the end of a regular expression, or</font> +00077 <font class="comment"> before a close-group or an alternation operator.</font> +00078 <font class="comment"></font> +00079 <font class="comment"> This bit could be (re)combined with RE_CONTEXT_INDEP_OPS, because</font> +00080 <font class="comment"> POSIX draft 11.2 says that * etc. in leading positions is undefined.</font> +00081 <font class="comment"> We already implemented a previous draft which made those constructs</font> +00082 <font class="comment"> invalid, though, so we haven't changed the code back. */</font> +00083 <font class="preprocessor">#define RE_CONTEXT_INDEP_ANCHORS (RE_CHAR_CLASSES << 1)</font> +00084 <font class="preprocessor"></font> +00085 <font class="comment">/* If this bit is set, then special characters are always special</font> +00086 <font class="comment"> regardless of where they are in the pattern.</font> +00087 <font class="comment"> If this bit is not set, then special characters are special only in</font> +00088 <font class="comment"> some contexts; otherwise they are ordinary. Specifically,</font> +00089 <font class="comment"> * + ? and intervals are only special when not after the beginning,</font> +00090 <font class="comment"> open-group, or alternation operator. */</font> +00091 <font class="preprocessor">#define RE_CONTEXT_INDEP_OPS (RE_CONTEXT_INDEP_ANCHORS << 1)</font> +00092 <font class="preprocessor"></font> +00093 <font class="comment">/* If this bit is set, then *, +, ?, and { cannot be first in an re or</font> +00094 <font class="comment"> immediately after an alternation or begin-group operator. */</font> +00095 <font class="preprocessor">#define RE_CONTEXT_INVALID_OPS (RE_CONTEXT_INDEP_OPS << 1)</font> +00096 <font class="preprocessor"></font> +00097 <font class="comment">/* If this bit is set, then . matches newline.</font> +00098 <font class="comment"> If not set, then it doesn't. */</font> +00099 <font class="preprocessor">#define RE_DOT_NEWLINE (RE_CONTEXT_INVALID_OPS << 1)</font> +00100 <font class="preprocessor"></font> +00101 <font class="comment">/* If this bit is set, then . doesn't match NUL.</font> +00102 <font class="comment"> If not set, then it does. */</font> +00103 <font class="preprocessor">#define RE_DOT_NOT_NULL (RE_DOT_NEWLINE << 1)</font> +00104 <font class="preprocessor"></font> +00105 <font class="comment">/* If this bit is set, nonmatching lists [^...] do not match newline.</font> +00106 <font class="comment"> If not set, they do. */</font> +00107 <font class="preprocessor">#define RE_HAT_LISTS_NOT_NEWLINE (RE_DOT_NOT_NULL << 1)</font> +00108 <font class="preprocessor"></font> +00109 <font class="comment">/* If this bit is set, either \{...\} or {...} defines an</font> +00110 <font class="comment"> interval, depending on RE_NO_BK_BRACES.</font> +00111 <font class="comment"> If not set, \{, \}, {, and } are literals. */</font> +00112 <font class="preprocessor">#define RE_INTERVALS (RE_HAT_LISTS_NOT_NEWLINE << 1)</font> +00113 <font class="preprocessor"></font> +00114 <font class="comment">/* If this bit is set, +, ? and | aren't recognized as operators.</font> +00115 <font class="comment"> If not set, they are. */</font> +00116 <font class="preprocessor">#define RE_LIMITED_OPS (RE_INTERVALS << 1)</font> +00117 <font class="preprocessor"></font> +00118 <font class="comment">/* If this bit is set, newline is an alternation operator.</font> +00119 <font class="comment"> If not set, newline is literal. */</font> +00120 <font class="preprocessor">#define RE_NEWLINE_ALT (RE_LIMITED_OPS << 1)</font> +00121 <font class="preprocessor"></font> +00122 <font class="comment">/* If this bit is set, then `{...}' defines an interval, and \{ and \}</font> +00123 <font class="comment"> are literals.</font> +00124 <font class="comment"> If not set, then `\{...\}' defines an interval. */</font> +00125 <font class="preprocessor">#define RE_NO_BK_BRACES (RE_NEWLINE_ALT << 1)</font> +00126 <font class="preprocessor"></font> +00127 <font class="comment">/* If this bit is set, (...) defines a group, and \( and \) are literals.</font> +00128 <font class="comment"> If not set, \(...\) defines a group, and ( and ) are literals. */</font> +00129 <font class="preprocessor">#define RE_NO_BK_PARENS (RE_NO_BK_BRACES << 1)</font> +00130 <font class="preprocessor"></font> +00131 <font class="comment">/* If this bit is set, then <digit> matches <digit>.</font> +00132 <font class="comment"> If not set, then <digit> is a back-reference. */</font> +00133 <font class="preprocessor">#define RE_NO_BK_REFS (RE_NO_BK_PARENS << 1)</font> +00134 <font class="preprocessor"></font> +00135 <font class="comment">/* If this bit is set, then | is an alternation operator, and \| is literal.</font> +00136 <font class="comment"> If not set, then \| is an alternation operator, and | is literal. */</font> +00137 <font class="preprocessor">#define RE_NO_BK_VBAR (RE_NO_BK_REFS << 1)</font> +00138 <font class="preprocessor"></font> +00139 <font class="comment">/* If this bit is set, then an ending range point collating higher</font> +00140 <font class="comment"> than the starting range point, as in [z-a], is invalid.</font> +00141 <font class="comment"> If not set, then when ending range point collates higher than the</font> +00142 <font class="comment"> starting range point, the range is ignored. */</font> +00143 <font class="preprocessor">#define RE_NO_EMPTY_RANGES (RE_NO_BK_VBAR << 1)</font> +00144 <font class="preprocessor"></font> +00145 <font class="comment">/* If this bit is set, then an unmatched ) is ordinary.</font> +00146 <font class="comment"> If not set, then an unmatched ) is invalid. */</font> +00147 <font class="preprocessor">#define RE_UNMATCHED_RIGHT_PAREN_ORD (RE_NO_EMPTY_RANGES << 1)</font> +00148 <font class="preprocessor"></font> +00149 <font class="comment">/* If this bit is set, succeed as soon as we match the whole pattern,</font> +00150 <font class="comment"> without further backtracking. */</font> +00151 <font class="preprocessor">#define RE_NO_POSIX_BACKTRACKING (RE_UNMATCHED_RIGHT_PAREN_ORD << 1)</font> +00152 <font class="preprocessor"></font> +00153 <font class="comment">/* If this bit is set, do not process the GNU regex operators.</font> +00154 <font class="comment"> If not set, then the GNU regex operators are recognized. */</font> +00155 <font class="preprocessor">#define RE_NO_GNU_OPS (RE_NO_POSIX_BACKTRACKING << 1)</font> +00156 <font class="preprocessor"></font> +00157 <font class="comment">/* If this bit is set, turn on internal regex debugging.</font> +00158 <font class="comment"> If not set, and debugging was on, turn it off.</font> +00159 <font class="comment"> This only works if regex.c is compiled -DDEBUG.</font> +00160 <font class="comment"> We define this bit always, so that all that's needed to turn on</font> +00161 <font class="comment"> debugging is to recompile regex.c; the calling code can always have</font> +00162 <font class="comment"> this bit set, and it won't affect anything in the normal case. */</font> +00163 <font class="preprocessor">#define RE_DEBUG (RE_NO_GNU_OPS << 1)</font> +00164 <font class="preprocessor"></font> +00165 <font class="comment">/* This global variable defines the particular regexp syntax to use (for</font> +00166 <font class="comment"> some interfaces). When a regexp is compiled, the syntax used is</font> +00167 <font class="comment"> stored in the pattern buffer, so changing this does not affect</font> +00168 <font class="comment"> already-compiled regexps. */</font> +00169 <font class="keyword">extern</font> reg_syntax_t re_syntax_options; +00170 +00171 <font class="comment">/* Define combinations of the above bits for the standard possibilities.</font> +00172 <font class="comment"> (The [[[ comments delimit what gets put into the Texinfo file, so</font> +00173 <font class="comment"> don't delete them!) */</font> +00174 <font class="comment">/* [[[begin syntaxes]]] */</font> +00175 <font class="preprocessor">#define RE_SYNTAX_EMACS 0</font> +00176 <font class="preprocessor"></font> +00177 <font class="preprocessor">#define RE_SYNTAX_AWK \</font> +00178 <font class="preprocessor"> (RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DOT_NOT_NULL \</font> +00179 <font class="preprocessor"> | RE_NO_BK_PARENS | RE_NO_BK_REFS \</font> +00180 <font class="preprocessor"> | RE_NO_BK_VBAR | RE_NO_EMPTY_RANGES \</font> +00181 <font class="preprocessor"> | RE_DOT_NEWLINE | RE_CONTEXT_INDEP_ANCHORS \</font> +00182 <font class="preprocessor"> | RE_UNMATCHED_RIGHT_PAREN_ORD | RE_NO_GNU_OPS)</font> +00183 <font class="preprocessor"></font> +00184 <font class="preprocessor">#define RE_SYNTAX_GNU_AWK \</font> +00185 <font class="preprocessor"> ((RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS | RE_DEBUG) \</font> +00186 <font class="preprocessor"> & ~(RE_DOT_NOT_NULL | RE_INTERVALS | RE_CONTEXT_INDEP_OPS))</font> +00187 <font class="preprocessor"></font> +00188 <font class="preprocessor">#define RE_SYNTAX_POSIX_AWK \</font> +00189 <font class="preprocessor"> (RE_SYNTAX_POSIX_EXTENDED | RE_BACKSLASH_ESCAPE_IN_LISTS \</font> +00190 <font class="preprocessor"> | RE_INTERVALS | RE_NO_GNU_OPS)</font> +00191 <font class="preprocessor"></font> +00192 <font class="preprocessor">#define RE_SYNTAX_GREP \</font> +00193 <font class="preprocessor"> (RE_BK_PLUS_QM | RE_CHAR_CLASSES \</font> +00194 <font class="preprocessor"> | RE_HAT_LISTS_NOT_NEWLINE | RE_INTERVALS \</font> +00195 <font class="preprocessor"> | RE_NEWLINE_ALT)</font> +00196 <font class="preprocessor"></font> +00197 <font class="preprocessor">#define RE_SYNTAX_EGREP \</font> +00198 <font class="preprocessor"> (RE_CHAR_CLASSES | RE_CONTEXT_INDEP_ANCHORS \</font> +00199 <font class="preprocessor"> | RE_CONTEXT_INDEP_OPS | RE_HAT_LISTS_NOT_NEWLINE \</font> +00200 <font class="preprocessor"> | RE_NEWLINE_ALT | RE_NO_BK_PARENS \</font> +00201 <font class="preprocessor"> | RE_NO_BK_VBAR)</font> +00202 <font class="preprocessor"></font> +00203 <font class="preprocessor">#define RE_SYNTAX_POSIX_EGREP \</font> +00204 <font class="preprocessor"> (RE_SYNTAX_EGREP | RE_INTERVALS | RE_NO_BK_BRACES)</font> +00205 <font class="preprocessor"></font> +00206 <font class="comment">/* P1003.2/D11.2, section 4.20.7.1, lines 5078ff. */</font> +00207 <font class="preprocessor">#define RE_SYNTAX_ED RE_SYNTAX_POSIX_BASIC</font> +00208 <font class="preprocessor"></font> +00209 <font class="preprocessor">#define RE_SYNTAX_SED RE_SYNTAX_POSIX_BASIC</font> +00210 <font class="preprocessor"></font> +00211 <font class="comment">/* Syntax bits common to both basic and extended POSIX regex syntax. */</font> +00212 <font class="preprocessor">#define _RE_SYNTAX_POSIX_COMMON \</font> +00213 <font class="preprocessor"> (RE_CHAR_CLASSES | RE_DOT_NEWLINE | RE_DOT_NOT_NULL \</font> +00214 <font class="preprocessor"> | RE_INTERVALS | RE_NO_EMPTY_RANGES)</font> +00215 <font class="preprocessor"></font> +00216 <font class="preprocessor">#define RE_SYNTAX_POSIX_BASIC \</font> +00217 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_BK_PLUS_QM)</font> +00218 <font class="preprocessor"></font> +00219 <font class="comment">/* Differs from ..._POSIX_BASIC only in that RE_BK_PLUS_QM becomes</font> +00220 <font class="comment"> RE_LIMITED_OPS, i.e., \? \+ \| are not recognized. Actually, this</font> +00221 <font class="comment"> isn't minimal, since other operators, such as \`, aren't disabled. */</font> +00222 <font class="preprocessor">#define RE_SYNTAX_POSIX_MINIMAL_BASIC \</font> +00223 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_LIMITED_OPS)</font> +00224 <font class="preprocessor"></font> +00225 <font class="preprocessor">#define RE_SYNTAX_POSIX_EXTENDED \</font> +00226 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \</font> +00227 <font class="preprocessor"> | RE_CONTEXT_INDEP_OPS | RE_NO_BK_BRACES \</font> +00228 <font class="preprocessor"> | RE_NO_BK_PARENS | RE_NO_BK_VBAR \</font> +00229 <font class="preprocessor"> | RE_UNMATCHED_RIGHT_PAREN_ORD)</font> +00230 <font class="preprocessor"></font> +00231 <font class="comment">/* Differs from ..._POSIX_EXTENDED in that RE_CONTEXT_INVALID_OPS</font> +00232 <font class="comment"> replaces RE_CONTEXT_INDEP_OPS and RE_NO_BK_REFS is added. */</font> +00233 <font class="preprocessor">#define RE_SYNTAX_POSIX_MINIMAL_EXTENDED \</font> +00234 <font class="preprocessor"> (_RE_SYNTAX_POSIX_COMMON | RE_CONTEXT_INDEP_ANCHORS \</font> +00235 <font class="preprocessor"> | RE_CONTEXT_INVALID_OPS | RE_NO_BK_BRACES \</font> +00236 <font class="preprocessor"> | RE_NO_BK_PARENS | RE_NO_BK_REFS \</font> +00237 <font class="preprocessor"> | RE_NO_BK_VBAR | RE_UNMATCHED_RIGHT_PAREN_ORD)</font> +00238 <font class="preprocessor"></font><font class="comment">/* [[[end syntaxes]]] */</font> +00239 +00240 <font class="comment">/* Maximum number of duplicates an interval can allow. Some systems</font> +00241 <font class="comment"> (erroneously) define this in other header files, but we want our</font> +00242 <font class="comment"> value, so remove any previous define. */</font> +00243 <font class="preprocessor">#ifdef RE_DUP_MAX</font> +00244 <font class="preprocessor"></font><font class="preprocessor">#undef RE_DUP_MAX</font> +00245 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00246 <font class="preprocessor"></font><font class="comment">/* If sizeof(int) == 2, then ((1 << 15) - 1) overflows. */</font> +00247 <font class="preprocessor">#define RE_DUP_MAX (0x7fff)</font> +00248 <font class="preprocessor"></font> +00249 +00250 <font class="comment">/* POSIX `cflags' bits (i.e., information for `regcomp'). */</font> +00251 +00252 <font class="comment">/* If this bit is set, then use extended regular expression syntax.</font> +00253 <font class="comment"> If not set, then use basic regular expression syntax. */</font> +00254 <font class="preprocessor">#define REG_EXTENDED 1</font> +00255 <font class="preprocessor"></font> +00256 <font class="comment">/* If this bit is set, then ignore case when matching.</font> +00257 <font class="comment"> If not set, then case is significant. */</font> +00258 <font class="preprocessor">#define REG_ICASE (REG_EXTENDED << 1)</font> +00259 <font class="preprocessor"></font> +00260 <font class="comment">/* If this bit is set, then anchors do not match at newline</font> +00261 <font class="comment"> characters in the string.</font> +00262 <font class="comment"> If not set, then anchors do match at newlines. */</font> +00263 <font class="preprocessor">#define REG_NEWLINE (REG_ICASE << 1)</font> +00264 <font class="preprocessor"></font> +00265 <font class="comment">/* If this bit is set, then report only success or fail in regexec.</font> +00266 <font class="comment"> If not set, then returns differ between not matching and errors. */</font> +00267 <font class="preprocessor">#define REG_NOSUB (REG_NEWLINE << 1)</font> +00268 <font class="preprocessor"></font> +00269 +00270 <font class="comment">/* POSIX `eflags' bits (i.e., information for regexec). */</font> +00271 +00272 <font class="comment">/* If this bit is set, then the beginning-of-line operator doesn't match</font> +00273 <font class="comment"> the beginning of the string (presumably because it's not the</font> +00274 <font class="comment"> beginning of a line).</font> +00275 <font class="comment"> If not set, then the beginning-of-line operator does match the</font> +00276 <font class="comment"> beginning of the string. */</font> +00277 <font class="preprocessor">#define REG_NOTBOL 1</font> +00278 <font class="preprocessor"></font> +00279 <font class="comment">/* Like REG_NOTBOL, except for the end-of-line. */</font> +00280 <font class="preprocessor">#define REG_NOTEOL (1 << 1)</font> +00281 <font class="preprocessor"></font> +00282 +00283 <font class="comment">/* If any error codes are removed, changed, or added, update the</font> +00284 <font class="comment"> `re_error_msg' table in regex.c. */</font> +00285 <font class="keyword">typedef</font> <font class="keyword">enum</font> +00286 { +00287 REG_NOERROR = 0, <font class="comment">/* Success. */</font> +00288 REG_NOMATCH, <font class="comment">/* Didn't find a match (for regexec). */</font> +00289 +00290 <font class="comment">/* POSIX regcomp return error codes. (In the order listed in the</font> +00291 <font class="comment"> standard.) */</font> +00292 REG_BADPAT, <font class="comment">/* Invalid pattern. */</font> +00293 REG_ECOLLATE, <font class="comment">/* Not implemented. */</font> +00294 REG_ECTYPE, <font class="comment">/* Invalid character class name. */</font> +00295 REG_EESCAPE, <font class="comment">/* Trailing backslash. */</font> +00296 REG_ESUBREG, <font class="comment">/* Invalid back reference. */</font> +00297 REG_EBRACK, <font class="comment">/* Unmatched left bracket. */</font> +00298 REG_EPAREN, <font class="comment">/* Parenthesis imbalance. */</font> +00299 REG_EBRACE, <font class="comment">/* Unmatched \{. */</font> +00300 REG_BADBR, <font class="comment">/* Invalid contents of \{\}. */</font> +00301 REG_ERANGE, <font class="comment">/* Invalid range end. */</font> +00302 REG_ESPACE, <font class="comment">/* Ran out of memory. */</font> +00303 REG_BADRPT, <font class="comment">/* No preceding re for repetition op. */</font> +00304 +00305 <font class="comment">/* Error codes we've added. */</font> +00306 REG_EEND, <font class="comment">/* Premature end. */</font> +00307 REG_ESIZE, <font class="comment">/* Compiled pattern bigger than 2^16 bytes. */</font> +00308 REG_ERPAREN <font class="comment">/* Unmatched ) or \); not returned from regcomp. */</font> +00309 } +00310 reg_errcode_t; +00311 +00312 <font class="comment">/* This data structure represents a compiled pattern. Before calling</font> +00313 <font class="comment"> the pattern compiler, the fields `buffer', `allocated', `fastmap',</font> +00314 <font class="comment"> `translate', and `no_sub' can be set. After the pattern has been</font> +00315 <font class="comment"> compiled, the `re_nsub' field is available. All other fields are</font> +00316 <font class="comment"> private to the regex routines. */</font> +00317 +00318 <font class="preprocessor">#ifndef RE_TRANSLATE_TYPE</font> +00319 <font class="preprocessor"></font><font class="preprocessor">#define RE_TRANSLATE_TYPE char *</font> +00320 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00321 <font class="preprocessor"></font> +00322 <font class="keyword">struct </font>re_pattern_buffer +00323 { +00324 <font class="comment">/* [[[begin pattern_buffer]]] */</font> +00325 <font class="comment">/* Space that holds the compiled pattern. It is declared as</font> +00326 <font class="comment"> `unsigned char *' because its elements are</font> +00327 <font class="comment"> sometimes used as array indexes. */</font> +00328 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *buffer; +00329 +00330 <font class="comment">/* Number of bytes to which `buffer' points. */</font> +00331 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> allocated; +00332 +00333 <font class="comment">/* Number of bytes actually used in `buffer'. */</font> +00334 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> <font class="keywordtype">int</font> used; +00335 +00336 <font class="comment">/* Syntax setting with which the pattern was compiled. */</font> +00337 reg_syntax_t syntax; +00338 +00339 <font class="comment">/* Pointer to a fastmap, if any, otherwise zero. re_search uses</font> +00340 <font class="comment"> the fastmap, if there is one, to skip over impossible</font> +00341 <font class="comment"> starting points for matches. */</font> +00342 <font class="keywordtype">char</font> *fastmap; +00343 +00344 <font class="comment">/* Either a translate table to apply to all characters before</font> +00345 <font class="comment"> comparing them, or zero for no translation. The translation</font> +00346 <font class="comment"> is applied to a pattern when it is compiled and to a string</font> +00347 <font class="comment"> when it is matched. */</font> +00348 RE_TRANSLATE_TYPE translate; +00349 +00350 <font class="comment">/* Number of subexpressions found by the compiler. */</font> +00351 size_t re_nsub; +00352 +00353 <font class="comment">/* Zero if this pattern cannot match the empty string, one else.</font> +00354 <font class="comment"> Well, in truth it's used only in `re_search_2', to see</font> +00355 <font class="comment"> whether or not we should use the fastmap, so we don't set</font> +00356 <font class="comment"> this absolutely perfectly; see `re_compile_fastmap' (the</font> +00357 <font class="comment"> `duplicate' case). */</font> +00358 <font class="keywordtype">unsigned</font> can_be_null:1; +00359 +00360 <font class="comment">/* If REGS_UNALLOCATED, allocate space in the `regs' structure</font> +00361 <font class="comment"> for `max (RE_NREGS, re_nsub + 1)' groups.</font> +00362 <font class="comment"> If REGS_REALLOCATE, reallocate space if necessary.</font> +00363 <font class="comment"> If REGS_FIXED, use what's there. */</font> +00364 <font class="preprocessor">#define REGS_UNALLOCATED 0</font> +00365 <font class="preprocessor"></font><font class="preprocessor">#define REGS_REALLOCATE 1</font> +00366 <font class="preprocessor"></font><font class="preprocessor">#define REGS_FIXED 2</font> +00367 <font class="preprocessor"></font> <font class="keywordtype">unsigned</font> regs_allocated:2; +00368 +00369 <font class="comment">/* Set to zero when `regex_compile' compiles a pattern; set to one</font> +00370 <font class="comment"> by `re_compile_fastmap' if it updates the fastmap. */</font> +00371 <font class="keywordtype">unsigned</font> fastmap_accurate:1; +00372 +00373 <font class="comment">/* If set, `re_match_2' does not return information about</font> +00374 <font class="comment"> subexpressions. */</font> +00375 <font class="keywordtype">unsigned</font> no_sub:1; +00376 +00377 <font class="comment">/* If set, a beginning-of-line anchor doesn't match at the</font> +00378 <font class="comment"> beginning of the string. */</font> +00379 <font class="keywordtype">unsigned</font> not_bol:1; +00380 +00381 <font class="comment">/* Similarly for an end-of-line anchor. */</font> +00382 <font class="keywordtype">unsigned</font> not_eol:1; +00383 +00384 <font class="comment">/* If true, an anchor at a newline matches. */</font> +00385 <font class="keywordtype">unsigned</font> newline_anchor:1; +00386 +00387 <font class="comment">/* [[[end pattern_buffer]]] */</font> +00388 }; +00389 +00390 <font class="keyword">typedef</font> <font class="keyword">struct </font>re_pattern_buffer regex_t; +00391 +00392 <font class="comment">/* Type for byte offsets within the string. POSIX mandates this. */</font> +00393 <font class="keyword">typedef</font> <font class="keywordtype">int</font> regoff_t; +00394 +00395 +00396 <font class="comment">/* This is the structure we store register match data in. See</font> +00397 <font class="comment"> regex.texinfo for a full description of what registers match. */</font> +00398 <font class="keyword">struct </font>re_registers +00399 { +00400 <font class="keywordtype">unsigned</font> num_regs; +00401 regoff_t *start; +00402 regoff_t *end; +00403 }; +00404 +00405 +00406 <font class="comment">/* If `regs_allocated' is REGS_UNALLOCATED in the pattern buffer,</font> +00407 <font class="comment"> `re_match_2' returns information about at least this many registers</font> +00408 <font class="comment"> the first time a `regs' structure is passed. */</font> +00409 <font class="preprocessor">#ifndef RE_NREGS</font> +00410 <font class="preprocessor"></font><font class="preprocessor">#define RE_NREGS 30</font> +00411 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00412 <font class="preprocessor"></font> +00413 +00414 <font class="comment">/* POSIX specification for registers. Aside from the different names than</font> +00415 <font class="comment"> `re_registers', POSIX uses an array of structures, instead of a</font> +00416 <font class="comment"> structure of arrays. */</font> +00417 <font class="keyword">typedef</font> <font class="keyword">struct</font> +00418 <font class="keyword"> </font>{ +00419 regoff_t rm_so; <font class="comment">/* Byte offset from string's start to substring's start. */</font> +00420 regoff_t rm_eo; <font class="comment">/* Byte offset from string's start to substring's end. */</font> +00421 } +00422 regmatch_t; +00423 +00424 <font class="comment">/* Declarations for routines. */</font> +00425 +00426 <font class="comment">/* To avoid duplicating every routine declaration -- once with a</font> +00427 <font class="comment"> prototype (if we are ANSI), and once without (if we aren't) -- we</font> +00428 <font class="comment"> use the following macro to declare argument types. This</font> +00429 <font class="comment"> unfortunately clutters up the declarations a bit, but I think it's</font> +00430 <font class="comment"> worth it. */</font> +00431 <font class="preprocessor">#ifndef __STDC__</font> +00432 <font class="preprocessor"></font><font class="preprocessor">#define __STDC__ 1</font> +00433 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00434 <font class="preprocessor"></font><font class="preprocessor">#if __STDC__</font> +00435 <font class="preprocessor"></font> +00436 <font class="preprocessor">#define _RE_ARGS(args) args</font> +00437 <font class="preprocessor"></font> +00438 <font class="preprocessor">#else </font><font class="comment">/* not __STDC__ */</font> +00439 +00440 <font class="preprocessor">#define _RE_ARGS(args) ()</font> +00441 <font class="preprocessor"></font> +00442 <font class="preprocessor">#endif </font><font class="comment">/* not __STDC__ */</font> +00443 +00444 <font class="comment">/* Sets the current default syntax to SYNTAX, and return the old syntax.</font> +00445 <font class="comment"> You can also simply assign to the `re_syntax_options' variable. */</font> +00446 <font class="keyword">extern</font> reg_syntax_t re_set_syntax _RE_ARGS ((reg_syntax_t syntax)); +00447 +00448 <font class="comment">/* Compile the regular expression PATTERN, with length LENGTH</font> +00449 <font class="comment"> and syntax given by the global `re_syntax_options', into the buffer</font> +00450 <font class="comment"> BUFFER. Return NULL if successful, and an error string if not. */</font> +00451 <font class="keyword">extern</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *re_compile_pattern +00452 _RE_ARGS ((<font class="keyword">const</font> <font class="keywordtype">char</font> *pattern, size_t length, +00453 <font class="keyword">struct</font> re_pattern_buffer * buffer)); +00454 +00455 +00456 <font class="comment">/* Compile a fastmap for the compiled pattern in BUFFER; used to</font> +00457 <font class="comment"> accelerate searches. Return 0 if successful and -2 if was an</font> +00458 <font class="comment"> internal error. */</font> +00459 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_compile_fastmap +00460 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer)); +00461 +00462 +00463 <font class="comment">/* Search in the string STRING (with length LENGTH) for the pattern</font> +00464 <font class="comment"> compiled into BUFFER. Start searching at position START, for RANGE</font> +00465 <font class="comment"> characters. Return the starting position of the match, -1 for no</font> +00466 <font class="comment"> match, or -2 for an internal error. Also return register</font> +00467 <font class="comment"> information in REGS (if REGS and BUFFER->no_sub are nonzero). */</font> +00468 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_search +00469 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string, +00470 <font class="keywordtype">int</font> length, <font class="keywordtype">int</font> start, <font class="keywordtype">int</font> range, <font class="keyword">struct</font> re_registers * regs)); +00471 +00472 +00473 <font class="comment">/* Like `re_search', but search in the concatenation of STRING1 and</font> +00474 <font class="comment"> STRING2. Also, stop searching at index START + STOP. */</font> +00475 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_search_2 +00476 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string1, +00477 <font class="keywordtype">int</font> length1, <font class="keyword">const</font> <font class="keywordtype">char</font> *string2, <font class="keywordtype">int</font> length2, +00478 <font class="keywordtype">int</font> start, <font class="keywordtype">int</font> range, <font class="keyword">struct</font> re_registers * regs, <font class="keywordtype">int</font> stop)); +00479 +00480 +00481 <font class="comment">/* Like `re_search', but return how many characters in STRING the regexp</font> +00482 <font class="comment"> in BUFFER matched, starting at position START. */</font> +00483 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_match +00484 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string, +00485 <font class="keywordtype">int</font> length, <font class="keywordtype">int</font> start, <font class="keyword">struct</font> re_registers * regs)); +00486 +00487 +00488 <font class="comment">/* Relates to `re_match' as `re_search_2' relates to `re_search'. */</font> +00489 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_match_2 +00490 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">const</font> <font class="keywordtype">char</font> *string1, +00491 <font class="keywordtype">int</font> length1, <font class="keyword">const</font> <font class="keywordtype">char</font> *string2, <font class="keywordtype">int</font> length2, +00492 <font class="keywordtype">int</font> start, <font class="keyword">struct</font> re_registers * regs, <font class="keywordtype">int</font> stop)); +00493 +00494 +00495 <font class="comment">/* Set REGS to hold NUM_REGS registers, storing them in STARTS and</font> +00496 <font class="comment"> ENDS. Subsequent matches using BUFFER and REGS will use this memory</font> +00497 <font class="comment"> for recording register information. STARTS and ENDS must be</font> +00498 <font class="comment"> allocated with malloc, and must each be at least `NUM_REGS * sizeof</font> +00499 <font class="comment"> (regoff_t)' bytes long.</font> +00500 <font class="comment"></font> +00501 <font class="comment"> If NUM_REGS == 0, then subsequent matches should allocate their own</font> +00502 <font class="comment"> register data.</font> +00503 <font class="comment"></font> +00504 <font class="comment"> Unless this function is called, the first search or match using</font> +00505 <font class="comment"> PATTERN_BUFFER will allocate its own register data, without</font> +00506 <font class="comment"> freeing the old data. */</font> +00507 <font class="keyword">extern</font> <font class="keywordtype">void</font> re_set_registers +00508 _RE_ARGS ((<font class="keyword">struct</font> re_pattern_buffer * buffer, <font class="keyword">struct</font> re_registers * regs, +00509 <font class="keywordtype">unsigned</font> num_regs, regoff_t * starts, regoff_t * ends)); +00510 +00511 <font class="preprocessor">#ifdef _REGEX_RE_COMP</font> +00512 <font class="preprocessor"></font><font class="preprocessor">#ifndef _CRAY</font> +00513 <font class="preprocessor"></font><font class="comment">/* 4.2 bsd compatibility. */</font> +00514 <font class="keyword">extern</font> <font class="keywordtype">char</font> *re_comp _RE_ARGS ((<font class="keyword">const</font> <font class="keywordtype">char</font> *)); +00515 <font class="keyword">extern</font> <font class="keywordtype">int</font> re_exec _RE_ARGS ((<font class="keyword">const</font> <font class="keywordtype">char</font> *)); +00516 <font class="preprocessor">#endif</font> +00517 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00518 <font class="preprocessor"></font> +00519 <font class="comment">/* POSIX compatibility. */</font> +00520 <font class="keyword">extern</font> <font class="keywordtype">int</font> regcomp +00521 _RE_ARGS ((regex_t * preg, <font class="keyword">const</font> <font class="keywordtype">char</font> *pattern, <font class="keywordtype">int</font> cflags)); +00522 <font class="keyword">extern</font> <font class="keywordtype">int</font> regexec +00523 _RE_ARGS ( +00524 (<font class="keyword">const</font> regex_t * preg, <font class="keyword">const</font> <font class="keywordtype">char</font> *string, size_t nmatch, +00525 regmatch_t pmatch[], <font class="keywordtype">int</font> eflags)); +00526 <font class="keyword">extern</font> size_t regerror +00527 _RE_ARGS ( +00528 (<font class="keywordtype">int</font> errcode, <font class="keyword">const</font> regex_t * preg, <font class="keywordtype">char</font> *errbuf, +00529 size_t errbuf_size)); +00530 <font class="keyword">extern</font> <font class="keywordtype">void</font> regfree _RE_ARGS ((regex_t * preg)); +00531 +00532 +00533 <font class="preprocessor">#ifdef __cplusplus</font> +00534 <font class="preprocessor"></font>} +00535 <font class="preprocessor">#endif </font><font class="comment">/* C++ */</font> +00536 +00537 <font class="preprocessor">#endif </font><font class="comment">/* regex.h */</font> +00538 +00539 <font class="comment">/*</font> +00540 <font class="comment">Local variables:</font> +00541 <font class="comment">make-backup-files: t</font> +00542 <font class="comment">version-control: t</font> +00543 <font class="comment">trim-versions-without-asking: nil</font> +00544 <font class="comment">End:</font> +00545 <font class="comment">*/</font> +</pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/roman.h-source.html b/doc/api-documentation/html/roman.h-source.html new file mode 100644 index 0000000..c20c3c5 --- /dev/null +++ b/doc/api-documentation/html/roman.h-source.html @@ -0,0 +1,40 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>roman.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>roman.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * roman.h - roman numeral functions +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00005 <font class="comment"> * CrossWire Bible Society +</font>00006 <font class="comment"> * P. O. Box 2528 +</font>00007 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00008 <font class="comment"> * +</font>00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00010 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00011 <font class="comment"> * Free Software Foundation version 2. +</font>00012 <font class="comment"> * +</font>00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00016 <font class="comment"> * General Public License for more details. +</font>00017 <font class="comment"> * +</font>00018 <font class="comment"> */</font> +00019 <font class="preprocessor">#ifndef ROMAN_H +</font>00020 <font class="preprocessor"></font><font class="preprocessor">#define ROMAN_H +</font>00021 <font class="preprocessor"></font> +00022 <font class="keywordtype">char</font>* to_rom(<font class="keywordtype">int</font> num, <font class="keywordtype">char</font> *p); +00023 <font class="keywordtype">int</font> from_rom(<font class="keywordtype">char</font> *s); +00024 +00025 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/roman_8h-source.html b/doc/api-documentation/html/roman_8h-source.html new file mode 100644 index 0000000..25d28fe --- /dev/null +++ b/doc/api-documentation/html/roman_8h-source.html @@ -0,0 +1,40 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>roman.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>roman.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * roman.h - roman numeral functions</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 <font class="preprocessor">#ifndef ROMAN_H</font> +00020 <font class="preprocessor"></font><font class="preprocessor">#define ROMAN_H</font> +00021 <font class="preprocessor"></font><font class="keywordtype">char</font> isroman(<font class="keyword">const</font> <font class="keywordtype">char</font> *); +00022 <font class="comment">/* char* to_rom(int num, char *p); */</font> +00023 <font class="keywordtype">int</font> from_rom(<font class="keyword">const</font> <font class="keywordtype">char</font> *s); +00024 +00025 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/roman_h-source.html b/doc/api-documentation/html/roman_h-source.html new file mode 100644 index 0000000..168b7c1 --- /dev/null +++ b/doc/api-documentation/html/roman_h-source.html @@ -0,0 +1,41 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>roman.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>roman.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * roman.h - roman numeral functions</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 <font class="preprocessor">#ifndef ROMAN_H</font> +00020 <font class="preprocessor"></font><font class="preprocessor">#define ROMAN_H</font> +00021 <font class="preprocessor"></font><font class="keywordtype">char</font> isroman(<font class="keyword">const</font> <font class="keywordtype">char</font> *); +00022 <font class="comment">//char* to_rom(int num, char *p);</font> +00023 <font class="keywordtype">int</font> from_rom(<font class="keyword">const</font> <font class="keywordtype">char</font> *s); +00024 +00025 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rtfhtml.h-source.html b/doc/api-documentation/html/rtfhtml.h-source.html new file mode 100644 index 0000000..bdeb534 --- /dev/null +++ b/doc/api-documentation/html/rtfhtml.h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rtfhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rtfhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/*************************************************************************** +</font>00002 <font class="comment"> rtfhtml.h - description +</font>00003 <font class="comment"> ------------------- +</font>00004 <font class="comment"> begin : Wed Oct 13 1999 +</font>00005 <font class="comment"> copyright : (C) 1999 by The team of BibleTime +</font>00006 <font class="comment"> email : info@bibletime.de +</font>00007 <font class="comment"> ***************************************************************************/</font> +00008 +00009 <font class="comment">/*************************************************************************** +</font>00010 <font class="comment"> * * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify * +</font>00012 <font class="comment"> * it under the terms of the GNU General Public License as published by * +</font>00013 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or * +</font>00014 <font class="comment"> * (at your option) any later version. * +</font>00015 <font class="comment"> * * +</font>00016 <font class="comment"> ***************************************************************************/</font> +00017 +00018 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/rtfhtml.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ */</font> +00019 <font class="comment">/* $Revision: 1.10 $ */</font> +00020 +00021 <font class="preprocessor">#ifndef RTFHTML_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define RTFHTML_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_rtfhtml.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_rtfhtml.html">RTFHTML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 RTFHTML (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00035 }; +00036 +00037 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rtfhtml_8h-source.html b/doc/api-documentation/html/rtfhtml_8h-source.html new file mode 100644 index 0000000..41ed666 --- /dev/null +++ b/doc/api-documentation/html/rtfhtml_8h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rtfhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rtfhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> rtfhtml.h - description </font> +00003 <font class="comment"> ------------------- </font> +00004 <font class="comment"> begin : Wed Oct 13 1999 </font> +00005 <font class="comment"> copyright : (C) 1999 by The team of BibleTime </font> +00006 <font class="comment"> email : info@bibletime.de </font> +00007 <font class="comment"> ***************************************************************************/</font> +00008 +00009 <font class="comment">/***************************************************************************</font> +00010 <font class="comment"> * *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00012 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00013 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00014 <font class="comment"> * (at your option) any later version. * </font> +00015 <font class="comment"> * *</font> +00016 <font class="comment"> ***************************************************************************/</font> +00017 +00018 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/rtfhtml_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $ */</font> +00019 <font class="comment">/* $Revision: 1.4 $ */</font> +00020 +00021 <font class="preprocessor">#ifndef RTFHTML_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define RTFHTML_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_r_t_f_h_t_m_l.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_r_t_f_h_t_m_l.html">RTFHTML</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keyword">public</font>: +00033 RTFHTML (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rtfhtml_h-source.html b/doc/api-documentation/html/rtfhtml_h-source.html new file mode 100644 index 0000000..7b6a111 --- /dev/null +++ b/doc/api-documentation/html/rtfhtml_h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rtfhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rtfhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> rtfhtml.h - description </font> +00003 <font class="comment"> ------------------- </font> +00004 <font class="comment"> begin : Wed Oct 13 1999 </font> +00005 <font class="comment"> copyright : (C) 1999 by The team of BibleTime </font> +00006 <font class="comment"> email : info@bibletime.de </font> +00007 <font class="comment"> ***************************************************************************/</font> +00008 +00009 <font class="comment">/***************************************************************************</font> +00010 <font class="comment"> * *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00012 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00013 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00014 <font class="comment"> * (at your option) any later version. * </font> +00015 <font class="comment"> * *</font> +00016 <font class="comment"> ***************************************************************************/</font> +00017 +00018 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/rtfhtml_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $ */</font> +00019 <font class="comment">/* $Revision: 1.4 $ */</font> +00020 +00021 <font class="preprocessor">#ifndef RTFHTML_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define RTFHTML_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_rtfhtml.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_rtfhtml.html">RTFHTML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 RTFHTML (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rwphtml.h-source.html b/doc/api-documentation/html/rwphtml.h-source.html new file mode 100644 index 0000000..ea9d001 --- /dev/null +++ b/doc/api-documentation/html/rwphtml.h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rwphtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rwphtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/*************************************************************************** +</font>00002 <font class="comment"> rwphtml.h - description +</font>00003 <font class="comment"> ------------------- +</font>00004 <font class="comment"> begin : Tue Jun 15 15:34:26 CEST 1999 +</font>00005 <font class="comment"> +</font>00006 <font class="comment"> copyright : (C) 1999 by Torsten Uhlmann +</font>00007 <font class="comment"> email : TUhlmann@gmx.de +</font>00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/*************************************************************************** +</font>00011 <font class="comment"> * * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify * +</font>00013 <font class="comment"> * it under the terms of the GNU General Public License as published by * +</font>00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or * +</font>00015 <font class="comment"> * (at your option) any later version. * +</font>00016 <font class="comment"> * * +</font>00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/rwphtml.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ */</font> +00020 <font class="comment">/* $Revision: 1.10 $ */</font> +00021 +00022 <font class="preprocessor">#ifndef RWPHTML_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define RWPHTML_H +</font>00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swfilter.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +<a name="l00031"></a><a class="code" href="class_rwphtml.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_rwphtml.html">RWPHTML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00032 { +00033 <font class="keyword">public</font>: +00034 RWPHTML (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00036 }; +00037 +00038 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rwphtml_8h-source.html b/doc/api-documentation/html/rwphtml_8h-source.html new file mode 100644 index 0000000..b46d6c4 --- /dev/null +++ b/doc/api-documentation/html/rwphtml_8h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rwphtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rwphtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> rwphtml.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : Tue Jun 15 15:34:26 CEST 1999</font> +00005 <font class="comment"></font> +00006 <font class="comment"> copyright : (C) 1999 by Torsten Uhlmann</font> +00007 <font class="comment"> email : TUhlmann@gmx.de</font> +00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/***************************************************************************</font> +00011 <font class="comment"> * *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00013 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00015 <font class="comment"> * (at your option) any later version. *</font> +00016 <font class="comment"> * *</font> +00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/rwphtml_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $ */</font> +00020 <font class="comment">/* $Revision: 1.4 $ */</font> +00021 +00022 <font class="preprocessor">#ifndef RWPHTML_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define RWPHTML_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swfilter.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +<a name="l00031"></a><a class="code" href="class_r_w_p_h_t_m_l.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_r_w_p_h_t_m_l.html">RWPHTML</a>:<font class="keyword">public</font> SWFilter +00032 { +00033 <font class="keyword">public</font>: +00034 RWPHTML (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00036 }; +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rwphtml_h-source.html b/doc/api-documentation/html/rwphtml_h-source.html new file mode 100644 index 0000000..45673ef --- /dev/null +++ b/doc/api-documentation/html/rwphtml_h-source.html @@ -0,0 +1,52 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rwphtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rwphtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> rwphtml.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : Tue Jun 15 15:34:26 CEST 1999</font> +00005 <font class="comment"></font> +00006 <font class="comment"> copyright : (C) 1999 by Torsten Uhlmann</font> +00007 <font class="comment"> email : TUhlmann@gmx.de</font> +00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/***************************************************************************</font> +00011 <font class="comment"> * *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00013 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00015 <font class="comment"> * (at your option) any later version. *</font> +00016 <font class="comment"> * *</font> +00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="comment">/* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/rwphtml_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $ */</font> +00020 <font class="comment">/* $Revision: 1.4 $ */</font> +00021 +00022 <font class="preprocessor">#ifndef RWPHTML_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define RWPHTML_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swfilter.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +<a name="l00031"></a><a class="code" href="class_rwphtml.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_rwphtml.html">RWPHTML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00032 { +00033 <font class="keyword">public</font>: +00034 RWPHTML (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00036 }; +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rwprtf.h-source.html b/doc/api-documentation/html/rwprtf.h-source.html new file mode 100644 index 0000000..5e3986b --- /dev/null +++ b/doc/api-documentation/html/rwprtf.h-source.html @@ -0,0 +1,53 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>rwprtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rwprtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * rwprtf.h - definition of Class RWPRTF, an SWFilter used to convert +</font>00003 <font class="comment"> * special tags in Robertsons Word Pictures commentary into +</font>00004 <font class="comment"> * Rich Text Format tags +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * $Id: rwprtf.h-source.html,v 1.10 2001/05/25 10:44:21 jansorg Exp $ +</font>00007 <font class="comment"> * +</font>00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00009 <font class="comment"> * CrossWire Bible Society +</font>00010 <font class="comment"> * P. O. Box 2528 +</font>00011 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00012 <font class="comment"> * +</font>00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00014 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00015 <font class="comment"> * Free Software Foundation version 2. +</font>00016 <font class="comment"> * +</font>00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00020 <font class="comment"> * General Public License for more details. +</font>00021 <font class="comment"> * +</font>00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef RWPRTF_H +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#define RWPRTF_H +</font>00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <swfilter.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00033"></a><a class="code" href="class_rwprtf.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_rwprtf.html">RWPRTF</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00034 { +00035 <font class="keyword">public</font>: +00036 RWPRTF (); +00037 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00038 }; +00039 +00040 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rwprtf_8h-source.html b/doc/api-documentation/html/rwprtf_8h-source.html new file mode 100644 index 0000000..3096ef7 --- /dev/null +++ b/doc/api-documentation/html/rwprtf_8h-source.html @@ -0,0 +1,53 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rwprtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rwprtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rwprtf.h - definition of Class RWPRTF, an SWFilter used to convert</font> +00003 <font class="comment"> * special tags in Robertsons Word Pictures commentary into</font> +00004 <font class="comment"> * Rich Text Format tags</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: rwprtf_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef RWPRTF_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define RWPRTF_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <swfilter.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00033"></a><a class="code" href="class_r_w_p_r_t_f.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_r_w_p_r_t_f.html">RWPRTF</a>:<font class="keyword">public</font> SWFilter +00034 { +00035 <font class="keyword">public</font>: +00036 RWPRTF (); +00037 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00038 }; +00039 +00040 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/rwprtf_h-source.html b/doc/api-documentation/html/rwprtf_h-source.html new file mode 100644 index 0000000..9efdc31 --- /dev/null +++ b/doc/api-documentation/html/rwprtf_h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>rwprtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>rwprtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rwprtf.h - definition of Class RWPRTF, an SWFilter used to convert</font> +00003 <font class="comment"> * special tags in Robertsons Word Pictures commentary into</font> +00004 <font class="comment"> * Rich Text Format tags</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: rwprtf_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef RWPRTF_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define RWPRTF_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <swfilter.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00033"></a><a class="code" href="class_rwprtf.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_rwprtf.html">RWPRTF</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00034 { +00035 <font class="keyword">public</font>: +00036 RWPRTF (); +00037 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00038 }; +00039 +00040 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/sapphire.h-source.html b/doc/api-documentation/html/sapphire.h-source.html new file mode 100644 index 0000000..7c89094 --- /dev/null +++ b/doc/api-documentation/html/sapphire.h-source.html @@ -0,0 +1,68 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>sapphire.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>sapphire.h</h1><div class="fragment"><pre>00001 <font class="comment">/* sapphire.h -- Interface for the Saphire II stream cipher. +</font>00002 <font class="comment"> +</font>00003 <font class="comment"> Dedicated to the Public Domain the author and inventor +</font>00004 <font class="comment"> (Michael Paul Johnson). This code comes with no warranty. +</font>00005 <font class="comment"> Use it at your own risk. +</font>00006 <font class="comment"> Ported from the Pascal implementation of the Sapphire Stream +</font>00007 <font class="comment"> Cipher 9 December 1994. +</font>00008 <font class="comment"> Added hash-specific functions 27 December 1994. +</font>00009 <font class="comment"> Made index variable initialization key-dependent, +</font>00010 <font class="comment"> made the output function more resistant to cryptanalysis, +</font>00011 <font class="comment"> and renamed to Sapphire II Stream Cipher 2 January 1995. +</font>00012 <font class="comment"> +</font>00013 <font class="comment"> unsigned char is assumed to be 8 bits. If it is not, the +</font>00014 <font class="comment"> results of assignments need to be reduced to 8 bits with +</font>00015 <font class="comment"> & 0xFF or % 0x100, whichever is faster. +</font>00016 <font class="comment">*/</font> +00017 +00018 <font class="preprocessor">#ifndef NULL +</font>00019 <font class="preprocessor"></font><font class="preprocessor">#define NULL 0 +</font>00020 <font class="preprocessor"></font><font class="preprocessor">#endif </font><font class="comment">/* */</font> +00021 <font class="keyword">class </font>sapphire +00022 { +00023 +00024 <font class="comment">// These variables comprise the state of the state machine.</font> +00025 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> cards[256]; <font class="comment">// A permutation of 0-255.</font> +00026 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> rotor, <font class="comment">// Index that rotates smoothly</font> +00027 ratchet, <font class="comment">// Index that moves erratically</font> +00028 avalanche, <font class="comment">// Index heavily data dependent</font> +00029 last_plain, <font class="comment">// Last plain text byte</font> +00030 last_cipher; <font class="comment">// Last cipher text byte</font> +00031 +00032 <font class="comment">// This function is used by initialize(), which is called by the</font> +00033 <font class="comment">// constructor.</font> +00034 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keyrand (<font class="keywordtype">int</font> limit, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *user_key, +00035 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keysize, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *rsum, +00036 <font class="keywordtype">unsigned</font> *keypos); <font class="keyword">public</font>:sapphire (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> +00037 *key = NULL, <font class="comment">// Calls initialize if a real</font> +00038 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keysize = 0); <font class="comment">// key is provided. If none</font> +00039 <font class="comment">// is provided, call initialize</font> +00040 <font class="comment">// before encrypt or decrypt.</font> +00041 ~sapphire (); <font class="comment">// Destroy cipher state information.</font> +00042 <font class="keywordtype">void</font> initialize (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *key, <font class="comment">// User key is used to set</font> +00043 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keysize); <font class="comment">// up state information.</font> +00044 <font class="keywordtype">void</font> hash_init (<font class="keywordtype">void</font>); <font class="comment">// Set up default hash.</font> +00045 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> encrypt (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> b = 0); <font class="comment">// Encrypt byte</font> +00046 <font class="comment">// or get a random byte.</font> +00047 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> decrypt (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> b); <font class="comment">// Decrypt byte.</font> +00048 <font class="keywordtype">void</font> hash_final (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *hash, <font class="comment">// Copy hash value to hash</font> +00049 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> hashlength = 20); <font class="comment">// Hash length (16-32)</font> +00050 <font class="keywordtype">void</font> burn (<font class="keywordtype">void</font>); <font class="comment">// Destroy cipher state information.</font> +00051 }; +00052 +00053 +</div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/sapphire_8h-source.html b/doc/api-documentation/html/sapphire_8h-source.html new file mode 100644 index 0000000..8efd98d --- /dev/null +++ b/doc/api-documentation/html/sapphire_8h-source.html @@ -0,0 +1,68 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>sapphire.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>sapphire.h</h1><div class="fragment"><pre>00001 <font class="comment">/* sapphire.h -- Interface for the Saphire II stream cipher.</font> +00002 <font class="comment"></font> +00003 <font class="comment"> Dedicated to the Public Domain the author and inventor</font> +00004 <font class="comment"> (Michael Paul Johnson). This code comes with no warranty.</font> +00005 <font class="comment"> Use it at your own risk.</font> +00006 <font class="comment"> Ported from the Pascal implementation of the Sapphire Stream</font> +00007 <font class="comment"> Cipher 9 December 1994.</font> +00008 <font class="comment"> Added hash-specific functions 27 December 1994.</font> +00009 <font class="comment"> Made index variable initialization key-dependent,</font> +00010 <font class="comment"> made the output function more resistant to cryptanalysis,</font> +00011 <font class="comment"> and renamed to Sapphire II Stream Cipher 2 January 1995.</font> +00012 <font class="comment"></font> +00013 <font class="comment"> unsigned char is assumed to be 8 bits. If it is not, the</font> +00014 <font class="comment"> results of assignments need to be reduced to 8 bits with</font> +00015 <font class="comment"> & 0xFF or % 0x100, whichever is faster.</font> +00016 <font class="comment">*/</font> +00017 +00018 <font class="preprocessor">#ifndef NULL</font> +00019 <font class="preprocessor"></font><font class="preprocessor">#define NULL 0</font> +00020 <font class="preprocessor"></font><font class="preprocessor">#endif </font><font class="comment">/* */</font> +00021 <font class="keyword">class </font>sapphire +00022 { +00023 +00024 <font class="comment">// These variables comprise the state of the state machine.</font> +00025 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> cards[256]; <font class="comment">// A permutation of 0-255.</font> +00026 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> rotor, <font class="comment">// Index that rotates smoothly</font> +00027 ratchet, <font class="comment">// Index that moves erratically</font> +00028 avalanche, <font class="comment">// Index heavily data dependent</font> +00029 last_plain, <font class="comment">// Last plain text byte</font> +00030 last_cipher; <font class="comment">// Last cipher text byte</font> +00031 +00032 <font class="comment">// This function is used by initialize(), which is called by the</font> +00033 <font class="comment">// constructor.</font> +00034 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keyrand (<font class="keywordtype">int</font> limit, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *user_key, +00035 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keysize, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *rsum, +00036 <font class="keywordtype">unsigned</font> *keypos); <font class="keyword">public</font>:sapphire (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> +00037 *key = NULL, <font class="comment">// Calls initialize if a real</font> +00038 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keysize = 0); <font class="comment">// key is provided. If none</font> +00039 <font class="comment">// is provided, call initialize</font> +00040 <font class="comment">// before encrypt or decrypt.</font> +00041 ~sapphire (); <font class="comment">// Destroy cipher state information.</font> +00042 <font class="keywordtype">void</font> initialize (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *key, <font class="comment">// User key is used to set</font> +00043 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keysize); <font class="comment">// up state information.</font> +00044 <font class="keywordtype">void</font> hash_init (<font class="keywordtype">void</font>); <font class="comment">// Set up default hash.</font> +00045 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> encrypt (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> b = 0); <font class="comment">// Encrypt byte</font> +00046 <font class="comment">// or get a random byte.</font> +00047 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> decrypt (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> b); <font class="comment">// Decrypt byte.</font> +00048 <font class="keywordtype">void</font> hash_final (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *hash, <font class="comment">// Copy hash value to hash</font> +00049 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> hashlength = 20); <font class="comment">// Hash length (16-32)</font> +00050 <font class="keywordtype">void</font> burn (<font class="keywordtype">void</font>); <font class="comment">// Destroy cipher state information.</font> +00051 }; +00052 +00053 +</pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/sapphire_h-source.html b/doc/api-documentation/html/sapphire_h-source.html new file mode 100644 index 0000000..2e84a43 --- /dev/null +++ b/doc/api-documentation/html/sapphire_h-source.html @@ -0,0 +1,69 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>sapphire.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>sapphire.h</h1><div class="fragment"><pre>00001 <font class="comment">/* sapphire.h -- Interface for the Saphire II stream cipher.</font> +00002 <font class="comment"></font> +00003 <font class="comment"> Dedicated to the Public Domain the author and inventor</font> +00004 <font class="comment"> (Michael Paul Johnson). This code comes with no warranty.</font> +00005 <font class="comment"> Use it at your own risk.</font> +00006 <font class="comment"> Ported from the Pascal implementation of the Sapphire Stream</font> +00007 <font class="comment"> Cipher 9 December 1994.</font> +00008 <font class="comment"> Added hash-specific functions 27 December 1994.</font> +00009 <font class="comment"> Made index variable initialization key-dependent,</font> +00010 <font class="comment"> made the output function more resistant to cryptanalysis,</font> +00011 <font class="comment"> and renamed to Sapphire II Stream Cipher 2 January 1995.</font> +00012 <font class="comment"></font> +00013 <font class="comment"> unsigned char is assumed to be 8 bits. If it is not, the</font> +00014 <font class="comment"> results of assignments need to be reduced to 8 bits with</font> +00015 <font class="comment"> & 0xFF or % 0x100, whichever is faster.</font> +00016 <font class="comment">*/</font> +00017 +00018 <font class="preprocessor">#ifndef NULL</font> +00019 <font class="preprocessor"></font><font class="preprocessor">#define NULL 0</font> +00020 <font class="preprocessor"></font><font class="preprocessor">#endif </font><font class="comment">/* */</font> +00021 <font class="keyword">class </font>sapphire +00022 { +00023 +00024 <font class="comment">// These variables comprise the state of the state machine.</font> +00025 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> cards[256]; <font class="comment">// A permutation of 0-255.</font> +00026 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> rotor, <font class="comment">// Index that rotates smoothly</font> +00027 ratchet, <font class="comment">// Index that moves erratically</font> +00028 avalanche, <font class="comment">// Index heavily data dependent</font> +00029 last_plain, <font class="comment">// Last plain text byte</font> +00030 last_cipher; <font class="comment">// Last cipher text byte</font> +00031 +00032 <font class="comment">// This function is used by initialize(), which is called by the</font> +00033 <font class="comment">// constructor.</font> +00034 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keyrand (<font class="keywordtype">int</font> limit, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *user_key, +00035 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keysize, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *rsum, +00036 <font class="keywordtype">unsigned</font> *keypos); <font class="keyword">public</font>:sapphire (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> +00037 *key = NULL, <font class="comment">// Calls initialize if a real</font> +00038 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keysize = 0); <font class="comment">// key is provided. If none</font> +00039 <font class="comment">// is provided, call initialize</font> +00040 <font class="comment">// before encrypt or decrypt.</font> +00041 ~sapphire (); <font class="comment">// Destroy cipher state information.</font> +00042 <font class="keywordtype">void</font> initialize (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *key, <font class="comment">// User key is used to set</font> +00043 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> keysize); <font class="comment">// up state information.</font> +00044 <font class="keywordtype">void</font> hash_init (<font class="keywordtype">void</font>); <font class="comment">// Set up default hash.</font> +00045 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> encrypt (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> b = 0); <font class="comment">// Encrypt byte</font> +00046 <font class="comment">// or get a random byte.</font> +00047 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> decrypt (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> b); <font class="comment">// Decrypt byte.</font> +00048 <font class="keywordtype">void</font> hash_final (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *hash, <font class="comment">// Copy hash value to hash</font> +00049 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> hashlength = 20); <font class="comment">// Hash length (16-32)</font> +00050 <font class="keywordtype">void</font> burn (<font class="keywordtype">void</font>); <font class="comment">// Destroy cipher state information.</font> +00051 }; +00052 +00053 +</pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/scsuutf8_8h-source.html b/doc/api-documentation/html/scsuutf8_8h-source.html new file mode 100644 index 0000000..9fba26f --- /dev/null +++ b/doc/api-documentation/html/scsuutf8_8h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>scsuutf8.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>scsuutf8.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef SCSUUTF8_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define SCSUUTF8_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_s_c_s_u_u_t_f8.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_c_s_u_u_t_f8.html">SCSUUTF8</a>:<font class="keyword">public</font> SWFilter { +00030 <font class="keyword">private</font>: +00031 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font>* UTF8Output(<font class="keywordtype">unsigned</font> <font class="keywordtype">long</font>, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font>* text); +00032 +00033 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> c, d; +00034 +00035 +00036 <font class="keyword">public</font>: +00037 SCSUUTF8(); +00038 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00039 }; +00040 +00041 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/scsuutf8_h-source.html b/doc/api-documentation/html/scsuutf8_h-source.html new file mode 100644 index 0000000..90cdf4f --- /dev/null +++ b/doc/api-documentation/html/scsuutf8_h-source.html @@ -0,0 +1,55 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>scsuutf8.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>scsuutf8.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef SCSUUTF8_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define SCSUUTF8_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_scsuutf8.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_scsuutf8.html">SCSUUTF8</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> { +00030 <font class="keyword">private</font>: +00031 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font>* UTF8Output(<font class="keywordtype">unsigned</font> <font class="keywordtype">long</font>, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font>* text); +00032 +00033 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> c, d; +00034 +00035 +00036 <font class="keyword">public</font>: +00037 SCSUUTF8(); +00038 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *key); +00039 }; +00040 +00041 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/strkey.h-source.html b/doc/api-documentation/html/strkey.h-source.html new file mode 100644 index 0000000..896f0f3 --- /dev/null +++ b/doc/api-documentation/html/strkey.h-source.html @@ -0,0 +1,56 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>strkey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>strkey.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * strkey.h - code for class 'strkey'- a standard Biblical verse key +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: strkey.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 +00023 <font class="preprocessor">#ifndef STRKEY_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define STRKEY_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swkey.h></font> +00027 <font class="preprocessor">#include <swmacs.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00035"></a><a class="code" href="class_strkey.html">00035</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_strkey.html">StrKey</a>:<font class="keyword">public</font> <a class="code" href="class_swkey.html">SWKey</a> +00036 { +00037 <font class="keyword">static</font> SWClass classdef; +00038 <font class="keywordtype">void</font> init (); +00039 <font class="keyword">public</font>: +00044 <a class="code" href="class_strkey.html#a0">StrKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00047 <font class="keyword">virtual</font> <a class="code" href="class_strkey.html#a1">~ StrKey</a> (); +00048 }; +00049 +00050 +00051 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/strkey_8h-source.html b/doc/api-documentation/html/strkey_8h-source.html new file mode 100644 index 0000000..eaddce4 --- /dev/null +++ b/doc/api-documentation/html/strkey_8h-source.html @@ -0,0 +1,59 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>strkey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>strkey.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * strkey.h - code for class 'strkey'- a standard Biblical verse key</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: strkey_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 +00023 <font class="preprocessor">#ifndef STRKEY_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define STRKEY_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swkey.h></font> +00027 <font class="preprocessor">#include <swmacs.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00035"></a><a class="code" href="class_str_key.html">00035</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_str_key.html">StrKey</a>:<font class="keyword">public</font> <a class="code" href="class_s_w_key.html">SWKey</a> +00036 { +00037 <font class="keyword">static</font> <a class="code" href="class_s_w_class.html">SWClass</a> classdef; +00038 <font class="keywordtype">void</font> init (); +00039 <font class="keyword">public</font>: +00044 <a class="code" href="class_str_key.html#a0">StrKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00047 <font class="keyword">virtual</font> <a class="code" href="class_str_key.html#a1">~ StrKey</a> (); +00048 +00049 SWKEY_OPERATORS +00050 +00051 }; +00052 +00053 +00054 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/strkey_h-source.html b/doc/api-documentation/html/strkey_h-source.html new file mode 100644 index 0000000..8a1284f --- /dev/null +++ b/doc/api-documentation/html/strkey_h-source.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>strkey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>strkey.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * strkey.h - code for class 'strkey'- a standard Biblical verse key</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: strkey_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 +00023 <font class="preprocessor">#ifndef STRKEY_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define STRKEY_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swkey.h></font> +00027 <font class="preprocessor">#include <swmacs.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00035"></a><a class="code" href="class_strkey.html">00035</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_strkey.html">StrKey</a>:<font class="keyword">public</font> <a class="code" href="class_swkey.html">SWKey</a> +00036 { +00037 <font class="keyword">static</font> <a class="code" href="class_swclass.html">SWClass</a> classdef; +00038 <font class="keywordtype">void</font> init (); +00039 <font class="keyword">public</font>: +00044 <a class="code" href="class_strkey.html#a0">StrKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00047 <font class="keyword">virtual</font> <a class="code" href="class_strkey.html#a1">~ StrKey</a> (); +00048 +00049 SWKEY_OPERATORS +00050 +00051 }; +00052 +00053 +00054 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swbasicfilter_8h-source.html b/doc/api-documentation/html/swbasicfilter_8h-source.html new file mode 100644 index 0000000..226dfdd --- /dev/null +++ b/doc/api-documentation/html/swbasicfilter_8h-source.html @@ -0,0 +1,88 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swbasicfilter.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swbasicfilter.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swbasicfilter.h - definition of class SWBasicFilter. An SWFilter</font> +00003 <font class="comment"> * impl that provides some basic methods that</font> +00004 <font class="comment"> * many filter will need and can use as a starting</font> +00005 <font class="comment"> * point. </font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * $Id: swbasicfilter_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00010 <font class="comment"> * CrossWire Bible Society</font> +00011 <font class="comment"> * P. O. Box 2528</font> +00012 <font class="comment"> * Tempe, AZ 85280-2528</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00016 <font class="comment"> * Free Software Foundation version 2.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00021 <font class="comment"> * General Public License for more details.</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef SWBASICFILTER_H</font> +00026 <font class="preprocessor"></font><font class="preprocessor">#define SWBASICFILTER_H</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <swfilter.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 <font class="preprocessor">#include <map></font> +00032 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00033 +00034 +00035 <font class="keyword">class </font>SWDLLEXPORT SWBasicFilter : <font class="keyword">public</font> SWFilter { +00036 +00037 <font class="keywordtype">char</font> *tokenStart; +00038 <font class="keywordtype">char</font> *tokenEnd; +00039 <font class="keywordtype">char</font> *escStart; +00040 <font class="keywordtype">char</font> *escEnd; +00041 <font class="keywordtype">bool</font> escStringCaseSensitive; +00042 <font class="keywordtype">bool</font> tokenCaseSensitive; +00043 <font class="keywordtype">bool</font> passThruUnknownToken; +00044 <font class="keywordtype">bool</font> passThruUnknownEsc; +00045 +00046 <font class="keyword">public</font>: +00047 SWBasicFilter(); +00048 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00049 <font class="keyword">virtual</font> ~SWBasicFilter(); +00050 +00051 <font class="keyword">protected</font>: +00052 <font class="keyword">typedef</font> map<string, string> DualStringMap; +00053 DualStringMap tokenSubMap; +00054 DualStringMap escSubMap; +00055 <font class="keywordtype">void</font> setEscapeStart(<font class="keyword">const</font> <font class="keywordtype">char</font> *escStart); +00056 <font class="keywordtype">void</font> setEscapeEnd(<font class="keyword">const</font> <font class="keywordtype">char</font> *escEnd); +00057 <font class="keywordtype">void</font> setTokenStart(<font class="keyword">const</font> <font class="keywordtype">char</font> *tokenStart); +00058 <font class="keywordtype">void</font> setTokenEnd(<font class="keyword">const</font> <font class="keywordtype">char</font> *tokenEnd); +00059 <font class="keywordtype">void</font> setPassThruUnknownToken(<font class="keywordtype">bool</font> val); +00060 <font class="keywordtype">void</font> setPassThruUnknownEscapeString(<font class="keywordtype">bool</font> val); +00061 <font class="keywordtype">void</font> setTokenCaseSensitive(<font class="keywordtype">bool</font> val); +00062 <font class="keywordtype">void</font> setEscapeStringCaseSensitive(<font class="keywordtype">bool</font> val); +00063 <font class="keywordtype">void</font> addTokenSubstitute(<font class="keyword">const</font> <font class="keywordtype">char</font> *findString, <font class="keyword">const</font> <font class="keywordtype">char</font> *replaceString); +00064 <font class="keywordtype">void</font> addEscapeStringSubstitute(<font class="keyword">const</font> <font class="keywordtype">char</font> *findString, <font class="keyword">const</font> <font class="keywordtype">char</font> *replaceString); +00065 <font class="keywordtype">bool</font> substituteToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token); +00066 <font class="keywordtype">bool</font> substituteEscapeString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *escString); +00067 <font class="keywordtype">void</font> pushString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *format, ...); +00068 +00069 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token, DualStringMap &userData); +00070 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleEscapeString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *escString, DualStringMap &userData); +00071 }; +00072 +00073 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swbasicfilter_h-source.html b/doc/api-documentation/html/swbasicfilter_h-source.html new file mode 100644 index 0000000..32aeb1f --- /dev/null +++ b/doc/api-documentation/html/swbasicfilter_h-source.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swbasicfilter.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swbasicfilter.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swbasicfilter.h - definition of class SWBasicFilter. An SWFilter</font> +00003 <font class="comment"> * impl that provides some basic methods that</font> +00004 <font class="comment"> * many filter will need and can use as a starting</font> +00005 <font class="comment"> * point. </font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * $Id: swbasicfilter_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00010 <font class="comment"> * CrossWire Bible Society</font> +00011 <font class="comment"> * P. O. Box 2528</font> +00012 <font class="comment"> * Tempe, AZ 85280-2528</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00016 <font class="comment"> * Free Software Foundation version 2.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00021 <font class="comment"> * General Public License for more details.</font> +00022 <font class="comment"> *</font> +00023 <font class="comment"> */</font> +00024 +00025 <font class="preprocessor">#ifndef SWBASICFILTER_H</font> +00026 <font class="preprocessor"></font><font class="preprocessor">#define SWBASICFILTER_H</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <swfilter.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 <font class="preprocessor">#include <map></font> +00032 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00033 +00034 +00035 <font class="keyword">class </font>SWDLLEXPORT SWBasicFilter : <font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> { +00036 +00037 <font class="keywordtype">char</font> *tokenStart; +00038 <font class="keywordtype">char</font> *tokenEnd; +00039 <font class="keywordtype">char</font> *escStart; +00040 <font class="keywordtype">char</font> *escEnd; +00041 <font class="keywordtype">bool</font> escStringCaseSensitive; +00042 <font class="keywordtype">bool</font> tokenCaseSensitive; +00043 <font class="keywordtype">bool</font> passThruUnknownToken; +00044 <font class="keywordtype">bool</font> passThruUnknownEsc; +00045 +00046 <font class="keyword">public</font>: +00047 SWBasicFilter(); +00048 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00049 <font class="keyword">virtual</font> ~SWBasicFilter(); +00050 +00051 <font class="keyword">protected</font>: +00052 <font class="keyword">typedef</font> map<string, string> DualStringMap; +00053 DualStringMap tokenSubMap; +00054 DualStringMap escSubMap; +00055 <font class="keywordtype">void</font> setEscapeStart(<font class="keyword">const</font> <font class="keywordtype">char</font> *escStart); +00056 <font class="keywordtype">void</font> setEscapeEnd(<font class="keyword">const</font> <font class="keywordtype">char</font> *escEnd); +00057 <font class="keywordtype">void</font> setTokenStart(<font class="keyword">const</font> <font class="keywordtype">char</font> *tokenStart); +00058 <font class="keywordtype">void</font> setTokenEnd(<font class="keyword">const</font> <font class="keywordtype">char</font> *tokenEnd); +00059 <font class="keywordtype">void</font> setPassThruUnknownToken(<font class="keywordtype">bool</font> val); +00060 <font class="keywordtype">void</font> setPassThruUnknownEscapeString(<font class="keywordtype">bool</font> val); +00061 <font class="keywordtype">void</font> setTokenCaseSensitive(<font class="keywordtype">bool</font> val); +00062 <font class="keywordtype">void</font> setEscapeStringCaseSensitive(<font class="keywordtype">bool</font> val); +00063 <font class="keywordtype">void</font> addTokenSubstitute(<font class="keyword">const</font> <font class="keywordtype">char</font> *findString, <font class="keyword">const</font> <font class="keywordtype">char</font> *replaceString); +00064 <font class="keywordtype">void</font> addEscapeStringSubstitute(<font class="keyword">const</font> <font class="keywordtype">char</font> *findString, <font class="keyword">const</font> <font class="keywordtype">char</font> *replaceString); +00065 <font class="keywordtype">bool</font> substituteToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token); +00066 <font class="keywordtype">bool</font> substituteEscapeString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *escString); +00067 <font class="keywordtype">void</font> pushString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *fragToPush); +00068 +00069 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token, DualStringMap &userData); +00070 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleEscapeString(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *escString, DualStringMap &userData); +00071 }; +00072 +00073 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swbyteswap_8h-source.html b/doc/api-documentation/html/swbyteswap_8h-source.html new file mode 100644 index 0000000..b305334 --- /dev/null +++ b/doc/api-documentation/html/swbyteswap_8h-source.html @@ -0,0 +1,67 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swbyteswap.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swbyteswap.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swkey.h - macros for byteswapping necessary for big endian cpus (or not)</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef SWBYTESWAP_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define SWBYTESWAP_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#ifdef BIGENDIAN</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#ifdef MACOSX</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <architecture/byte_order.h></font> +00027 <font class="preprocessor">#define SWAP32(x) NXSwapLittleLongToHost(x)</font> +00028 <font class="preprocessor"></font><font class="preprocessor">#define SWAP16(x) NXSwapLittleShortToHost(x)</font> +00029 <font class="preprocessor"></font> +00030 <font class="preprocessor">#else</font> +00031 <font class="preprocessor"></font><font class="preprocessor">#ifdef SPARC_SOLARIS</font> +00032 <font class="preprocessor"></font> +00033 <font class="preprocessor">#include <sys/pctypes.h></font> +00034 <font class="preprocessor">#define SWAP32(x) lelong(x)</font> +00035 <font class="preprocessor"></font><font class="preprocessor">#define SWAP16(x) leshort(x)</font> +00036 <font class="preprocessor"></font> +00037 <font class="preprocessor">#else // all big endian GNU systems</font> +00038 <font class="preprocessor"></font> +00039 <font class="preprocessor">#include <byteswap.h></font> +00040 <font class="preprocessor">#define SWAP32(x) bswap_32(x)</font> +00041 <font class="preprocessor"></font><font class="preprocessor">#define SWAP16(x) bswap_16(x)</font> +00042 <font class="preprocessor"></font> +00043 <font class="preprocessor">#endif</font> +00044 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00045 <font class="preprocessor"></font><font class="preprocessor">#else //little endian</font> +00046 <font class="preprocessor"></font> +00047 <font class="preprocessor">#define SWAP32(x) x</font> +00048 <font class="preprocessor"></font><font class="preprocessor">#define SWAP16(x) x</font> +00049 <font class="preprocessor"></font> +00050 <font class="preprocessor">#endif</font> +00051 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00052 <font class="preprocessor"></font> +</pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swbyteswap_h-source.html b/doc/api-documentation/html/swbyteswap_h-source.html new file mode 100644 index 0000000..c5acd8d --- /dev/null +++ b/doc/api-documentation/html/swbyteswap_h-source.html @@ -0,0 +1,68 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swbyteswap.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swbyteswap.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swkey.h - macros for byteswapping necessary for big endian cpus (or not)</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef SWBYTESWAP_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define SWBYTESWAP_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#ifdef BIGENDIAN</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#ifdef MACOSX</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <architecture/byte_order.h></font> +00027 <font class="preprocessor">#define SWAP32(x) NXSwapLittleLongToHost(x)</font> +00028 <font class="preprocessor"></font><font class="preprocessor">#define SWAP16(x) NXSwapLittleShortToHost(x)</font> +00029 <font class="preprocessor"></font> +00030 <font class="preprocessor">#else</font> +00031 <font class="preprocessor"></font><font class="preprocessor">#ifdef SPARC_SOLARIS</font> +00032 <font class="preprocessor"></font> +00033 <font class="preprocessor">#include <sys/pctypes.h></font> +00034 <font class="preprocessor">#define SWAP32(x) lelong(x)</font> +00035 <font class="preprocessor"></font><font class="preprocessor">#define SWAP16(x) leshort(x)</font> +00036 <font class="preprocessor"></font> +00037 <font class="preprocessor">#else // all big endian GNU systems</font> +00038 <font class="preprocessor"></font> +00039 <font class="preprocessor">#include <byteswap.h></font> +00040 <font class="preprocessor">#define SWAP32(x) bswap_32(x)</font> +00041 <font class="preprocessor"></font><font class="preprocessor">#define SWAP16(x) bswap_16(x)</font> +00042 <font class="preprocessor"></font> +00043 <font class="preprocessor">#endif</font> +00044 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00045 <font class="preprocessor"></font><font class="preprocessor">#else //little endian</font> +00046 <font class="preprocessor"></font> +00047 <font class="preprocessor">#define SWAP32(x) x</font> +00048 <font class="preprocessor"></font><font class="preprocessor">#define SWAP16(x) x</font> +00049 <font class="preprocessor"></font> +00050 <font class="preprocessor">#endif</font> +00051 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00052 <font class="preprocessor"></font> +</pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swcipher.h-source.html b/doc/api-documentation/html/swcipher.h-source.html new file mode 100644 index 0000000..b668a05 --- /dev/null +++ b/doc/api-documentation/html/swcipher.h-source.html @@ -0,0 +1,64 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swcipher.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swcipher.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swcipher.h - definition of Class SWCipher used for data cipher/decipher +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: swcipher.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1999 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWCIPHER_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define SWCIPHER_H +</font>00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include "sapphire.h"</font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT SWCipher +00030 { +00031 +00032 sapphire master; +00033 sapphire work; +00034 +00035 <font class="keywordtype">char</font> *buf; +00036 <font class="keywordtype">bool</font> cipher; +00037 <font class="keywordtype">int</font> len; +00038 <font class="keyword">protected</font>: +00039 <font class="keyword">public</font>: +00040 SWCipher (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *key); +00041 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setCipherKey (<font class="keyword">const</font> <font class="keywordtype">char</font> *key); +00042 <font class="keyword">virtual</font> ~ SWCipher (); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *Buf (<font class="keyword">const</font> <font class="keywordtype">char</font> *buf = 0); +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *cipherBuf (<font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> *len, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf = 0); +00045 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); +00046 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); +00047 }; +00048 +00049 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swcipher_8h-source.html b/doc/api-documentation/html/swcipher_8h-source.html new file mode 100644 index 0000000..46100fa --- /dev/null +++ b/doc/api-documentation/html/swcipher_8h-source.html @@ -0,0 +1,64 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swcipher.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swcipher.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swcipher.h - definition of Class SWCipher used for data cipher/decipher</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: swcipher_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1999 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWCIPHER_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define SWCIPHER_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include "sapphire.h"</font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT SWCipher +00030 { +00031 +00032 sapphire master; +00033 sapphire work; +00034 +00035 <font class="keywordtype">char</font> *buf; +00036 <font class="keywordtype">bool</font> cipher; +00037 <font class="keywordtype">int</font> len; +00038 <font class="keyword">protected</font>: +00039 <font class="keyword">public</font>: +00040 SWCipher (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *key); +00041 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setCipherKey (<font class="keyword">const</font> <font class="keywordtype">char</font> *key); +00042 <font class="keyword">virtual</font> ~ SWCipher (); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *Buf (<font class="keyword">const</font> <font class="keywordtype">char</font> *buf = 0, <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> len = 0); +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *cipherBuf (<font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> *len, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf = 0); +00045 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); +00046 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); +00047 }; +00048 +00049 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swcipher_h-source.html b/doc/api-documentation/html/swcipher_h-source.html new file mode 100644 index 0000000..05cdb17 --- /dev/null +++ b/doc/api-documentation/html/swcipher_h-source.html @@ -0,0 +1,65 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swcipher.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swcipher.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swcipher.h - definition of Class SWCipher used for data cipher/decipher</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: swcipher_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1999 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWCIPHER_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define SWCIPHER_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include "sapphire.h"</font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT SWCipher +00030 { +00031 +00032 sapphire master; +00033 sapphire work; +00034 +00035 <font class="keywordtype">char</font> *buf; +00036 <font class="keywordtype">bool</font> cipher; +00037 <font class="keywordtype">int</font> len; +00038 <font class="keyword">protected</font>: +00039 <font class="keyword">public</font>: +00040 SWCipher (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> *key); +00041 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setCipherKey (<font class="keyword">const</font> <font class="keywordtype">char</font> *key); +00042 <font class="keyword">virtual</font> ~ SWCipher (); +00043 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *Buf (<font class="keyword">const</font> <font class="keywordtype">char</font> *buf = 0); +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *cipherBuf (<font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> *len, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf = 0); +00045 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); +00046 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); +00047 }; +00048 +00049 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swcom.h-source.html b/doc/api-documentation/html/swcom.h-source.html new file mode 100644 index 0000000..21488c0 --- /dev/null +++ b/doc/api-documentation/html/swcom.h-source.html @@ -0,0 +1,58 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:25 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swcom.h - code for base class 'SWCom'. SWCom is the basis for all +</font>00003 <font class="comment"> * types of commentary modules +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swcom.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWCOM_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define SWCOM_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swmodule.h></font> +00027 <font class="preprocessor">#include <versekey.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00033"></a><a class="code" href="class_swcom.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swcom.html">SWCom</a>:<font class="keyword">public</font> <a class="code" href="class_swmodule.html">SWModule</a> +00034 { +00035 <font class="keyword">public</font>: +00042 <a class="code" href="class_swcom.html#a0">SWCom</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00043 <font class="keyword">virtual</font> ~SWCom (); +<a name="l00044"></a><a class="code" href="class_swcom.html#a2">00044</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swmodule.html#a17">CreateKey</a> ()<font class="keyword"> +</font>00045 <font class="keyword"> </font>{ +00046 <font class="keywordflow">return</font> <font class="keyword">new</font> VerseKey (); +00047 } +00048 }; +00049 +00050 +00051 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:25 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swcom_8h-source.html b/doc/api-documentation/html/swcom_8h-source.html new file mode 100644 index 0000000..6f57376 --- /dev/null +++ b/doc/api-documentation/html/swcom_8h-source.html @@ -0,0 +1,58 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swcom.h - code for base class 'SWCom'. SWCom is the basis for all</font> +00003 <font class="comment"> * types of commentary modules</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swcom_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWCOM_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWCOM_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swmodule.h></font> +00027 <font class="preprocessor">#include <versekey.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00033"></a><a class="code" href="class_s_w_com.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_com.html">SWCom</a> : <font class="keyword">public</font> <a class="code" href="class_s_w_module.html">SWModule</a> { +00034 <font class="keyword">public</font>: +00035 +00042 <a class="code" href="class_s_w_com.html#a0">SWCom</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding enc = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup mark = FMT_UNKNOWN, <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); +00043 <font class="keyword">virtual</font> ~SWCom(); +<a name="l00044"></a><a class="code" href="class_s_w_com.html#a2">00044</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> *<a class="code" href="class_s_w_module.html#a23">CreateKey</a>()<font class="keyword"></font> +00045 <font class="keyword"> </font>{ +00046 <font class="keywordflow">return</font> <font class="keyword">new</font> VerseKey(); +00047 } +00048 }; +00049 +00050 +00051 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swcom_h-source.html b/doc/api-documentation/html/swcom_h-source.html new file mode 100644 index 0000000..49e9fc7 --- /dev/null +++ b/doc/api-documentation/html/swcom_h-source.html @@ -0,0 +1,59 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swcom.h - code for base class 'SWCom'. SWCom is the basis for all</font> +00003 <font class="comment"> * types of commentary modules</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swcom_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWCOM_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWCOM_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swmodule.h></font> +00027 <font class="preprocessor">#include <versekey.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00033"></a><a class="code" href="class_swcom.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swcom.html">SWCom</a> : <font class="keyword">public</font> <a class="code" href="class_swmodule.html">SWModule</a> { +00034 <font class="keyword">public</font>: +00035 +00042 <a class="code" href="class_swcom.html#a0">SWCom</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00043 <font class="keyword">virtual</font> ~SWCom(); +<a name="l00044"></a><a class="code" href="class_swcom.html#a2">00044</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swmodule.html#a19">CreateKey</a>()<font class="keyword"></font> +00045 <font class="keyword"> </font>{ +00046 <font class="keywordflow">return</font> <font class="keyword">new</font> VerseKey(); +00047 } +00048 }; +00049 +00050 +00051 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swcomprs.h-source.html b/doc/api-documentation/html/swcomprs.h-source.html new file mode 100644 index 0000000..0c999b6 --- /dev/null +++ b/doc/api-documentation/html/swcomprs.h-source.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swcomprs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swcomprs.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swcomprs.h - definition of Class SWCompress used for data compression +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: swcomprs.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWCOMPRS_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define SWCOMPRS_H +</font>00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <defs.h></font> +00026 +00027 <font class="keyword">class </font>SWDLLEXPORT SWCompress +00028 { +00029 <font class="keywordtype">void</font> Init (); +00030 <font class="keywordtype">void</font> cycleStream (); +00031 <font class="keyword">protected</font>: +00032 <font class="keywordtype">char</font> *buf, *zbuf, direct; <font class="comment">// 0 - encode; 1 - decode</font> +00033 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> zlen, zpos, pos, slen; +00034 <font class="keyword">public</font>: +00035 SWCompress (); +00036 <font class="keyword">virtual</font> ~ SWCompress (); +00037 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *Buf (<font class="keywordtype">char</font> *buf = 0); +00038 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *zBuf (<font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> *len, <font class="keywordtype">char</font> *buf = 0); +00039 <font class="keyword">virtual</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> GetChars (<font class="keywordtype">char</font> *buf, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> len); <font class="comment">// override for other than buffer compression</font> +00040 <font class="keyword">virtual</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> SendChars (<font class="keywordtype">char</font> *buf, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> len); <font class="comment">// override for other than buffer compression</font> +00041 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); <font class="comment">// override to provide compression algorythm</font> +00042 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); <font class="comment">// override to provide compression algorythm</font> +00043 }; +00044 +00045 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swcomprs_8h-source.html b/doc/api-documentation/html/swcomprs_8h-source.html new file mode 100644 index 0000000..a17c9dc --- /dev/null +++ b/doc/api-documentation/html/swcomprs_8h-source.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swcomprs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swcomprs.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swcomprs.h - definition of Class SWCompress used for data compression</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: swcomprs_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWCOMPRS_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define SWCOMPRS_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <defs.h></font> +00026 +00027 <font class="keyword">class </font>SWDLLEXPORT SWCompress +00028 { +00029 <font class="keywordtype">void</font> Init (); +00030 <font class="keywordtype">void</font> cycleStream (); +00031 <font class="keyword">protected</font>: +00032 <font class="keywordtype">char</font> *buf, *zbuf, direct; <font class="comment">// 0 - encode; 1 - decode</font> +00033 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> zlen, zpos, pos, slen; +00034 <font class="keyword">public</font>: +00035 SWCompress (); +00036 <font class="keyword">virtual</font> ~ SWCompress (); +00037 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *Buf (<font class="keyword">const</font> <font class="keywordtype">char</font> *buf = 0, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> *len = 0); +00038 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *zBuf (<font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> *len, <font class="keywordtype">char</font> *buf = 0); +00039 <font class="keyword">virtual</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> GetChars (<font class="keywordtype">char</font> *buf, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> len); <font class="comment">// override for other than buffer compression</font> +00040 <font class="keyword">virtual</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> SendChars (<font class="keywordtype">char</font> *buf, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> len); <font class="comment">// override for other than buffer compression</font> +00041 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); <font class="comment">// override to provide compression algorythm</font> +00042 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); <font class="comment">// override to provide compression algorythm</font> +00043 }; +00044 +00045 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swcomprs_h-source.html b/doc/api-documentation/html/swcomprs_h-source.html new file mode 100644 index 0000000..5908225 --- /dev/null +++ b/doc/api-documentation/html/swcomprs_h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swcomprs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swcomprs.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swcomprs.h - definition of Class SWCompress used for data compression</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: swcomprs_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWCOMPRS_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define SWCOMPRS_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <defs.h></font> +00026 +00027 <font class="keyword">class </font>SWDLLEXPORT SWCompress +00028 { +00029 <font class="keywordtype">void</font> Init (); +00030 <font class="keywordtype">void</font> cycleStream (); +00031 <font class="keyword">protected</font>: +00032 <font class="keywordtype">char</font> *buf, *zbuf, direct; <font class="comment">// 0 - encode; 1 - decode</font> +00033 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> zlen, zpos, pos, slen; +00034 <font class="keyword">public</font>: +00035 SWCompress (); +00036 <font class="keyword">virtual</font> ~ SWCompress (); +00037 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *Buf (<font class="keywordtype">char</font> *buf = 0); +00038 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *zBuf (<font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> *len, <font class="keywordtype">char</font> *buf = 0); +00039 <font class="keyword">virtual</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> GetChars (<font class="keywordtype">char</font> *buf, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> len); <font class="comment">// override for other than buffer compression</font> +00040 <font class="keyword">virtual</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> SendChars (<font class="keywordtype">char</font> *buf, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> len); <font class="comment">// override for other than buffer compression</font> +00041 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); <font class="comment">// override to provide compression algorythm</font> +00042 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); <font class="comment">// override to provide compression algorythm</font> +00043 }; +00044 +00045 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swconfig.h-source.html b/doc/api-documentation/html/swconfig.h-source.html new file mode 100644 index 0000000..eb5c0ce --- /dev/null +++ b/doc/api-documentation/html/swconfig.h-source.html @@ -0,0 +1,85 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swconfig.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swconfig.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swconfig.h - definition of Class SWConfig used for saving and retrieval +</font>00003 <font class="comment"> * of configuration information +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swconfig.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWCONFIG_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define SWCONFIG_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <stdio.h></font> +00027 +00028 <font class="preprocessor">#include <string></font> +00029 <font class="preprocessor">#include <map></font> +00030 +00031 <font class="preprocessor">#include <defs.h></font> +00032 +00033 <font class="keyword">using</font> <font class="keyword">namespace</font> std; +00034 +00035 +00036 <font class="comment">// multmap that still lets you use [] to reference FIRST</font> +00037 <font class="comment">// entry of a key if multiples exist</font> +00038 template <class Key, class T, class Compare> +00039 <font class="keyword">class </font>multimapwithdefault : <font class="keyword">public</font> multimap<Key, T, Compare> { +00040 <font class="keyword">public</font>: +00041 <font class="keyword">typedef</font> pair<const Key, T> value_type; +00042 T& operator[](<font class="keyword">const</font> Key& k)<font class="keyword"> </font>{ +00043 <font class="keywordflow">if</font> (find(k) == end()) { +00044 insert(value_type(k, T())); +00045 } +00046 <font class="keywordflow">return</font> (*(find(k))).second; +00047 } +00048 }; +00049 +00050 <font class="keyword">typedef</font> multimapwithdefault < string, string, less < string > >ConfigEntMap; +00051 <font class="keyword">typedef</font> map < string, ConfigEntMap, less < string > >SectionMap; +00052 +<a name="l00056"></a><a class="code" href="class_swconfig.html">00056</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swconfig.html">SWConfig</a> +00057 { +00058 <font class="keyword">private</font>: +00059 <font class="keywordtype">char</font> getline (FILE * fp, string & line); +00060 <font class="keyword">public</font>: +<a name="l00064"></a><a class="code" href="class_swconfig.html#m0">00064</a> string filename; +<a name="l00068"></a><a class="code" href="class_swconfig.html#m1">00068</a> SectionMap Sections; +00069 +00073 <a class="code" href="class_swconfig.html#a0">SWConfig</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ifilename); +00074 <font class="keyword">virtual</font> ~ SWConfig (); +00075 +00079 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swconfig.html#a2">Load</a> (); +00083 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swconfig.html#a3">Save</a> (); +00087 <font class="keyword">virtual</font> <a class="code" href="class_swconfig.html">SWConfig</a> &<a class="code" href="class_swconfig.html#a4"> operator += </a>(<a class="code" href="class_swconfig.html">SWConfig</a> & addFrom); +00094 <font class="keyword">virtual</font> ConfigEntMap &<a class="code" href="class_swconfig.html#a5"> operator [] </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *section); +00095 }; +00096 +00097 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swconfig_8h-source.html b/doc/api-documentation/html/swconfig_8h-source.html new file mode 100644 index 0000000..99c0229 --- /dev/null +++ b/doc/api-documentation/html/swconfig_8h-source.html @@ -0,0 +1,88 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swconfig.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swconfig.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swconfig.h - definition of Class SWConfig used for saving and retrieval</font> +00003 <font class="comment"> * of configuration information</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swconfig_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWCONFIG_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWCONFIG_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <stdio.h></font> +00027 +00028 <font class="preprocessor">#include <string></font> +00029 <font class="preprocessor">#include <map></font> +00030 +00031 <font class="preprocessor">#include <defs.h></font> +00032 +00033 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00034 +00035 +00036 <font class="comment">// multmap that still lets you use [] to reference FIRST</font> +00037 <font class="comment">// entry of a key if multiples exist</font> +00038 template <class Key, class T, class Compare> +00039 <font class="keyword">class </font>multimapwithdefault : <font class="keyword">public</font> multimap<Key, T, Compare> { +00040 <font class="keyword">public</font>: +00041 <font class="keyword">typedef</font> pair<const Key, T> value_type; +00042 T& operator[](<font class="keyword">const</font> Key& k)<font class="keyword"> </font>{ +00043 <font class="keywordflow">if</font> (find(k) == end()) { +00044 insert(value_type(k, T())); +00045 } +00046 <font class="keywordflow">return</font> (*(find(k))).second; +00047 } +00048 }; +00049 +00050 <font class="keyword">typedef</font> multimapwithdefault < string, string, less < string > >ConfigEntMap; +00051 <font class="keyword">typedef</font> map < string, ConfigEntMap, less < string > >SectionMap; +00052 +<a name="l00056"></a><a class="code" href="class_s_w_config.html">00056</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_config.html">SWConfig</a> +00057 { +00058 <font class="keyword">private</font>: +00059 <font class="keywordtype">char</font> getline (FILE * fp, string & line); +00060 <font class="keyword">public</font>: +<a name="l00064"></a><a class="code" href="class_s_w_config.html#m0">00064</a> string filename; +<a name="l00068"></a><a class="code" href="class_s_w_config.html#m1">00068</a> SectionMap Sections; +00069 +00073 <a class="code" href="class_s_w_config.html#a0">SWConfig</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ifilename); +00074 <font class="keyword">virtual</font> ~ SWConfig (); +00075 +00079 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_config.html#a2">Load</a> (); +00080 +00084 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_config.html#a3">Save</a> (); +00085 +00089 <font class="keyword">virtual</font> <a class="code" href="class_s_w_config.html">SWConfig</a> & <a class="code" href="class_s_w_config.html#a4">operator += </a>(<a class="code" href="class_s_w_config.html">SWConfig</a> & addFrom); +00090 +00100 <font class="keyword">virtual</font> ConfigEntMap & <a class="code" href="class_s_w_config.html#a5">operator [] </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *section); +00101 }; +00102 +00103 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swconfig_h-source.html b/doc/api-documentation/html/swconfig_h-source.html new file mode 100644 index 0000000..6688d4f --- /dev/null +++ b/doc/api-documentation/html/swconfig_h-source.html @@ -0,0 +1,89 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swconfig.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swconfig.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swconfig.h - definition of Class SWConfig used for saving and retrieval</font> +00003 <font class="comment"> * of configuration information</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swconfig_h-source.html,v 1.4 2001/10/05 20:45:21 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWCONFIG_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWCONFIG_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <stdio.h></font> +00027 +00028 <font class="preprocessor">#include <string></font> +00029 <font class="preprocessor">#include <map></font> +00030 +00031 <font class="preprocessor">#include <defs.h></font> +00032 +00033 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00034 +00035 +00036 <font class="comment">// multmap that still lets you use [] to reference FIRST</font> +00037 <font class="comment">// entry of a key if multiples exist</font> +00038 template <class Key, class T, class Compare> +00039 <font class="keyword">class </font>multimapwithdefault : <font class="keyword">public</font> multimap<Key, T, Compare> { +00040 <font class="keyword">public</font>: +00041 <font class="keyword">typedef</font> pair<const Key, T> value_type; +00042 T& operator[](<font class="keyword">const</font> Key& k)<font class="keyword"> </font>{ +00043 <font class="keywordflow">if</font> (find(k) == end()) { +00044 insert(value_type(k, T())); +00045 } +00046 <font class="keywordflow">return</font> (*(find(k))).second; +00047 } +00048 }; +00049 +00050 <font class="keyword">typedef</font> multimapwithdefault < string, string, less < string > >ConfigEntMap; +00051 <font class="keyword">typedef</font> map < string, ConfigEntMap, less < string > >SectionMap; +00052 +<a name="l00056"></a><a class="code" href="class_swconfig.html">00056</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swconfig.html">SWConfig</a> +00057 { +00058 <font class="keyword">private</font>: +00059 <font class="keywordtype">char</font> getline (FILE * fp, string & line); +00060 <font class="keyword">public</font>: +<a name="l00064"></a><a class="code" href="class_swconfig.html#m0">00064</a> string filename; +<a name="l00068"></a><a class="code" href="class_swconfig.html#m1">00068</a> SectionMap Sections; +00069 +00073 <a class="code" href="class_swconfig.html#a0">SWConfig</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ifilename); +00074 <font class="keyword">virtual</font> ~ SWConfig (); +00075 +00079 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swconfig.html#a2">Load</a> (); +00080 +00084 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swconfig.html#a3">Save</a> (); +00085 +00089 <font class="keyword">virtual</font> <a class="code" href="class_swconfig.html">SWConfig</a> & <a class="code" href="class_swconfig.html#a4">operator += </a>(<a class="code" href="class_swconfig.html">SWConfig</a> & addFrom); +00090 +00100 <font class="keyword">virtual</font> ConfigEntMap & <a class="code" href="class_swconfig.html#a5">operator [] </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *section); +00101 }; +00102 +00103 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swdisp.h-source.html b/doc/api-documentation/html/swdisp.h-source.html new file mode 100644 index 0000000..7f32927 --- /dev/null +++ b/doc/api-documentation/html/swdisp.h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swdisp.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swdisp.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swdisp.h - code for base class 'swdisp'. swdisp is the basis for all +</font>00003 <font class="comment"> * types of displays (e.g. raw textout, curses, xwindow, etc.) +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swdisp.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWDISP_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define SWDISP_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <defs.h></font> +00027 +00028 <font class="keyword">class </font><a class="code" href="class_swmodule.html">SWModule</a>; +00029 +<a name="l00033"></a><a class="code" href="class_swdisplay.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swdisplay.html">SWDisplay</a> +00034 { +00035 <font class="keyword">public</font>: +00036 SWDisplay ()<font class="keyword"> </font>{}; +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swdisplay.html#a1">Display</a> (<a class="code" href="class_swmodule.html">SWModule</a> & imodule); +00045 }; +00046 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swdisp_8h-source.html b/doc/api-documentation/html/swdisp_8h-source.html new file mode 100644 index 0000000..54043a2 --- /dev/null +++ b/doc/api-documentation/html/swdisp_8h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swdisp.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swdisp.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swdisp.h - code for base class 'swdisp'. swdisp is the basis for all</font> +00003 <font class="comment"> * types of displays (e.g. raw textout, curses, xwindow, etc.)</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swdisp_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWDISP_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWDISP_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <defs.h></font> +00027 +00028 <font class="keyword">class </font><a class="code" href="class_s_w_module.html">SWModule</a>; +00029 +<a name="l00033"></a><a class="code" href="class_s_w_display.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_display.html">SWDisplay</a> +00034 { +00035 <font class="keyword">public</font>: +00036 SWDisplay ()<font class="keyword"> </font>{}; +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_display.html#a1">Display</a> (<a class="code" href="class_s_w_module.html">SWModule</a> & imodule); +00045 }; +00046 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swdisp_h-source.html b/doc/api-documentation/html/swdisp_h-source.html new file mode 100644 index 0000000..3a14572 --- /dev/null +++ b/doc/api-documentation/html/swdisp_h-source.html @@ -0,0 +1,52 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swdisp.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swdisp.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swdisp.h - code for base class 'swdisp'. swdisp is the basis for all</font> +00003 <font class="comment"> * types of displays (e.g. raw textout, curses, xwindow, etc.)</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swdisp_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWDISP_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWDISP_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <defs.h></font> +00027 +00028 <font class="keyword">class </font><a class="code" href="class_swmodule.html">SWModule</a>; +00029 +<a name="l00033"></a><a class="code" href="class_swdisplay.html">00033</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swdisplay.html">SWDisplay</a> +00034 { +00035 <font class="keyword">public</font>: +00036 SWDisplay ()<font class="keyword"> </font>{}; +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swdisplay.html#a1">Display</a> (<a class="code" href="class_swmodule.html">SWModule</a> & imodule); +00045 }; +00046 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swdisprtf.h-source.html b/doc/api-documentation/html/swdisprtf.h-source.html new file mode 100644 index 0000000..8920279 --- /dev/null +++ b/doc/api-documentation/html/swdisprtf.h-source.html @@ -0,0 +1,121 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swdisprtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swdisprtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swdisprtf.h - definition of Class SWDispRTF-- an SWDisplay used to display +</font>00003 <font class="comment"> * a verse in Rich Text Format. +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swdisprtf.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="comment">//---------------------------------------------------------------------------</font> +00024 <font class="preprocessor">#ifndef SWDispRTFH +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#define SWDispRTFH +</font>00026 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00027 <font class="preprocessor">#include <vcl\SysUtils.hpp></font> +00028 <font class="preprocessor">#include <vcl\Controls.hpp></font> +00029 <font class="preprocessor">#include <vcl\Classes.hpp></font> +00030 <font class="preprocessor">#include <vcl\Forms.hpp></font> +00031 <font class="preprocessor">#include <vcl\ComCtrls.hpp></font> +00032 <font class="preprocessor">#include <vcl\StdCtrls.hpp></font> +00033 <font class="preprocessor">#include <swtext.h></font> +00034 <font class="comment">//---------------------------------------------------------------------------</font> +00035 +00036 <font class="preprocessor">#define defRTFHeader "{\\rtf1\\ansi{\\fonttbl{\\f0\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f1\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f2\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f3\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f4\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f7\\froman\\fcharset2\\fprq2 Symbol;}{\\f8\\froman\\fcharset2\\fprq2 Symbol;}}{\\colortbl;\\red0\\green0\\blue255;\\red0\\green200\\blue50;\\red0\\green0\\blue255;\\red0\\green200\\blue50;\\red0\\green0\\blue255;\\red255\\green0\\blue0;} " +</font>00037 <font class="preprocessor"></font><font class="preprocessor">#define defRTFHeadMargin "{\\fs8\\cf1\\par\\pard} " +</font>00038 <font class="preprocessor"></font><font class="preprocessor">#define defRTFTrailer "{\\fs%d \\par }}" // 24 +</font>00039 <font class="preprocessor"></font> +00040 <font class="preprocessor">#define defRTFChapterMarkPre "\\pard \\qc\\nowidctlpar{\\f1\\fs%d\\b Chapter " // 30 +</font>00041 <font class="preprocessor"></font><font class="preprocessor">#define defRTFChapterMarkPost "\\par\\fs%d\\par}" // 10 +</font>00042 <font class="preprocessor"></font> +00043 <font class="preprocessor">#define defRTFVerseMarkPre "{\\fs%d\\cf1\\super " //20 +</font>00044 <font class="preprocessor"></font><font class="preprocessor">#define defRTFVerseMarkPost "}" +</font>00045 <font class="preprocessor"></font> +00046 <font class="preprocessor">#define defRTFVersePre "{\\fs%d" // 24 +</font>00047 <font class="preprocessor"></font><font class="preprocessor">#define defRTFVersePost " }" +</font>00048 <font class="preprocessor"></font> +00049 +00050 <font class="keyword">class </font>SWDispRTF:<font class="keyword">public</font> TRichEdit +00051 { +00052 <font class="keyword">protected</font>: +00053 +00054 System::AnsiString FRTFHeader; +00055 System::AnsiString FRTFHeadMargin; +00056 System::AnsiString FRTFTrailer; +00057 System::AnsiString FRTFChapterMarkPre; +00058 System::AnsiString FRTFChapterMarkPost; +00059 System::AnsiString FRTFVerseMarkPre; +00060 System::AnsiString FRTFVerseMarkPost; +00061 System::AnsiString FRTFVersePre; +00062 System::AnsiString FRTFVersePost; +00063 <font class="keywordtype">bool</font> FExpandNewLine; +00064 CHARRANGE FCharRange; +00065 <font class="keywordtype">int</font> fontSize; +00066 +00067 <font class="keywordtype">int</font> __fastcall GetMySelStart (); +00068 <font class="keywordtype">void</font> __fastcall SetMySelStart (<font class="keywordtype">int</font> iselstart); +00069 <font class="keywordtype">int</font> __fastcall getFontSize (); +00070 <font class="keywordtype">void</font> __fastcall setFontSize (<font class="keywordtype">int</font> iFontSize); +00071 <font class="keywordtype">void</font> recalcHeaders (); +00072 <font class="keyword">protected</font>: +00073 TMemoryStream * RTFStream; +00074 +00075 <font class="keyword">virtual</font> <font class="keywordtype">void</font> __fastcall Loaded (<font class="keywordtype">void</font>); +00076 <font class="keyword">public</font>: +00077 __fastcall SWDispRTF (TComponent * Owner); +00078 __fastcall ~ SWDispRTF (); +00079 +00080 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Display (<a class="code" href="class_swmodule.html">SWModule</a> & imodule); +00081 __published:__property System::AnsiString RTFHeader = +00082 { +00083 read = FRTFHeader, write = FRTFHeader}; +00084 __property System::AnsiString RTFHeadMargin = { read = +00085 FRTFHeadMargin, write = FRTFHeadMargin }; +00086 __property System::AnsiString RTFChapterMarkPre = { read = +00087 FRTFChapterMarkPre, write = FRTFChapterMarkPre }; +00088 __property System::AnsiString RTFChapterMarkPost = { read = +00089 FRTFChapterMarkPost, write = FRTFChapterMarkPost }; +00090 __property System::AnsiString RTFVerseMarkPre = { read = +00091 FRTFVerseMarkPre, write = FRTFVerseMarkPre }; +00092 __property System::AnsiString RTFVerseMarkPost = { read = +00093 FRTFVerseMarkPost, write = FRTFVerseMarkPost }; +00094 __property System::AnsiString RTFVersePre = { read = FRTFVersePre, write = +00095 FRTFVersePre }; +00096 __property System::AnsiString RTFVersePost = { read = FRTFVersePost, write = +00097 FRTFVersePost }; +00098 __property System::AnsiString RTFTrailer = { read = FRTFTrailer, write = +00099 FRTFTrailer }; +00100 __property <font class="keywordtype">bool</font> ExpandNewLine = { read = FExpandNewLine, write = +00101 FExpandNewLine }; +00102 __property <font class="keywordtype">int</font> FontSize = { read = getFontSize, write = setFontSize }; +00103 }; +00104 +00105 <font class="comment">//---------------------------------------------------------------------------</font> +00106 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swdisprtf_8h-source.html b/doc/api-documentation/html/swdisprtf_8h-source.html new file mode 100644 index 0000000..65ed409 --- /dev/null +++ b/doc/api-documentation/html/swdisprtf_8h-source.html @@ -0,0 +1,127 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swdisprtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swdisprtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swdisprtf.h - definition of Class SWDispRTF-- an SWDisplay used to display</font> +00003 <font class="comment"> * a verse in Rich Text Format.</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swdisprtf_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="comment">//---------------------------------------------------------------------------</font> +00024 <font class="preprocessor">#ifndef SWDispRTFH</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define SWDispRTFH</font> +00026 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00027 <font class="preprocessor">#include <vcl\SysUtils.hpp></font> +00028 <font class="preprocessor">#include <vcl\Controls.hpp></font> +00029 <font class="preprocessor">#include <vcl\Classes.hpp></font> +00030 <font class="preprocessor">#include <vcl\Forms.hpp></font> +00031 <font class="preprocessor">#include <vcl\ComCtrls.hpp></font> +00032 <font class="preprocessor">#include <vcl\StdCtrls.hpp></font> +00033 <font class="preprocessor">#include <swtext.h></font> +00034 <font class="preprocessor">#ifndef USEOLDRTF</font> +00035 <font class="preprocessor"></font><font class="preprocessor">#include <RxRichEdit.hpp></font> +00036 <font class="preprocessor">#endif</font> +00037 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00038 +00039 <font class="preprocessor">#define defRTFHeader "{\\rtf1\\ansi{\\fonttbl{\\f0\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f1\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f2\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f3\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f4\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f7\\froman\\fcharset2\\fprq2 Symbol;}{\\f8\\froman\\fcharset2\\fprq2 Symbol;}}{\\colortbl;\\red0\\green0\\blue255;\\red0\\green200\\blue50;\\red0\\green0\\blue255;\\red0\\green200\\blue50;\\red0\\green0\\blue255;\\red255\\green0\\blue0;} "</font> +00040 <font class="preprocessor"></font><font class="preprocessor">#define defRTFHeadMargin "{\\fs8\\cf1\\par\\pard} "</font> +00041 <font class="preprocessor"></font><font class="preprocessor">#define defRTFTrailer "{\\fs%d \\par }}" // 24</font> +00042 <font class="preprocessor"></font> +00043 <font class="preprocessor">#define defRTFChapterMarkPre "\\pard \\qc\\nowidctlpar{\\f1\\cf7\\fs%d\\b Chapter " // 30</font> +00044 <font class="preprocessor"></font><font class="preprocessor">#define defRTFChapterMarkPost "\\par\\fs%d\\par}" // 10</font> +00045 <font class="preprocessor"></font> +00046 <font class="preprocessor">#define defRTFVerseMarkPre "{\\fs%d\\cf1\\super " //20</font> +00047 <font class="preprocessor"></font><font class="preprocessor">#define defRTFVerseMarkPost "}"</font> +00048 <font class="preprocessor"></font> +00049 <font class="preprocessor">#define defRTFVersePre "{\\fs%d" // 24</font> +00050 <font class="preprocessor"></font><font class="preprocessor">#define defRTFVersePost " }"</font> +00051 <font class="preprocessor"></font> +00052 <font class="preprocessor">#ifndef USEOLDRTF</font> +00053 <font class="preprocessor"></font><font class="keyword">class </font>SWDispRTF:<font class="keyword">public</font> TRxRichEdit +00054 #else +00055 class SWDispRTF:<font class="keyword">public</font> TRichEdit +00056 #endif +00057 { +00058 <font class="keyword">protected</font>: +00059 +00060 System::AnsiString FRTFHeader; +00061 System::AnsiString FRTFHeadMargin; +00062 System::AnsiString FRTFTrailer; +00063 System::AnsiString FRTFChapterMarkPre; +00064 System::AnsiString FRTFChapterMarkPost; +00065 System::AnsiString FRTFVerseMarkPre; +00066 System::AnsiString FRTFVerseMarkPost; +00067 System::AnsiString FRTFVersePre; +00068 System::AnsiString FRTFVersePost; +00069 <font class="keywordtype">bool</font> FExpandNewLine; +00070 CHARRANGE FCharRange; +00071 <font class="keywordtype">int</font> fontSize; +00072 +00073 <font class="keywordtype">int</font> __fastcall GetMySelStart (); +00074 <font class="keywordtype">void</font> __fastcall SetMySelStart (<font class="keywordtype">int</font> iselstart); +00075 <font class="keywordtype">int</font> __fastcall getFontSize (); +00076 <font class="keywordtype">void</font> __fastcall setFontSize (<font class="keywordtype">int</font> iFontSize); +00077 <font class="keywordtype">void</font> recalcHeaders (); +00078 <font class="keyword">protected</font>: +00079 TMemoryStream * RTFStream; +00080 +00081 <font class="keyword">virtual</font> <font class="keywordtype">void</font> __fastcall Loaded (<font class="keywordtype">void</font>); +00082 <font class="keyword">public</font>: +00083 __fastcall SWDispRTF (TComponent * Owner); +00084 __fastcall ~ SWDispRTF (); +00085 +00086 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Display (<a class="code" href="class_s_w_module.html">SWModule</a> & imodule); +00087 __published:__property System::AnsiString RTFHeader = +00088 { +00089 read = FRTFHeader, write = FRTFHeader}; +00090 __property System::AnsiString RTFHeadMargin = { read = +00091 FRTFHeadMargin, write = FRTFHeadMargin }; +00092 __property System::AnsiString RTFChapterMarkPre = { read = +00093 FRTFChapterMarkPre, write = FRTFChapterMarkPre }; +00094 __property System::AnsiString RTFChapterMarkPost = { read = +00095 FRTFChapterMarkPost, write = FRTFChapterMarkPost }; +00096 __property System::AnsiString RTFVerseMarkPre = { read = +00097 FRTFVerseMarkPre, write = FRTFVerseMarkPre }; +00098 __property System::AnsiString RTFVerseMarkPost = { read = +00099 FRTFVerseMarkPost, write = FRTFVerseMarkPost }; +00100 __property System::AnsiString RTFVersePre = { read = FRTFVersePre, write = +00101 FRTFVersePre }; +00102 __property System::AnsiString RTFVersePost = { read = FRTFVersePost, write = +00103 FRTFVersePost }; +00104 __property System::AnsiString RTFTrailer = { read = FRTFTrailer, write = +00105 FRTFTrailer }; +00106 __property <font class="keywordtype">bool</font> ExpandNewLine = { read = FExpandNewLine, write = +00107 FExpandNewLine }; +00108 __property <font class="keywordtype">int</font> FontSize = { read = getFontSize, write = setFontSize }; +00109 }; +00110 +00111 <font class="comment">//---------------------------------------------------------------------------</font> +00112 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swdisprtf_h-source.html b/doc/api-documentation/html/swdisprtf_h-source.html new file mode 100644 index 0000000..50d071f --- /dev/null +++ b/doc/api-documentation/html/swdisprtf_h-source.html @@ -0,0 +1,128 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swdisprtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swdisprtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swdisprtf.h - definition of Class SWDispRTF-- an SWDisplay used to display</font> +00003 <font class="comment"> * a verse in Rich Text Format.</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swdisprtf_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="comment">//---------------------------------------------------------------------------</font> +00024 <font class="preprocessor">#ifndef SWDispRTFH</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define SWDispRTFH</font> +00026 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00027 <font class="preprocessor">#include <vcl\SysUtils.hpp></font> +00028 <font class="preprocessor">#include <vcl\Controls.hpp></font> +00029 <font class="preprocessor">#include <vcl\Classes.hpp></font> +00030 <font class="preprocessor">#include <vcl\Forms.hpp></font> +00031 <font class="preprocessor">#include <vcl\ComCtrls.hpp></font> +00032 <font class="preprocessor">#include <vcl\StdCtrls.hpp></font> +00033 <font class="preprocessor">#include <swtext.h></font> +00034 <font class="preprocessor">#ifndef USEOLDRTF</font> +00035 <font class="preprocessor"></font><font class="preprocessor">#include <RxRichEdit.hpp></font> +00036 <font class="preprocessor">#endif</font> +00037 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00038 +00039 <font class="preprocessor">#define defRTFHeader "{\\rtf1\\ansi{\\fonttbl{\\f0\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f1\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f2\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f3\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f4\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f7\\froman\\fcharset2\\fprq2 Symbol;}{\\f8\\froman\\fcharset2\\fprq2 Symbol;}}{\\colortbl;\\red0\\green0\\blue255;\\red0\\green200\\blue50;\\red0\\green0\\blue255;\\red0\\green200\\blue50;\\red0\\green0\\blue255;\\red255\\green0\\blue0;} "</font> +00040 <font class="preprocessor"></font><font class="preprocessor">#define defRTFHeadMargin "{\\fs8\\cf1\\par\\pard} "</font> +00041 <font class="preprocessor"></font><font class="preprocessor">#define defRTFTrailer "{\\fs%d \\par }}" // 24</font> +00042 <font class="preprocessor"></font> +00043 <font class="preprocessor">#define defRTFChapterMarkPre "\\pard \\qc\\nowidctlpar{\\f1\\cf7\\fs%d\\b Chapter " // 30</font> +00044 <font class="preprocessor"></font><font class="preprocessor">#define defRTFChapterMarkPost "\\par\\fs%d\\par}" // 10</font> +00045 <font class="preprocessor"></font> +00046 <font class="preprocessor">#define defRTFVerseMarkPre "{\\fs%d\\cf1\\super " //20</font> +00047 <font class="preprocessor"></font><font class="preprocessor">#define defRTFVerseMarkPost "}"</font> +00048 <font class="preprocessor"></font> +00049 <font class="preprocessor">#define defRTFVersePre "{\\fs%d" // 24</font> +00050 <font class="preprocessor"></font><font class="preprocessor">#define defRTFVersePost " }"</font> +00051 <font class="preprocessor"></font> +00052 <font class="preprocessor">#ifndef USEOLDRTF</font> +00053 <font class="preprocessor"></font><font class="keyword">class </font>SWDispRTF:<font class="keyword">public</font> TRxRichEdit +00054 #else +00055 class SWDispRTF:<font class="keyword">public</font> TRichEdit +00056 #endif +00057 { +00058 <font class="keyword">protected</font>: +00059 +00060 System::AnsiString FRTFHeader; +00061 System::AnsiString FRTFHeadMargin; +00062 System::AnsiString FRTFTrailer; +00063 System::AnsiString FRTFChapterMarkPre; +00064 System::AnsiString FRTFChapterMarkPost; +00065 System::AnsiString FRTFVerseMarkPre; +00066 System::AnsiString FRTFVerseMarkPost; +00067 System::AnsiString FRTFVersePre; +00068 System::AnsiString FRTFVersePost; +00069 <font class="keywordtype">bool</font> FExpandNewLine; +00070 CHARRANGE FCharRange; +00071 <font class="keywordtype">int</font> fontSize; +00072 +00073 <font class="keywordtype">int</font> __fastcall GetMySelStart (); +00074 <font class="keywordtype">void</font> __fastcall SetMySelStart (<font class="keywordtype">int</font> iselstart); +00075 <font class="keywordtype">int</font> __fastcall getFontSize (); +00076 <font class="keywordtype">void</font> __fastcall setFontSize (<font class="keywordtype">int</font> iFontSize); +00077 <font class="keywordtype">void</font> recalcHeaders (); +00078 <font class="keyword">protected</font>: +00079 TMemoryStream * RTFStream; +00080 +00081 <font class="keyword">virtual</font> <font class="keywordtype">void</font> __fastcall Loaded (<font class="keywordtype">void</font>); +00082 <font class="keyword">public</font>: +00083 __fastcall SWDispRTF (TComponent * Owner); +00084 __fastcall ~ SWDispRTF (); +00085 +00086 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Display (<a class="code" href="class_swmodule.html">SWModule</a> & imodule); +00087 __published:__property System::AnsiString RTFHeader = +00088 { +00089 read = FRTFHeader, write = FRTFHeader}; +00090 __property System::AnsiString RTFHeadMargin = { read = +00091 FRTFHeadMargin, write = FRTFHeadMargin }; +00092 __property System::AnsiString RTFChapterMarkPre = { read = +00093 FRTFChapterMarkPre, write = FRTFChapterMarkPre }; +00094 __property System::AnsiString RTFChapterMarkPost = { read = +00095 FRTFChapterMarkPost, write = FRTFChapterMarkPost }; +00096 __property System::AnsiString RTFVerseMarkPre = { read = +00097 FRTFVerseMarkPre, write = FRTFVerseMarkPre }; +00098 __property System::AnsiString RTFVerseMarkPost = { read = +00099 FRTFVerseMarkPost, write = FRTFVerseMarkPost }; +00100 __property System::AnsiString RTFVersePre = { read = FRTFVersePre, write = +00101 FRTFVersePre }; +00102 __property System::AnsiString RTFVersePost = { read = FRTFVersePost, write = +00103 FRTFVersePost }; +00104 __property System::AnsiString RTFTrailer = { read = FRTFTrailer, write = +00105 FRTFTrailer }; +00106 __property <font class="keywordtype">bool</font> ExpandNewLine = { read = FExpandNewLine, write = +00107 FExpandNewLine }; +00108 __property <font class="keywordtype">int</font> FontSize = { read = getFontSize, write = setFontSize }; +00109 }; +00110 +00111 <font class="comment">//---------------------------------------------------------------------------</font> +00112 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swdisprtfchap.h-source.html b/doc/api-documentation/html/swdisprtfchap.h-source.html new file mode 100644 index 0000000..fca0211 --- /dev/null +++ b/doc/api-documentation/html/swdisprtfchap.h-source.html @@ -0,0 +1,79 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swdisprtfchap.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swdisprtfchap.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swdisprtfchap.h - definition of class SWDispRTFChap, an SWDisplay used to +</font>00003 <font class="comment"> * display an entire chapter in Rich Text Format +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swdisprtfchap.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="comment">//---------------------------------------------------------------------------</font> +00024 <font class="preprocessor">#ifndef swdisprtfchapH +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#define swdisprtfchapH +</font>00026 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00027 <font class="preprocessor">#include <vcl\SysUtils.hpp></font> +00028 <font class="preprocessor">#include <vcl\Controls.hpp></font> +00029 <font class="preprocessor">#include <vcl\Classes.hpp></font> +00030 <font class="preprocessor">#include <vcl\Forms.hpp></font> +00031 <font class="preprocessor">#include <vcl\ComCtrls.hpp></font> +00032 <font class="preprocessor">#include <vcl\StdCtrls.hpp></font> +00033 <font class="preprocessor">#include <swtext.h></font> +00034 <font class="preprocessor">#include <swdisprtf.h></font> +00035 <font class="comment">//---------------------------------------------------------------------------</font> +00036 +00037 <font class="keyword">class </font>SWDispRTFChap:<font class="keyword">public</font> SWDispRTF +00038 { +00039 <font class="keyword">protected</font>: +00040 +00041 <font class="keywordtype">bool</font> FCurVerseMrk; +00042 <font class="keywordtype">bool</font> FCurVersePos; +00043 <font class="keywordtype">bool</font> FMarkCurrentVerse; +00044 <font class="keywordtype">bool</font> FAutoPosition; +00045 +00046 <font class="keyword">virtual</font> <font class="keywordtype">void</font> __fastcall Loaded (<font class="keywordtype">void</font>); +00047 <font class="keyword">public</font>: +00048 __fastcall SWDispRTFChap (TComponent * Owner); +00049 __fastcall ~ SWDispRTFChap (); +00050 +00051 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Display (<a class="code" href="class_swmodule.html">SWModule</a> & imodule); +00052 __published:__property <font class="keywordtype">bool</font> CurVersePos = +00053 { +00054 read = FCurVersePos, write = FCurVersePos, <font class="keywordflow">default</font> = <font class="keyword">true</font>}; +00055 __property <font class="keywordtype">bool</font> CurVerseMrk = { read = FCurVerseMrk, write = +00056 FCurVerseMrk, <font class="keywordflow">default</font> = <font class="keyword">true</font> }; +00057 __property <font class="keywordtype">bool</font> MarkCurrentVerse = { read = FMarkCurrentVerse, write = +00058 FMarkCurrentVerse, <font class="keywordflow">default</font> = <font class="keyword">true</font> }; +00059 __property <font class="keywordtype">bool</font> AutoPosition = { read = FAutoPosition, write = +00060 FAutoPosition, <font class="keywordflow">default</font> = <font class="keyword">true</font> }; +00061 }; +00062 +00063 <font class="comment">//---------------------------------------------------------------------------</font> +00064 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swdisprtfchap_8h-source.html b/doc/api-documentation/html/swdisprtfchap_8h-source.html new file mode 100644 index 0000000..8a1ccfb --- /dev/null +++ b/doc/api-documentation/html/swdisprtfchap_8h-source.html @@ -0,0 +1,81 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swdisprtfchap.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swdisprtfchap.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swdisprtfchap.h - definition of class SWDispRTFChap, an SWDisplay used to</font> +00003 <font class="comment"> * display an entire chapter in Rich Text Format</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swdisprtfchap_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="comment">//---------------------------------------------------------------------------</font> +00024 <font class="preprocessor">#ifndef swdisprtfchapH</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define swdisprtfchapH</font> +00026 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00027 <font class="preprocessor">#include <vcl\SysUtils.hpp></font> +00028 <font class="preprocessor">#include <vcl\Controls.hpp></font> +00029 <font class="preprocessor">#include <vcl\Classes.hpp></font> +00030 <font class="preprocessor">#include <vcl\Forms.hpp></font> +00031 <font class="preprocessor">#include <vcl\ComCtrls.hpp></font> +00032 <font class="preprocessor">#include <vcl\StdCtrls.hpp></font> +00033 <font class="preprocessor">#include <swtext.h></font> +00034 <font class="preprocessor">#include <swdisprtf.h></font> +00035 <font class="comment">//---------------------------------------------------------------------------</font> +00036 +00037 <font class="keyword">class </font>SWDispRTFChap:<font class="keyword">public</font> SWDispRTF +00038 { +00039 <font class="keyword">protected</font>: +00040 +00041 <font class="keywordtype">bool</font> FCurVerseMrk; +00042 <font class="keywordtype">bool</font> FCurVersePos; +00043 <font class="keywordtype">bool</font> FMarkCurrentVerse; +00044 <font class="keywordtype">bool</font> FAutoPosition; +00045 +00046 <font class="keywordtype">char</font> platformID; +00047 +00048 <font class="keyword">virtual</font> <font class="keywordtype">void</font> __fastcall Loaded (<font class="keywordtype">void</font>); +00049 <font class="keyword">public</font>: +00050 __fastcall SWDispRTFChap (TComponent * Owner); +00051 __fastcall ~ SWDispRTFChap (); +00052 +00053 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Display (<a class="code" href="class_s_w_module.html">SWModule</a> & imodule); +00054 __published:__property <font class="keywordtype">bool</font> CurVersePos = +00055 { +00056 read = FCurVersePos, write = FCurVersePos, <font class="keywordflow">default</font> = <font class="keyword">true</font>}; +00057 __property <font class="keywordtype">bool</font> CurVerseMrk = { read = FCurVerseMrk, write = +00058 FCurVerseMrk, <font class="keywordflow">default</font> = <font class="keyword">true</font> }; +00059 __property <font class="keywordtype">bool</font> MarkCurrentVerse = { read = FMarkCurrentVerse, write = +00060 FMarkCurrentVerse, <font class="keywordflow">default</font> = <font class="keyword">true</font> }; +00061 __property <font class="keywordtype">bool</font> AutoPosition = { read = FAutoPosition, write = +00062 FAutoPosition, <font class="keywordflow">default</font> = <font class="keyword">true</font> }; +00063 }; +00064 +00065 <font class="comment">//---------------------------------------------------------------------------</font> +00066 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swdisprtfchap_h-source.html b/doc/api-documentation/html/swdisprtfchap_h-source.html new file mode 100644 index 0000000..8eef9cc --- /dev/null +++ b/doc/api-documentation/html/swdisprtfchap_h-source.html @@ -0,0 +1,80 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swdisprtfchap.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swdisprtfchap.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swdisprtfchap.h - definition of class SWDispRTFChap, an SWDisplay used to</font> +00003 <font class="comment"> * display an entire chapter in Rich Text Format</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swdisprtfchap_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="comment">//---------------------------------------------------------------------------</font> +00024 <font class="preprocessor">#ifndef swdisprtfchapH</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define swdisprtfchapH</font> +00026 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00027 <font class="preprocessor">#include <vcl\SysUtils.hpp></font> +00028 <font class="preprocessor">#include <vcl\Controls.hpp></font> +00029 <font class="preprocessor">#include <vcl\Classes.hpp></font> +00030 <font class="preprocessor">#include <vcl\Forms.hpp></font> +00031 <font class="preprocessor">#include <vcl\ComCtrls.hpp></font> +00032 <font class="preprocessor">#include <vcl\StdCtrls.hpp></font> +00033 <font class="preprocessor">#include <swtext.h></font> +00034 <font class="preprocessor">#include <swdisprtf.h></font> +00035 <font class="comment">//---------------------------------------------------------------------------</font> +00036 +00037 <font class="keyword">class </font>SWDispRTFChap:<font class="keyword">public</font> SWDispRTF +00038 { +00039 <font class="keyword">protected</font>: +00040 +00041 <font class="keywordtype">bool</font> FCurVerseMrk; +00042 <font class="keywordtype">bool</font> FCurVersePos; +00043 <font class="keywordtype">bool</font> FMarkCurrentVerse; +00044 <font class="keywordtype">bool</font> FAutoPosition; +00045 +00046 <font class="keyword">virtual</font> <font class="keywordtype">void</font> __fastcall Loaded (<font class="keywordtype">void</font>); +00047 <font class="keyword">public</font>: +00048 __fastcall SWDispRTFChap (TComponent * Owner); +00049 __fastcall ~ SWDispRTFChap (); +00050 +00051 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Display (<a class="code" href="class_swmodule.html">SWModule</a> & imodule); +00052 __published:__property <font class="keywordtype">bool</font> CurVersePos = +00053 { +00054 read = FCurVersePos, write = FCurVersePos, <font class="keywordflow">default</font> = <font class="keyword">true</font>}; +00055 __property <font class="keywordtype">bool</font> CurVerseMrk = { read = FCurVerseMrk, write = +00056 FCurVerseMrk, <font class="keywordflow">default</font> = <font class="keyword">true</font> }; +00057 __property <font class="keywordtype">bool</font> MarkCurrentVerse = { read = FMarkCurrentVerse, write = +00058 FMarkCurrentVerse, <font class="keywordflow">default</font> = <font class="keyword">true</font> }; +00059 __property <font class="keywordtype">bool</font> AutoPosition = { read = FAutoPosition, write = +00060 FAutoPosition, <font class="keywordflow">default</font> = <font class="keyword">true</font> }; +00061 }; +00062 +00063 <font class="comment">//---------------------------------------------------------------------------</font> +00064 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swencodingmgr_8h-source.html b/doc/api-documentation/html/swencodingmgr_8h-source.html new file mode 100644 index 0000000..351ce65 --- /dev/null +++ b/doc/api-documentation/html/swencodingmgr_8h-source.html @@ -0,0 +1,66 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swencodingmgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swencodingmgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swencodingmgr.h - definition of class SWEncodingMgr, subclass of</font> +00003 <font class="comment"> * used to transcode all module text to a requested</font> +00004 <font class="comment"> * markup.</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWENCODINGMGR_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define SWENCODINGMGR_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swmgr.h></font> +00026 +<a name="l00031"></a><a class="code" href="class_s_w_encoding_mgr.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a> : <font class="keyword">public</font> <a class="code" href="class_s_w_mgr.html">SWMgr</a> +00032 { +00033 <font class="keyword">protected</font>: +00034 <a class="code" href="class_s_w_filter.html">SWFilter</a> *latin1utf8; +00035 <a class="code" href="class_s_w_filter.html">SWFilter</a> *scsuutf8; +00036 <a class="code" href="class_s_w_filter.html">SWFilter</a> *targetenc; +00037 +00038 +00039 <font class="comment">/*</font> +00040 <font class="comment"> * current encoding value</font> +00041 <font class="comment"> */</font> +00042 <font class="keywordtype">char</font> encoding; +00043 +00044 <font class="keyword">public</font>: +00052 <a class="code" href="class_s_w_encoding_mgr.html#a0">SWEncodingMgr</a> (<a class="code" href="class_s_w_config.html">SWConfig</a> * iconfig = 0, <a class="code" href="class_s_w_config.html">SWConfig</a> * isysconfig = 0, <font class="keywordtype">bool</font> autoload = <font class="keyword">true</font>, <font class="keywordtype">char</font> encoding = ENC_UTF8); +00053 +00057 <a class="code" href="class_s_w_encoding_mgr.html#a1">~SWEncodingMgr</a>(); +00058 +00064 <font class="keywordtype">char</font> <a class="code" href="class_s_w_encoding_mgr.html#a2">Encoding</a>(<font class="keywordtype">char</font> enc); +00065 +00071 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_mgr.html#b11">AddRawFilters</a>(<a class="code" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section); +00072 +00078 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_mgr.html#b8">AddEncodingFilters</a>(<a class="code" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section); +00079 }; +00080 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Oct 30 16:04:45 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swfilter.h-source.html b/doc/api-documentation/html/swfilter.h-source.html new file mode 100644 index 0000000..ee74cc5 --- /dev/null +++ b/doc/api-documentation/html/swfilter.h-source.html @@ -0,0 +1,83 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swfilter.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swfilter.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swfilter.h - definition of class SWFilter used to filter text between +</font>00003 <font class="comment"> * different formats +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swfilter.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWFILTER_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define SWFILTER_H +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#include <string></font> +00026 <font class="preprocessor">#include <list></font> +00027 <font class="preprocessor">#include <swkey.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00034 <font class="keyword">typedef</font> std::list < std::string > OptionsList; +00035 +00036 +<a name="l00041"></a><a class="code" href="class_swfilter.html">00041</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swfilter.html">SWFilter</a> { +00042 <font class="keyword">public</font>: +00043 <font class="keyword">virtual</font> ~SWFilter()<font class="keyword"> </font>{} +00047 <font class="comment">// typedef std::list < std::string > OptionsList; +</font><a name="l00051"></a><a class="code" href="class_swfilter.html#a1">00051</a> <font class="comment"></font> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * <a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"> +</font>00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> 0; +00054 } +<a name="l00059"></a><a class="code" href="class_swfilter.html#a2">00059</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * <a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"> +</font>00060 <font class="keyword"> </font>{ +00061 <font class="keywordflow">return</font> 0; +00062 } +<a name="l00067"></a><a class="code" href="class_swfilter.html#a3">00067</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"> +</font>00068 <font class="keyword"> </font>{ +00069 OptionsList options; +00070 <font class="keywordflow">return</font> options; +00071 } +<a name="l00078"></a><a class="code" href="class_swfilter.html#a4">00078</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"> +</font>00079 <font class="keyword"> </font>{ +00080 } +00081 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * getOptionValue ()<font class="keyword"> +</font>00082 <font class="keyword"> </font>{ +00083 <font class="keywordflow">return</font> 0; +00084 } +<a name="l00091"></a><a class="code" href="class_swfilter.html#a6">00091</a> <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *)<font class="keyword"> +</font>00092 <font class="keyword"> </font>{ +00093 <font class="keywordflow">return</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(text, maxlen); +00094 } +<a name="l00100"></a><a class="code" href="class_swfilter.html#a7">00100</a> <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1)<font class="keyword"> +</font>00101 <font class="keyword"> </font>{ +00102 <font class="keywordflow">return</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(text, maxlen, 0); +00103 } +00104 }; +00105 +00106 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swfilter_8h-source.html b/doc/api-documentation/html/swfilter_8h-source.html new file mode 100644 index 0000000..d43b2be --- /dev/null +++ b/doc/api-documentation/html/swfilter_8h-source.html @@ -0,0 +1,85 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swfilter.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swfilter.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swfilter.h - definition of class SWFilter used to filter text between</font> +00003 <font class="comment"> * different formats</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swfilter_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWFILTER_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWFILTER_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#include <string></font> +00026 <font class="preprocessor">#include <list></font> +00027 <font class="preprocessor">#include <swkey.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00034 <font class="keyword">typedef</font> std::list < std::string > OptionsList; +00035 +00036 +00041 <font class="keyword">class </font><a class="code" href="class_s_w_module.html">SWModule</a>; +00042 +00043 <font class="keyword">class </font>SWDLLEXPORT SWFilter { +00044 <font class="keyword">public</font>: +00045 <font class="keyword">virtual</font> ~SWFilter()<font class="keyword"> </font>{} +00049 <font class="comment">// typedef std::list < std::string > OptionsList;</font> +00053 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * getOptionName ()<font class="keyword"></font> +00054 <font class="keyword"> </font>{ +00055 <font class="keywordflow">return</font> 0; +00056 } +00061 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * getOptionTip ()<font class="keyword"></font> +00062 <font class="keyword"> </font>{ +00063 <font class="keywordflow">return</font> 0; +00064 } +00069 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00070 <font class="keyword"> </font>{ +00071 OptionsList options; +00072 <font class="keywordflow">return</font> options; +00073 } +00080 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"></font> +00081 <font class="keyword"> </font>{ +00082 } +00083 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * getOptionValue ()<font class="keyword"></font> +00084 <font class="keyword"> </font>{ +00085 <font class="keywordflow">return</font> 0; +00086 } +00093 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0)<font class="keyword"></font> +00094 <font class="keyword"> </font>{ +00095 <font class="keywordflow">return</font> ProcessText(text, maxlen); +00096 } +00102 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1)<font class="keyword"></font> +00103 <font class="keyword"> </font>{ +00104 <font class="keywordflow">return</font> ProcessText(text, maxlen, 0); +00105 } +00106 }; +00107 +00108 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swfilter_h-source.html b/doc/api-documentation/html/swfilter_h-source.html new file mode 100644 index 0000000..fe40d39 --- /dev/null +++ b/doc/api-documentation/html/swfilter_h-source.html @@ -0,0 +1,84 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swfilter.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swfilter.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swfilter.h - definition of class SWFilter used to filter text between</font> +00003 <font class="comment"> * different formats</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swfilter_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWFILTER_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWFILTER_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#include <string></font> +00026 <font class="preprocessor">#include <list></font> +00027 <font class="preprocessor">#include <swkey.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00034 <font class="keyword">typedef</font> std::list < std::string > OptionsList; +00035 +00036 +<a name="l00041"></a><a class="code" href="class_swfilter.html">00041</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swfilter.html">SWFilter</a> { +00042 <font class="keyword">public</font>: +00043 <font class="keyword">virtual</font> ~SWFilter()<font class="keyword"> </font>{} +00047 <font class="comment">// typedef std::list < std::string > OptionsList;</font> +<a name="l00051"></a><a class="code" href="class_swfilter.html#a1">00051</a> <font class="comment"></font> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * <a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> 0; +00054 } +<a name="l00059"></a><a class="code" href="class_swfilter.html#a2">00059</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * <a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"></font> +00060 <font class="keyword"> </font>{ +00061 <font class="keywordflow">return</font> 0; +00062 } +<a name="l00067"></a><a class="code" href="class_swfilter.html#a3">00067</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"></font> +00068 <font class="keyword"> </font>{ +00069 OptionsList options; +00070 <font class="keywordflow">return</font> options; +00071 } +<a name="l00078"></a><a class="code" href="class_swfilter.html#a4">00078</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"></font> +00079 <font class="keyword"> </font>{ +00080 } +00081 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> * getOptionValue ()<font class="keyword"></font> +00082 <font class="keyword"> </font>{ +00083 <font class="keywordflow">return</font> 0; +00084 } +<a name="l00091"></a><a class="code" href="class_swfilter.html#a6">00091</a> <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *)<font class="keyword"></font> +00092 <font class="keyword"> </font>{ +00093 <font class="keywordflow">return</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(text, maxlen); +00094 } +<a name="l00100"></a><a class="code" href="class_swfilter.html#a7">00100</a> <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1)<font class="keyword"></font> +00101 <font class="keyword"> </font>{ +00102 <font class="keywordflow">return</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a>(text, maxlen, 0); +00103 } +00104 }; +00105 +00106 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swfiltermgr_8h-source.html b/doc/api-documentation/html/swfiltermgr_8h-source.html new file mode 100644 index 0000000..f346dd7 --- /dev/null +++ b/doc/api-documentation/html/swfiltermgr_8h-source.html @@ -0,0 +1,77 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swfiltermgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swfiltermgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swfiltermgr.h - definition of class SWFilterMgr used as an interface to</font> +00003 <font class="comment"> * manage filters on a module</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swfiltermgr_8h-source.html,v 1.2 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWFILTERMGR_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWFILTERMGR_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <sys/types.h></font> +00027 <font class="preprocessor">#include <swmodule.h></font> +00028 <font class="preprocessor">#include <swconfig.h></font> +00029 <font class="preprocessor">#include <swlog.h></font> +00030 +00031 <font class="preprocessor">#include <defs.h></font> +00032 +00033 <font class="keyword">class </font><a class="code" href="class_s_w_mgr.html">SWMgr</a>; +00034 +00035 +00036 <font class="keyword">class </font>SWDLLEXPORT SWFilterMgr { +00037 +00038 <font class="keyword">private</font>: +00039 <a class="code" href="class_s_w_mgr.html">SWMgr</a> *parentMgr; +00040 +00041 <font class="keyword">public</font>: +00042 SWFilterMgr (); +00043 <font class="keyword">virtual</font> ~SWFilterMgr (); +00044 +00045 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setParentMgr(<a class="code" href="class_s_w_mgr.html">SWMgr</a> *parentMgr); +00046 <font class="keyword">virtual</font> <a class="code" href="class_s_w_mgr.html">SWMgr</a> *getParentMgr(); +00047 +00048 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddGlobalOptions (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section, +00049 ConfigEntMap::iterator start, +00050 ConfigEntMap::iterator end); +00051 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddLocalOptions (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section, +00052 ConfigEntMap::iterator start, +00053 ConfigEntMap::iterator end); +00054 +00060 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddEncodingFilters (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section); +00066 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddRenderFilters (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section); +00072 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddStripFilters (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section); +00078 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddRawFilters (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section); +00079 +00080 }; +00081 +00082 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swkey.h-source.html b/doc/api-documentation/html/swkey.h-source.html new file mode 100644 index 0000000..4df3c7e --- /dev/null +++ b/doc/api-documentation/html/swkey.h-source.html @@ -0,0 +1,166 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swkey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swkey.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swkey.h - code for base class 'swkey'. swkey is the basis for all +</font>00003 <font class="comment"> * types of keys for indexing into modules (e.g. verse, word, +</font>00004 <font class="comment"> * place, etc.) +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * $Id: swkey.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00007 <font class="comment"> * +</font>00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00009 <font class="comment"> * CrossWire Bible Society +</font>00010 <font class="comment"> * P. O. Box 2528 +</font>00011 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00012 <font class="comment"> * +</font>00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00014 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00015 <font class="comment"> * Free Software Foundation version 2. +</font>00016 <font class="comment"> * +</font>00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00020 <font class="comment"> * General Public License for more details. +</font>00021 <font class="comment"> * +</font>00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef SWKEY_H +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#define SWKEY_H +</font>00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <swobject.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="preprocessor">#define KEYERR_OUTOFBOUNDS 1 +</font>00032 <font class="preprocessor"></font> +00033 <font class="comment">// For use with = operator to position key.</font> +00034 +00035 <font class="keyword">class </font>SW_POSITION +00036 { +00037 <font class="keywordtype">char</font> pos; +00038 <font class="keyword">public</font>: +00039 SW_POSITION (<font class="keywordtype">char</font> ipos)<font class="keyword"> +</font>00040 <font class="keyword"> </font>{ +00041 pos = ipos; +00042 } +00043 operator char ()<font class="keyword"> +</font>00044 <font class="keyword"> </font>{ +00045 <font class="keywordflow">return</font> pos; +00046 } +00047 }; +00048 +00049 <font class="preprocessor">#define POS_TOP ((char)1) +</font>00050 <font class="preprocessor"></font><font class="preprocessor">#define POS_BOTTOM ((char)2) +</font>00051 <font class="preprocessor"></font> +00052 <font class="preprocessor">#define TOP SW_POSITION(POS_TOP) +</font>00053 <font class="preprocessor"></font><font class="preprocessor">#define BOTTOM SW_POSITION(POS_BOTTOM) +</font>00054 <font class="preprocessor"></font> +<a name="l00059"></a><a class="code" href="class_swkey.html">00059</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swkey.html">SWKey</a>:<font class="keyword">public</font> SWObject +00060 { +00061 <font class="keywordtype">long</font> index; +00062 <font class="keyword">static</font> SWClass classdef; +00063 <font class="keywordtype">void</font> init (); +00064 +00065 <font class="keyword">protected</font>: +00066 <font class="keywordtype">char</font> *keytext; +00067 <font class="keywordtype">char</font> persist; +00068 <font class="keywordtype">char</font> error; +00069 +00070 <font class="keyword">public</font>: +00075 <a class="code" href="class_swkey.html#a0">SWKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00076 +00080 <a class="code" href="class_swkey.html#a0">SWKey</a> (<a class="code" href="class_swkey.html">SWKey</a> <font class="keyword">const</font> &k); +00081 +00084 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html#a2">~ SWKey</a> (); +00085 +00090 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swkey.html#a3">clone</a> () <font class="keyword">const</font>; +00091 +00098 <font class="keywordtype">char</font> <a class="code" href="class_swkey.html#a4">Persist</a> () <font class="keyword">const</font>; +00099 +00108 <font class="keywordtype">char</font> <a class="code" href="class_swkey.html#a4">Persist</a> (<font class="keywordtype">char</font> ikey); +00109 +00114 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swkey.html#a6">Error</a> (); +00115 +00120 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey); +00121 +00126 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey); +00127 +00130 <font class="keyword">virtual</font> operator const char *() <font class="keyword">const</font>; +00131 +00139 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_swkey.html#a10">compare</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey); +00140 +<a name="l00146"></a><a class="code" href="class_swkey.html#a11">00146</a> <font class="keyword">virtual</font> <font class="keywordtype">bool</font><a class="code" href="class_swkey.html#a11"> operator == </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> </font>{ <font class="keywordflow">return</font> !<a class="code" href="class_swkey.html#a10">compare</a> (ikey); +00147 } +00148 +<a name="l00154"></a><a class="code" href="class_swkey.html#a12">00154</a> <font class="keyword">virtual</font> <font class="keywordtype">bool</font><a class="code" href="class_swkey.html#a12"> operator != </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> +</font>00155 <font class="keyword"> </font>{ +00156 <font class="keywordflow">return</font> <a class="code" href="class_swkey.html#a10">compare</a> (ikey); +00157 } +00158 +<a name="l00162"></a><a class="code" href="class_swkey.html#a13">00162</a> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> operator > (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> +</font>00163 <font class="keyword"> </font>{ +00164 <font class="keywordflow">return</font> (<a class="code" href="class_swkey.html#a10">compare</a> (ikey) > 0); +00165 } +00166 +<a name="l00170"></a><a class="code" href="class_swkey.html#a14">00170</a> <font class="keyword">virtual</font> <font class="keywordtype">bool</font><a class="code" href="class_swkey.html#a14"> operator < </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> +</font>00171 <font class="keyword"> </font>{ +00172 <font class="keywordflow">return</font> (<a class="code" href="class_swkey.html#a10">compare</a> (ikey) < 0); +00173 } +00174 +<a name="l00178"></a><a class="code" href="class_swkey.html#a15">00178</a> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> operator >= (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> +</font>00179 <font class="keyword"> </font>{ +00180 <font class="keywordflow">return</font> (<a class="code" href="class_swkey.html#a10">compare</a> (ikey) > -1); +00181 } +00182 +<a name="l00186"></a><a class="code" href="class_swkey.html#a16">00186</a> <font class="keyword">virtual</font> <font class="keywordtype">bool</font><a class="code" href="class_swkey.html#a16"> operator <= </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> +</font>00187 <font class="keyword"> </font>{ +00188 <font class="keywordflow">return</font> (<a class="code" href="class_swkey.html#a10">compare</a> (ikey) < 1); +00189 } +00190 +00193 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(SW_POSITION); +00194 +00200 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a18"> operator -= </a>(<font class="keywordtype">int</font> decrement); +00201 +00207 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a19"> operator += </a>(<font class="keywordtype">int</font> increment); +00208 +<a name="l00213"></a><a class="code" href="class_swkey.html#a20">00213</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a20"> operator++ </a>(<font class="keywordtype">int</font>)<font class="keyword"> +</font>00214 <font class="keyword"> </font>{ +00215 <font class="keywordflow">return</font> *<font class="keyword">this</font> += 1; +00216 } +00217 +<a name="l00222"></a><a class="code" href="class_swkey.html#a21">00222</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a21"> operator-- </a>(<font class="keywordtype">int</font>)<font class="keyword"> +</font>00223 <font class="keyword"> </font>{ +00224 <font class="keywordflow">return</font> *<font class="keyword">this</font> -= 1; +00225 } +00226 +00227 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable ()<font class="keyword"> +</font>00228 <font class="keyword"> </font>{ +00229 <font class="keywordflow">return</font> 0; +00230 } +00231 +<a name="l00253"></a><a class="code" href="class_swkey.html#a23">00253</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a23">Index</a> ()<font class="keyword"> const +</font>00254 <font class="keyword"> </font>{ +00255 <font class="keywordflow">return</font> index; +00256 } +00257 +00258 <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a23">Index</a> (<font class="keywordtype">long</font> iindex)<font class="keyword"> +</font>00259 <font class="keyword"> </font>{ +00260 index = iindex; +00261 <font class="keywordflow">return</font> index; +00262 } +00263 }; +00264 +00265 +00266 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swkey_8h-source.html b/doc/api-documentation/html/swkey_8h-source.html new file mode 100644 index 0000000..b79508b --- /dev/null +++ b/doc/api-documentation/html/swkey_8h-source.html @@ -0,0 +1,140 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swkey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swkey.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swkey.h - code for base class 'swkey'. swkey is the basis for all</font> +00003 <font class="comment"> * types of keys for indexing into modules (e.g. verse, word,</font> +00004 <font class="comment"> * place, etc.)</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: swkey_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef SWKEY_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define SWKEY_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <swobject.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="preprocessor">#define KEYERR_OUTOFBOUNDS 1</font> +00032 <font class="preprocessor"></font> +00033 <font class="preprocessor">#define SWKEY_OPERATORS \</font> +00034 <font class="preprocessor"> SWKey & operator = (const char *ikey) { setText(ikey); return *this; } \</font> +00035 <font class="preprocessor"> SWKey & operator = (const SWKey &ikey) { copyFrom(ikey); return *this; } \</font> +00036 <font class="preprocessor"> SWKey & operator = (SW_POSITION pos) { setPosition(pos); return *this; } \</font> +00037 <font class="preprocessor"> operator const char *() const { return getText(); } \</font> +00038 <font class="preprocessor"> bool operator == (const SWKey & ikey) { return equals(ikey); } \</font> +00039 <font class="preprocessor"> bool operator != (const SWKey & ikey) { return !equals(ikey); } \</font> +00040 <font class="preprocessor"> virtual bool operator > (const SWKey & ikey) { return (compare (ikey) > 0); } \</font> +00041 <font class="preprocessor"> virtual bool operator < (const SWKey & ikey) { return (compare (ikey) < 0); } \</font> +00042 <font class="preprocessor"> virtual bool operator >= (const SWKey & ikey) { return (compare (ikey) > -1); } \</font> +00043 <font class="preprocessor"> virtual bool operator <= (const SWKey & ikey) { return (compare (ikey) < 1); } \</font> +00044 <font class="preprocessor"> SWKey & operator -= (int steps) { decrement(steps); return *this; } \</font> +00045 <font class="preprocessor"> SWKey & operator += (int steps) { increment(steps); return *this; } \</font> +00046 <font class="preprocessor"> SWKey & operator++ (int) { return *this += 1; } \</font> +00047 <font class="preprocessor"> SWKey & operator-- (int) { return *this -= 1; }</font> +00048 <font class="preprocessor"></font> +00049 +00050 <font class="comment">// For use with = operator to position key.</font> +00051 +00052 <font class="keyword">class </font>SW_POSITION +00053 { +00054 <font class="keywordtype">char</font> pos; +00055 <font class="keyword">public</font>: +00056 SW_POSITION (<font class="keywordtype">char</font> ipos)<font class="keyword"></font> +00057 <font class="keyword"> </font>{ +00058 pos = ipos; +00059 } +00060 operator char ()<font class="keyword"></font> +00061 <font class="keyword"> </font>{ +00062 <font class="keywordflow">return</font> pos; +00063 } +00064 }; +00065 +00066 <font class="preprocessor">#define POS_TOP ((char)1)</font> +00067 <font class="preprocessor"></font><font class="preprocessor">#define POS_BOTTOM ((char)2)</font> +00068 <font class="preprocessor"></font> +00069 <font class="preprocessor">#define TOP SW_POSITION(POS_TOP)</font> +00070 <font class="preprocessor"></font><font class="preprocessor">#define BOTTOM SW_POSITION(POS_BOTTOM)</font> +00071 <font class="preprocessor"></font> +<a name="l00076"></a><a class="code" href="class_s_w_key.html">00076</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_key.html">SWKey</a>:<font class="keyword">public</font> <a class="code" href="class_s_w_object.html">SWObject</a> +00077 { +00078 <font class="keywordtype">long</font> index; +00079 <font class="keyword">static</font> <a class="code" href="class_s_w_class.html">SWClass</a> classdef; +00080 <font class="keywordtype">void</font> init (); +00081 +00082 <font class="keyword">protected</font>: +00083 <font class="keywordtype">char</font> *keytext; +00084 <font class="keywordtype">char</font> persist; +00085 <font class="keywordtype">char</font> error; +00086 +00087 <font class="keyword">public</font>: +00092 <a class="code" href="class_s_w_key.html#a0">SWKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00093 +00097 <a class="code" href="class_s_w_key.html#a0">SWKey</a> (<a class="code" href="class_s_w_key.html">SWKey</a> <font class="keyword">const</font> &k); +00098 +00101 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html#a2">~ SWKey</a> (); +00102 +00107 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> *<a class="code" href="class_s_w_key.html#a3">clone</a> () <font class="keyword">const</font>; +00108 +00115 <font class="keywordtype">char</font> <a class="code" href="class_s_w_key.html#a4">Persist</a> () <font class="keyword">const</font>; +00116 +00125 <font class="keywordtype">char</font> <a class="code" href="class_s_w_key.html#a4">Persist</a> (<font class="keywordtype">char</font> ikey); +00126 +00131 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_key.html#a6">Error</a> (); +00132 +00137 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a7">setText</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey); +00138 +00143 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> &ikey); +00144 +00147 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_key.html#a9">getText</a>() <font class="keyword">const</font>; +00148 +00156 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_s_w_key.html#a10">compare</a> (<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> & ikey); +00157 +<a name="l00163"></a><a class="code" href="class_s_w_key.html#a11">00163</a> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_key.html#a11">equals</a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> &ikey)<font class="keyword"> </font>{ <font class="keywordflow">return</font> !<a class="code" href="class_s_w_key.html#a10">compare</a>(ikey); } +00164 +00165 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setPosition(SW_POSITION); +00166 +00172 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a13">decrement</a>(<font class="keywordtype">int</font> steps = 1); +00173 +00179 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a14">increment</a>(<font class="keywordtype">int</font> steps = 1); +00180 +00181 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable ()<font class="keyword"> </font>{ <font class="keywordflow">return</font> 0; } +00182 +<a name="l00204"></a><a class="code" href="class_s_w_key.html#a16">00204</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_s_w_key.html#a16">Index</a> ()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> index; } +00205 +00206 <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_s_w_key.html#a16">Index</a> (<font class="keywordtype">long</font> iindex)<font class="keyword"> </font>{ index = iindex; <font class="keywordflow">return</font> index; } +00207 +00208 SWKEY_OPERATORS +00209 +00210 }; +00211 +00212 +00213 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swkey_h-source.html b/doc/api-documentation/html/swkey_h-source.html new file mode 100644 index 0000000..827ce8e --- /dev/null +++ b/doc/api-documentation/html/swkey_h-source.html @@ -0,0 +1,141 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swkey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swkey.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swkey.h - code for base class 'swkey'. swkey is the basis for all</font> +00003 <font class="comment"> * types of keys for indexing into modules (e.g. verse, word,</font> +00004 <font class="comment"> * place, etc.)</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: swkey_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef SWKEY_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define SWKEY_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <swobject.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +00031 <font class="preprocessor">#define KEYERR_OUTOFBOUNDS 1</font> +00032 <font class="preprocessor"></font> +00033 <font class="preprocessor">#define SWKEY_OPERATORS \</font> +00034 <font class="preprocessor"> SWKey & operator = (const char *ikey) { setText(ikey); return *this; } \</font> +00035 <font class="preprocessor"> SWKey & operator = (const SWKey &ikey) { copyFrom(ikey); return *this; } \</font> +00036 <font class="preprocessor"> SWKey & operator = (SW_POSITION pos) { setPosition(pos); return *this; } \</font> +00037 <font class="preprocessor"> operator const char *() const { return getText(); } \</font> +00038 <font class="preprocessor"> bool operator == (const SWKey & ikey) { return equals(ikey); } \</font> +00039 <font class="preprocessor"> bool operator != (const SWKey & ikey) { return !equals(ikey); } \</font> +00040 <font class="preprocessor"> virtual bool operator > (const SWKey & ikey) { return (compare (ikey) > 0); } \</font> +00041 <font class="preprocessor"> virtual bool operator < (const SWKey & ikey) { return (compare (ikey) < 0); } \</font> +00042 <font class="preprocessor"> virtual bool operator >= (const SWKey & ikey) { return (compare (ikey) > -1); } \</font> +00043 <font class="preprocessor"> virtual bool operator <= (const SWKey & ikey) { return (compare (ikey) < 1); } \</font> +00044 <font class="preprocessor"> SWKey & operator -= (int steps) { decrement(steps); return *this; } \</font> +00045 <font class="preprocessor"> SWKey & operator += (int steps) { increment(steps); return *this; } \</font> +00046 <font class="preprocessor"> SWKey & operator++ (int) { return *this += 1; } \</font> +00047 <font class="preprocessor"> SWKey & operator-- (int) { return *this -= 1; }</font> +00048 <font class="preprocessor"></font> +00049 +00050 <font class="comment">// For use with = operator to position key.</font> +00051 +00052 <font class="keyword">class </font>SW_POSITION +00053 { +00054 <font class="keywordtype">char</font> pos; +00055 <font class="keyword">public</font>: +00056 SW_POSITION (<font class="keywordtype">char</font> ipos)<font class="keyword"></font> +00057 <font class="keyword"> </font>{ +00058 pos = ipos; +00059 } +00060 operator char ()<font class="keyword"></font> +00061 <font class="keyword"> </font>{ +00062 <font class="keywordflow">return</font> pos; +00063 } +00064 }; +00065 +00066 <font class="preprocessor">#define POS_TOP ((char)1)</font> +00067 <font class="preprocessor"></font><font class="preprocessor">#define POS_BOTTOM ((char)2)</font> +00068 <font class="preprocessor"></font> +00069 <font class="preprocessor">#define TOP SW_POSITION(POS_TOP)</font> +00070 <font class="preprocessor"></font><font class="preprocessor">#define BOTTOM SW_POSITION(POS_BOTTOM)</font> +00071 <font class="preprocessor"></font> +<a name="l00076"></a><a class="code" href="class_swkey.html">00076</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swkey.html">SWKey</a>:<font class="keyword">public</font> <a class="code" href="class_swobject.html">SWObject</a> +00077 { +00078 <font class="keywordtype">long</font> index; +00079 <font class="keyword">static</font> <a class="code" href="class_swclass.html">SWClass</a> classdef; +00080 <font class="keywordtype">void</font> init (); +00081 +00082 <font class="keyword">protected</font>: +00083 <font class="keywordtype">char</font> *keytext; +00084 <font class="keywordtype">char</font> persist; +00085 <font class="keywordtype">char</font> error; +00086 +00087 <font class="keyword">public</font>: +00092 <a class="code" href="class_swkey.html#a0">SWKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00093 +00097 <a class="code" href="class_swkey.html#a0">SWKey</a> (<a class="code" href="class_swkey.html">SWKey</a> <font class="keyword">const</font> &k); +00098 +00101 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html#a2">~ SWKey</a> (); +00102 +00107 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swkey.html#a3">clone</a> () <font class="keyword">const</font>; +00108 +00115 <font class="keywordtype">char</font> <a class="code" href="class_swkey.html#a4">Persist</a> () <font class="keyword">const</font>; +00116 +00125 <font class="keywordtype">char</font> <a class="code" href="class_swkey.html#a4">Persist</a> (<font class="keywordtype">char</font> ikey); +00126 +00131 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swkey.html#a6">Error</a> (); +00132 +00137 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a7">setText</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey); +00138 +00143 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> &ikey); +00144 +00147 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swkey.html#a9">getText</a>() <font class="keyword">const</font>; +00148 +00156 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_swkey.html#a10">compare</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey); +00157 +<a name="l00163"></a><a class="code" href="class_swkey.html#a11">00163</a> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swkey.html#a11">equals</a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> &ikey)<font class="keyword"> </font>{ <font class="keywordflow">return</font> !<a class="code" href="class_swkey.html#a10">compare</a>(ikey); } +00164 +00165 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setPosition(SW_POSITION); +00166 +00172 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a13">decrement</a>(<font class="keywordtype">int</font> steps = 1); +00173 +00179 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a14">increment</a>(<font class="keywordtype">int</font> steps = 1); +00180 +00181 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable ()<font class="keyword"> </font>{ <font class="keywordflow">return</font> 0; } +00182 +<a name="l00204"></a><a class="code" href="class_swkey.html#a16">00204</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a16">Index</a> ()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> index; } +00205 +00206 <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a16">Index</a> (<font class="keywordtype">long</font> iindex)<font class="keyword"> </font>{ index = iindex; <font class="keywordflow">return</font> index; } +00207 +00208 SWKEY_OPERATORS +00209 +00210 }; +00211 +00212 +00213 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swld.h-source.html b/doc/api-documentation/html/swld.h-source.html new file mode 100644 index 0000000..c60283b --- /dev/null +++ b/doc/api-documentation/html/swld.h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swld.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swld.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swld.h - code for base class 'SWLD'. SWLD is the basis for all +</font>00003 <font class="comment"> * types of Lexicon and Dictionary modules (hence the 'LD'). +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swld.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWLD_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define SWLD_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swmodule.h></font> +00027 <font class="preprocessor">#include <strkey.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00034"></a><a class="code" href="class_swld.html">00034</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swld.html">SWLD</a>:<font class="keyword">public</font> <a class="code" href="class_swmodule.html">SWModule</a> +00035 { +00036 <font class="keyword">protected</font>: +00037 <font class="keywordtype">char</font> *entkeytxt; +00038 <font class="keyword">public</font>: +00045 <a class="code" href="class_swld.html#a0">SWLD</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00046 <font class="keyword">virtual</font> ~ SWLD (); +<a name="l00047"></a><a class="code" href="class_swld.html#a2">00047</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swmodule.html#a17">CreateKey</a> ()<font class="keyword"> +</font>00048 <font class="keyword"> </font>{ +00049 <font class="keywordflow">return</font> <font class="keyword">new</font> StrKey (); +00050 } +00057 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a7">KeyText</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikeytext); +00058 }; +00059 +00060 +00061 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swld_8h-source.html b/doc/api-documentation/html/swld_8h-source.html new file mode 100644 index 0000000..786b280 --- /dev/null +++ b/doc/api-documentation/html/swld_8h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swld.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swld.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swld.h - code for base class 'SWLD'. SWLD is the basis for all</font> +00003 <font class="comment"> * types of Lexicon and Dictionary modules (hence the 'LD').</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swld_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWLD_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWLD_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swmodule.h></font> +00027 <font class="preprocessor">#include <strkey.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00034"></a><a class="code" href="class_s_w_l_d.html">00034</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_l_d.html">SWLD</a>:<font class="keyword">public</font> <a class="code" href="class_s_w_module.html">SWModule</a> +00035 { +00036 <font class="keyword">protected</font>: +00037 <font class="keywordtype">char</font> *entkeytxt; +00038 <font class="keyword">public</font>: +00045 <a class="code" href="class_s_w_l_d.html#a0">SWLD</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); +00046 <font class="keyword">virtual</font> ~ SWLD (); +<a name="l00047"></a><a class="code" href="class_s_w_l_d.html#a2">00047</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> *<a class="code" href="class_s_w_module.html#a23">CreateKey</a> ()<font class="keyword"></font> +00048 <font class="keyword"> </font>{ +00049 <font class="keywordflow">return</font> <font class="keyword">new</font> StrKey (); +00050 } +00057 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a9">KeyText</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikeytext); +00058 }; +00059 +00060 +00061 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swld_h-source.html b/doc/api-documentation/html/swld_h-source.html new file mode 100644 index 0000000..4da57f7 --- /dev/null +++ b/doc/api-documentation/html/swld_h-source.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swld.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swld.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swld.h - code for base class 'SWLD'. SWLD is the basis for all</font> +00003 <font class="comment"> * types of Lexicon and Dictionary modules (hence the 'LD').</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swld_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWLD_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWLD_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swmodule.h></font> +00027 <font class="preprocessor">#include <strkey.h></font> +00028 +00029 <font class="preprocessor">#include <defs.h></font> +00030 +<a name="l00034"></a><a class="code" href="class_swld.html">00034</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swld.html">SWLD</a>:<font class="keyword">public</font> <a class="code" href="class_swmodule.html">SWModule</a> +00035 { +00036 <font class="keyword">protected</font>: +00037 <font class="keywordtype">char</font> *entkeytxt; +00038 <font class="keyword">public</font>: +00045 <a class="code" href="class_swld.html#a0">SWLD</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00046 <font class="keyword">virtual</font> ~ SWLD (); +<a name="l00047"></a><a class="code" href="class_swld.html#a2">00047</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swmodule.html#a19">CreateKey</a> ()<font class="keyword"></font> +00048 <font class="keyword"> </font>{ +00049 <font class="keywordflow">return</font> <font class="keyword">new</font> StrKey (); +00050 } +00057 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a9">KeyText</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikeytext); +00058 }; +00059 +00060 +00061 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swlocale.h-source.html b/doc/api-documentation/html/swlocale.h-source.html new file mode 100644 index 0000000..020bc64 --- /dev/null +++ b/doc/api-documentation/html/swlocale.h-source.html @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swlocale.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swlocale.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swlocale.h - definition of Class SWLocale used for retrieval +</font>00003 <font class="comment"> * of locale lookups +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swlocale.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 2000 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWLOCALE_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define SWLOCALE_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <string></font> +00027 <font class="preprocessor">#include <map></font> +00028 +00029 <font class="preprocessor">#include <swconfig.h></font> +00030 <font class="preprocessor">#include <versekey.h></font> +00031 +00032 <font class="preprocessor">#include <defs.h></font> +00033 +00034 <font class="keyword">using</font> <font class="keyword">namespace</font> std; +00035 +00036 <font class="keyword">typedef</font> map < string, string, less < string > >LookupMap; +00037 +<a name="l00044"></a><a class="code" href="class_swlocale.html">00044</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swlocale.html">SWLocale</a> +00045 { +00046 LookupMap lookupTable; +00047 <a class="code" href="class_swconfig.html">SWConfig</a> *localeSource; +00048 <font class="keywordtype">char</font> *name; +00049 <font class="keywordtype">char</font> *description; +00050 <font class="keyword">struct </font>abbrev *bookAbbrevs; +00051 <font class="keywordtype">char</font> *BMAX; +00052 <font class="keyword">struct </font>sbook **books; +00053 +00054 <font class="keyword">public</font>: +00055 SWLocale (<font class="keyword">const</font> <font class="keywordtype">char</font> *ifilename); +00056 <font class="keyword">virtual</font> ~ SWLocale (); +00057 +00062 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swlocale.html#a2">getName</a> (); +00066 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swlocale.html#a3">getDescription</a> (); +00067 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *translate (<font class="keyword">const</font> <font class="keywordtype">char</font> *text); +00068 <font class="keyword">virtual</font> <a class="code" href="class_swlocale.html">SWLocale</a> & operator += (<a class="code" href="class_swlocale.html">SWLocale</a> & addFrom); +00069 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keyword">struct </font>abbrev *getBookAbbrevs (); +00070 <font class="keyword">virtual</font> <font class="keywordtype">void</font> getBooks (<font class="keywordtype">char</font> **iBMAX, <font class="keyword">struct</font> sbook ***ibooks); +00071 }; +00072 +00073 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swlocale_8h-source.html b/doc/api-documentation/html/swlocale_8h-source.html new file mode 100644 index 0000000..f757865 --- /dev/null +++ b/doc/api-documentation/html/swlocale_8h-source.html @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swlocale.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swlocale.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swlocale.h - definition of Class SWLocale used for retrieval</font> +00003 <font class="comment"> * of locale lookups</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swlocale_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 2000 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWLOCALE_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWLOCALE_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <string></font> +00027 <font class="preprocessor">#include <map></font> +00028 +00029 <font class="preprocessor">#include <swconfig.h></font> +00030 <font class="preprocessor">#include <versekey.h></font> +00031 +00032 <font class="preprocessor">#include <defs.h></font> +00033 +00034 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00035 +00036 <font class="keyword">typedef</font> map < string, string, less < string > >LookupMap; +00037 +<a name="l00044"></a><a class="code" href="class_s_w_locale.html">00044</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_locale.html">SWLocale</a> +00045 { +00046 LookupMap lookupTable; +00047 <a class="code" href="class_s_w_config.html">SWConfig</a> *localeSource; +00048 <font class="keywordtype">char</font> *name; +00049 <font class="keywordtype">char</font> *description; +00050 <font class="keyword">struct </font>abbrev *bookAbbrevs; +00051 <font class="keywordtype">char</font> *BMAX; +00052 <font class="keyword">struct </font>sbook **books; +00053 +00054 <font class="keyword">public</font>: +00055 SWLocale (<font class="keyword">const</font> <font class="keywordtype">char</font> *ifilename); +00056 <font class="keyword">virtual</font> ~ SWLocale (); +00057 +00062 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_locale.html#a2">getName</a> (); +00066 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_locale.html#a3">getDescription</a> (); +00067 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *translate (<font class="keyword">const</font> <font class="keywordtype">char</font> *text); +00068 <font class="keyword">virtual</font> <a class="code" href="class_s_w_locale.html">SWLocale</a> & operator += (<a class="code" href="class_s_w_locale.html">SWLocale</a> & addFrom); +00069 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keyword">struct </font>abbrev *getBookAbbrevs (); +00070 <font class="keyword">virtual</font> <font class="keywordtype">void</font> getBooks (<font class="keywordtype">char</font> **iBMAX, <font class="keyword">struct</font> sbook ***ibooks); +00071 }; +00072 +00073 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swlocale_h-source.html b/doc/api-documentation/html/swlocale_h-source.html new file mode 100644 index 0000000..e25b3f7 --- /dev/null +++ b/doc/api-documentation/html/swlocale_h-source.html @@ -0,0 +1,76 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swlocale.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swlocale.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swlocale.h - definition of Class SWLocale used for retrieval</font> +00003 <font class="comment"> * of locale lookups</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swlocale_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 2000 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWLOCALE_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWLOCALE_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <string></font> +00027 <font class="preprocessor">#include <map></font> +00028 +00029 <font class="preprocessor">#include <swconfig.h></font> +00030 <font class="preprocessor">#include <versekey.h></font> +00031 +00032 <font class="preprocessor">#include <defs.h></font> +00033 +00034 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00035 +00036 <font class="keyword">typedef</font> map < string, string, less < string > >LookupMap; +00037 +<a name="l00044"></a><a class="code" href="class_swlocale.html">00044</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swlocale.html">SWLocale</a> +00045 { +00046 LookupMap lookupTable; +00047 <a class="code" href="class_swconfig.html">SWConfig</a> *localeSource; +00048 <font class="keywordtype">char</font> *name; +00049 <font class="keywordtype">char</font> *description; +00050 <font class="keyword">struct </font>abbrev *bookAbbrevs; +00051 <font class="keywordtype">char</font> *BMAX; +00052 <font class="keyword">struct </font>sbook **books; +00053 +00054 <font class="keyword">public</font>: +00055 SWLocale (<font class="keyword">const</font> <font class="keywordtype">char</font> *ifilename); +00056 <font class="keyword">virtual</font> ~ SWLocale (); +00057 +00062 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swlocale.html#a2">getName</a> (); +00066 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swlocale.html#a3">getDescription</a> (); +00067 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *translate (<font class="keyword">const</font> <font class="keywordtype">char</font> *text); +00068 <font class="keyword">virtual</font> <a class="code" href="class_swlocale.html">SWLocale</a> & operator += (<a class="code" href="class_swlocale.html">SWLocale</a> & addFrom); +00069 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keyword">struct </font>abbrev *getBookAbbrevs (); +00070 <font class="keyword">virtual</font> <font class="keywordtype">void</font> getBooks (<font class="keywordtype">char</font> **iBMAX, <font class="keyword">struct</font> sbook ***ibooks); +00071 }; +00072 +00073 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swlog.h-source.html b/doc/api-documentation/html/swlog.h-source.html new file mode 100644 index 0000000..0815c46 --- /dev/null +++ b/doc/api-documentation/html/swlog.h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swlog.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swlog.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swlog.h - definition of class SWLog used for logging messages +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: swlog.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 <font class="comment">//---------------------------------------------------------------------------</font> +00023 <font class="preprocessor">#ifndef swlogH +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define swlogH +</font>00025 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT SWLog +00030 { +00031 <font class="keyword">public</font>: +00032 <font class="keyword">static</font> SWLog *systemlog; +00033 +00034 <font class="keywordtype">bool</font> log; +00035 SWLog ()<font class="keyword"> +</font>00036 <font class="keyword"> </font>{ +00037 log = <font class="keyword">true</font>; +00038 } +00039 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogWarning (<font class="keywordtype">char</font> *fmt, ...); +00040 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogError (<font class="keywordtype">char</font> *fmt, ...); +00041 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogTimedInformation (<font class="keywordtype">char</font> *fmt, ...); +00042 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogInformation (<font class="keywordtype">char</font> *fmt, ...); +00043 }; +00044 +00045 +00046 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swlog_8h-source.html b/doc/api-documentation/html/swlog_8h-source.html new file mode 100644 index 0000000..e5102fa --- /dev/null +++ b/doc/api-documentation/html/swlog_8h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swlog.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swlog.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swlog.h - definition of class SWLog used for logging messages</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: swlog_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="comment">//---------------------------------------------------------------------------</font> +00023 <font class="preprocessor">#ifndef swlogH</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define swlogH</font> +00025 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT SWLog +00030 { +00031 <font class="keyword">public</font>: +00032 <font class="keyword">static</font> SWLog *systemlog; +00033 +00034 <font class="keywordtype">bool</font> log; +00035 SWLog ()<font class="keyword"></font> +00036 <font class="keyword"> </font>{ +00037 log = <font class="keyword">true</font>; +00038 } +00039 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogWarning (<font class="keywordtype">char</font> *fmt, ...); +00040 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogError (<font class="keywordtype">char</font> *fmt, ...); +00041 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogTimedInformation (<font class="keywordtype">char</font> *fmt, ...); +00042 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogInformation (<font class="keywordtype">char</font> *fmt, ...); +00043 }; +00044 +00045 +00046 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swlog_h-source.html b/doc/api-documentation/html/swlog_h-source.html new file mode 100644 index 0000000..3805f4c --- /dev/null +++ b/doc/api-documentation/html/swlog_h-source.html @@ -0,0 +1,62 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swlog.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swlog.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swlog.h - definition of class SWLog used for logging messages</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: swlog_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="comment">//---------------------------------------------------------------------------</font> +00023 <font class="preprocessor">#ifndef swlogH</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define swlogH</font> +00025 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT SWLog +00030 { +00031 <font class="keyword">public</font>: +00032 <font class="keyword">static</font> SWLog *systemlog; +00033 +00034 <font class="keywordtype">bool</font> log; +00035 SWLog ()<font class="keyword"></font> +00036 <font class="keyword"> </font>{ +00037 log = <font class="keyword">true</font>; +00038 } +00039 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogWarning (<font class="keywordtype">char</font> *fmt, ...); +00040 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogError (<font class="keywordtype">char</font> *fmt, ...); +00041 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogTimedInformation (<font class="keywordtype">char</font> *fmt, ...); +00042 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogInformation (<font class="keywordtype">char</font> *fmt, ...); +00043 }; +00044 +00045 +00046 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swmacs.h-source.html b/doc/api-documentation/html/swmacs.h-source.html new file mode 100644 index 0000000..2b2fe9d --- /dev/null +++ b/doc/api-documentation/html/swmacs.h-source.html @@ -0,0 +1,45 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swmacs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swmacs.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swmacs.h - generic macros +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: swmacs.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWMACS_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define SWMACS_H +</font>00024 <font class="preprocessor"></font> +00025 +00026 <font class="comment">// Maximum positive value of a signed numeric type</font> +00027 <font class="preprocessor">#define MAXPOS(x) ((x)((unsigned x)(1L << (sizeof(x)*8-1)) - 1)) +</font>00028 <font class="preprocessor"></font> +00029 +00030 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swmacs_8h-source.html b/doc/api-documentation/html/swmacs_8h-source.html new file mode 100644 index 0000000..dcbef31 --- /dev/null +++ b/doc/api-documentation/html/swmacs_8h-source.html @@ -0,0 +1,45 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swmacs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swmacs.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swmacs.h - generic macros</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: swmacs_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWMACS_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define SWMACS_H</font> +00024 <font class="preprocessor"></font> +00025 +00026 <font class="comment">// Maximum positive value of a signed numeric type</font> +00027 <font class="preprocessor">#define MAXPOS(x) ((x)((unsigned x)(1L << (sizeof(x)*8-1)) - 1))</font> +00028 <font class="preprocessor"></font> +00029 +00030 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swmacs_h-source.html b/doc/api-documentation/html/swmacs_h-source.html new file mode 100644 index 0000000..73accf6 --- /dev/null +++ b/doc/api-documentation/html/swmacs_h-source.html @@ -0,0 +1,46 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swmacs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swmacs.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swmacs.h - generic macros</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: swmacs_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWMACS_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define SWMACS_H</font> +00024 <font class="preprocessor"></font> +00025 +00026 <font class="comment">// Maximum positive value of a signed numeric type</font> +00027 <font class="preprocessor">#define MAXPOS(x) ((x)((unsigned x)(1L << (sizeof(x)*8-1)) - 1))</font> +00028 <font class="preprocessor"></font> +00029 +00030 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swmarkupmgr_8h-source.html b/doc/api-documentation/html/swmarkupmgr_8h-source.html new file mode 100644 index 0000000..1199316 --- /dev/null +++ b/doc/api-documentation/html/swmarkupmgr_8h-source.html @@ -0,0 +1,66 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swmarkupmgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swmarkupmgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swmarkupmgr.h - definition of class SWMarkupMgr, subclass of</font> +00003 <font class="comment"> * used to transcode all module text to a requested</font> +00004 <font class="comment"> * markup.</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWMARKUPMGR_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define SWMARKUPMGR_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swencodingmgr.h></font> +00026 +<a name="l00031"></a><a class="code" href="class_s_w_markup_mgr.html">00031</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_markup_mgr.html">SWMarkupMgr</a> : <font class="keyword">public</font> <a class="code" href="class_s_w_encoding_mgr.html">SWEncodingMgr</a> +00032 { +00033 <font class="keyword">protected</font>: +00034 <a class="code" href="class_s_w_filter.html">SWFilter</a>* fromthml; +00035 <a class="code" href="class_s_w_filter.html">SWFilter</a>* fromgbf; +00036 <a class="code" href="class_s_w_filter.html">SWFilter</a>* fromplain; +00037 <a class="code" href="class_s_w_filter.html">SWFilter</a>* fromosis; +00038 +00039 <font class="comment">/*</font> +00040 <font class="comment"> * current markup value</font> +00041 <font class="comment"> */</font> +00042 <font class="keywordtype">char</font> markup; +00043 +00044 <font class="keywordtype">void</font> CreateFilters(<font class="keywordtype">char</font> markup); +00045 <font class="keyword">public</font>: +00054 <a class="code" href="class_s_w_markup_mgr.html#a0">SWMarkupMgr</a> (<a class="code" href="class_s_w_config.html">SWConfig</a> * iconfig = 0, <a class="code" href="class_s_w_config.html">SWConfig</a> * isysconfig = 0, <font class="keywordtype">bool</font> autoload = <font class="keyword">true</font>, <font class="keywordtype">char</font> encoding = ENC_UTF8, <font class="keywordtype">char</font> markup = FMT_THML); +00055 +00059 <a class="code" href="class_s_w_markup_mgr.html#a1">~SWMarkupMgr</a>(); +00060 +00066 <font class="keywordtype">char</font> <a class="code" href="class_s_w_markup_mgr.html#a2">Markup</a>(<font class="keywordtype">char</font> m = FMT_UNKNOWN); +00067 +00073 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_mgr.html#b9">AddRenderFilters</a>(<a class="code" href="class_s_w_module.html">SWModule</a> *module, ConfigEntMap &section); +00074 }; +00075 +00076 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Oct 30 16:04:46 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swmgr.h-source.html b/doc/api-documentation/html/swmgr.h-source.html new file mode 100644 index 0000000..caac0bc --- /dev/null +++ b/doc/api-documentation/html/swmgr.h-source.html @@ -0,0 +1,106 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swmgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swmgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swmgr.h - definition of class SWMgr used to interact with an install +</font>00003 <font class="comment"> * base of sword modules. +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swmgr.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00036 <font class="preprocessor">#ifndef SWMGR_H +</font>00037 <font class="preprocessor"></font><font class="preprocessor">#define SWMGR_H +</font>00038 <font class="preprocessor"></font> +00039 <font class="preprocessor">#include <sys/types.h></font> +00040 <font class="preprocessor">#include <string></font> +00041 <font class="preprocessor">#include <map></font> +00042 <font class="preprocessor">#include <list></font> +00043 <font class="preprocessor">#include <swmodule.h></font> +00044 <font class="preprocessor">#include <swconfig.h></font> +00045 <font class="preprocessor">#include <swlog.h></font> +00046 +00047 <font class="preprocessor">#include <defs.h></font> +00048 +00049 <font class="comment">// using namespace std;</font> +00050 +00051 <font class="keyword">typedef</font> map < string, SWModule *, less < string > >ModMap; +00052 <font class="keyword">typedef</font> list < string > OptionsList; +00053 <font class="keyword">typedef</font> map < string, SWFilter * >FilterMap; +00054 +<a name="l00063"></a><a class="code" href="class_swmgr.html">00063</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swmgr.html">SWMgr</a> +00064 { +00065 <font class="keyword">protected</font>: +00066 <a class="code" href="class_swconfig.html">SWConfig</a> * myconfig; <font class="comment">//made protected because because BibleTime needs it</font> +00067 <a class="code" href="class_swconfig.html">SWConfig</a> *mysysconfig; +00068 <font class="keywordtype">void</font> CreateMods (); +00069 <a class="code" href="class_swmodule.html">SWModule</a> *CreateMod (string name, string driver, ConfigEntMap & section); +00070 <font class="keywordtype">void</font> DeleteMods (); +00071 <font class="keywordtype">char</font> configType; <font class="comment">// 0 = file; 1 = directory</font> +00072 FilterMap optionFilters; +00073 FilterMap cipherFilters; +00074 <a class="code" href="class_swfilter.html">SWFilter</a> *gbfplain; +00075 <a class="code" href="class_swfilter.html">SWFilter</a> *thmlplain; +00076 FilterList cleanupFilters; +00077 OptionsList options; +00078 <font class="keyword">virtual</font> <font class="keywordtype">void</font> init (); <font class="comment">// use to initialize before loading modules</font> +00079 <font class="keyword">virtual</font> <font class="keywordtype">char</font> AddModToConfig (<font class="keywordtype">int</font> conffd, <font class="keyword">const</font> <font class="keywordtype">char</font> *fname); +00080 <font class="keyword">virtual</font> <font class="keywordtype">void</font> loadConfigDir (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath); +00081 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddGlobalOptions (<a class="code" href="class_swmodule.html">SWModule</a> * module, ConfigEntMap & section, +00082 ConfigEntMap::iterator start, +00083 ConfigEntMap::iterator end); +00084 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddLocalOptions (<a class="code" href="class_swmodule.html">SWModule</a> * module, ConfigEntMap & section, +00085 ConfigEntMap::iterator start, +00086 ConfigEntMap::iterator end); +00092 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#b8">AddRenderFilters</a> (<a class="code" href="class_swmodule.html">SWModule</a> * module, ConfigEntMap & section); +00098 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#b9">AddStripFilters</a> (<a class="code" href="class_swmodule.html">SWModule</a> * module, ConfigEntMap & section); +00104 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#b10">AddRawFilters</a> (<a class="code" href="class_swmodule.html">SWModule</a> * module, ConfigEntMap & section); +00105 +00106 <font class="keyword">public</font>: +<a name="l00110"></a><a class="code" href="class_swmgr.html#p0">00110</a> <font class="keyword">static</font> <font class="keywordtype">bool</font> debug; +00114 <font class="keyword">static</font> <font class="keywordtype">void</font> findConfig (<font class="keywordtype">char</font> *configType, <font class="keywordtype">char</font> **prefixPath, +00115 <font class="keywordtype">char</font> **configPath); +<a name="l00122"></a><a class="code" href="class_swmgr.html#m0">00122</a> <a class="code" href="class_swconfig.html">SWConfig</a> *config; +00126 <a class="code" href="class_swconfig.html">SWConfig</a> *sysconfig; +<a name="l00130"></a><a class="code" href="class_swmgr.html#m2">00130</a> ModMap Modules; +<a name="l00134"></a><a class="code" href="class_swmgr.html#m3">00134</a> <font class="keywordtype">char</font> *prefixPath; +00138 <font class="keywordtype">char</font> *configPath; +00145 <a class="code" href="class_swmgr.html#a0">SWMgr</a> (<a class="code" href="class_swconfig.html">SWConfig</a> * iconfig = 0, <a class="code" href="class_swconfig.html">SWConfig</a> * isysconfig = 0, <font class="keywordtype">bool</font> autoload = <font class="keyword">true</font>); +00149 <a class="code" href="class_swmgr.html#a0">SWMgr</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *iConfigPath, <font class="keywordtype">bool</font> autoload = <font class="keyword">true</font>); +00155 <font class="keyword">virtual</font> <a class="code" href="class_swmgr.html#a2">~SWMgr</a> (); +00159 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#a3">InstallScan</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *dir); +00164 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#a4">Load</a> (); +00171 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#a5">setGlobalOption</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *option, <font class="keyword">const</font> <font class="keywordtype">char</font> *value); +00176 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmgr.html#a6">getGlobalOption</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *option); +00182 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmgr.html#a7">getGlobalOptionTip</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *option); +00186 <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swmgr.html#a8">getGlobalOptions</a> (); +00190 <font class="keyword">virtual</font> OptionsList getGlobalOptionValues (<font class="keyword">const</font> <font class="keywordtype">char</font> *option); +00232 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmgr.html#a10">setCipherKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *modName, <font class="keyword">const</font> <font class="keywordtype">char</font> *key); +00233 }; +00234 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swmgr_8h-source.html b/doc/api-documentation/html/swmgr_8h-source.html new file mode 100644 index 0000000..a9ff361 --- /dev/null +++ b/doc/api-documentation/html/swmgr_8h-source.html @@ -0,0 +1,116 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swmgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swmgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swmgr.h - definition of class SWMgr used to interact with an install</font> +00003 <font class="comment"> * base of sword modules.</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swmgr_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00039 <font class="preprocessor">#ifndef SWMGR_H</font> +00040 <font class="preprocessor"></font><font class="preprocessor">#define SWMGR_H</font> +00041 <font class="preprocessor"></font> +00042 <font class="preprocessor">#include <sys/types.h></font> +00043 <font class="preprocessor">#include <string></font> +00044 <font class="preprocessor">#include <map></font> +00045 <font class="preprocessor">#include <list></font> +00046 <font class="preprocessor">#include <swmodule.h></font> +00047 <font class="preprocessor">#include <swconfig.h></font> +00048 <font class="preprocessor">#include <swlog.h></font> +00049 <font class="preprocessor">#include <swfiltermgr.h></font> +00050 +00051 <font class="preprocessor">#include <defs.h></font> +00052 +00053 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00054 +00055 <font class="keyword">typedef</font> map < string, SWModule *, less < string > >ModMap; +00056 <font class="keyword">typedef</font> list < string > OptionsList; +00057 <font class="keyword">typedef</font> map < string, SWFilter * >FilterMap; +00058 +<a name="l00069"></a><a class="code" href="class_s_w_mgr.html">00069</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_mgr.html">SWMgr</a> { +00070 +00071 <font class="keyword">private</font>: +00072 <font class="keywordtype">void</font> commonInit(<a class="code" href="class_s_w_config.html">SWConfig</a> * iconfig, <a class="code" href="class_s_w_config.html">SWConfig</a> * isysconfig, <font class="keywordtype">bool</font> autoload, SWFilterMgr *filterMgr); +00073 +00074 <font class="keyword">protected</font>: +00075 SWFilterMgr *filterMgr; <font class="comment">//made protected because because BibleTime needs it</font> +00076 <a class="code" href="class_s_w_config.html">SWConfig</a> * myconfig; <font class="comment">//made protected because because BibleTime needs it</font> +00077 <a class="code" href="class_s_w_config.html">SWConfig</a> *mysysconfig; +00078 <font class="keywordtype">void</font> CreateMods (); +00079 <a class="code" href="class_s_w_module.html">SWModule</a> *CreateMod (string name, string driver, ConfigEntMap & section); +00080 <font class="keywordtype">void</font> DeleteMods (); +00081 <font class="keywordtype">char</font> configType; <font class="comment">// 0 = file; 1 = directory</font> +00082 FilterMap optionFilters; +00083 FilterMap cipherFilters; +00084 SWFilter *gbfplain; +00085 SWFilter *thmlplain; +00086 FilterList cleanupFilters; +00087 OptionsList options; +00088 <font class="keyword">virtual</font> <font class="keywordtype">void</font> init (); <font class="comment">// use to initialize before loading modules</font> +00089 <font class="keyword">virtual</font> <font class="keywordtype">char</font> AddModToConfig (<font class="keywordtype">int</font> conffd, <font class="keyword">const</font> <font class="keywordtype">char</font> *fname); +00090 <font class="keyword">virtual</font> <font class="keywordtype">void</font> loadConfigDir (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath); +00091 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddGlobalOptions (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section, +00092 ConfigEntMap::iterator start, +00093 ConfigEntMap::iterator end); +00094 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddLocalOptions (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section, +00095 ConfigEntMap::iterator start, +00096 ConfigEntMap::iterator end); +00097 +00103 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_mgr.html#b8">AddEncodingFilters</a> (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section); +00109 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_mgr.html#b9">AddRenderFilters</a> (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section); +00115 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_mgr.html#b10">AddStripFilters</a> (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section); +00121 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_mgr.html#b11">AddRawFilters</a> (<a class="code" href="class_s_w_module.html">SWModule</a> * module, ConfigEntMap & section); +00122 +00123 <font class="keyword">public</font>: +<a name="l00128"></a><a class="code" href="class_s_w_mgr.html#p0">00128</a> <font class="keyword">static</font> <font class="keywordtype">bool</font> debug; +00129 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *globalConfPath; +00133 <font class="keyword">static</font> <font class="keywordtype">void</font> findConfig (<font class="keywordtype">char</font> *configType, <font class="keywordtype">char</font> **prefixPath, +00134 <font class="keywordtype">char</font> **configPath); +<a name="l00143"></a><a class="code" href="class_s_w_mgr.html#m0">00143</a> <a class="code" href="class_s_w_config.html">SWConfig</a> *config; +00147 <a class="code" href="class_s_w_config.html">SWConfig</a> *sysconfig; +<a name="l00170"></a><a class="code" href="class_s_w_mgr.html#m2">00170</a> ModMap Modules; +<a name="l00174"></a><a class="code" href="class_s_w_mgr.html#m3">00174</a> <font class="keywordtype">char</font> *prefixPath; +00178 <font class="keywordtype">char</font> *configPath; +00179 +00187 <a class="code" href="class_s_w_mgr.html#a0">SWMgr</a> (<a class="code" href="class_s_w_config.html">SWConfig</a> * iconfig = 0, <a class="code" href="class_s_w_config.html">SWConfig</a> * isysconfig = 0, <font class="keywordtype">bool</font> autoload = <font class="keyword">true</font>, SWFilterMgr *filterMgr = 0); +00192 <a class="code" href="class_s_w_mgr.html#a0">SWMgr</a> (SWFilterMgr *filterMgr); +00202 <a class="code" href="class_s_w_mgr.html#a0">SWMgr</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *iConfigPath, <font class="keywordtype">bool</font> autoload = <font class="keyword">true</font>, SWFilterMgr *filterMgr = 0); +00208 <font class="keyword">virtual</font> <a class="code" href="class_s_w_mgr.html#a3">~SWMgr</a> (); +00212 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_mgr.html#a4">InstallScan</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *dir); +00217 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_mgr.html#a5">Load</a> (); +00225 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_mgr.html#a6">setGlobalOption</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *option, <font class="keyword">const</font> <font class="keywordtype">char</font> *value); +00230 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_mgr.html#a7">getGlobalOption</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *option); +00236 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_mgr.html#a8">getGlobalOptionTip</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *option); +00240 <font class="keyword">virtual</font> OptionsList <a class="code" href="class_s_w_mgr.html#a9">getGlobalOptions</a> (); +00244 <font class="keyword">virtual</font> OptionsList getGlobalOptionValues (<font class="keyword">const</font> <font class="keywordtype">char</font> *option); +00286 <font class="keyword">virtual</font> <font class="keywordtype">signed</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_mgr.html#a11">setCipherKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *modName, <font class="keyword">const</font> <font class="keywordtype">char</font> *key); +00287 }; +00288 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swmgr_h-source.html b/doc/api-documentation/html/swmgr_h-source.html new file mode 100644 index 0000000..28915b5 --- /dev/null +++ b/doc/api-documentation/html/swmgr_h-source.html @@ -0,0 +1,109 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swmgr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swmgr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swmgr.h - definition of class SWMgr used to interact with an install</font> +00003 <font class="comment"> * base of sword modules.</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swmgr_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00036 <font class="preprocessor">#ifndef SWMGR_H</font> +00037 <font class="preprocessor"></font><font class="preprocessor">#define SWMGR_H</font> +00038 <font class="preprocessor"></font> +00039 <font class="preprocessor">#include <sys/types.h></font> +00040 <font class="preprocessor">#include <string></font> +00041 <font class="preprocessor">#include <map></font> +00042 <font class="preprocessor">#include <list></font> +00043 <font class="preprocessor">#include <swmodule.h></font> +00044 <font class="preprocessor">#include <swconfig.h></font> +00045 <font class="preprocessor">#include <swlog.h></font> +00046 +00047 <font class="preprocessor">#include <defs.h></font> +00048 +00049 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00050 +00051 <font class="keyword">typedef</font> map < string, SWModule *, less < string > >ModMap; +00052 <font class="keyword">typedef</font> list < string > OptionsList; +00053 <font class="keyword">typedef</font> map < string, SWFilter * >FilterMap; +00054 +<a name="l00063"></a><a class="code" href="class_swmgr.html">00063</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swmgr.html">SWMgr</a> +00064 { +00065 <font class="keyword">protected</font>: +00066 <a class="code" href="class_swconfig.html">SWConfig</a> * myconfig; <font class="comment">//made protected because because BibleTime needs it</font> +00067 <a class="code" href="class_swconfig.html">SWConfig</a> *mysysconfig; +00068 <font class="keywordtype">void</font> CreateMods (); +00069 <a class="code" href="class_swmodule.html">SWModule</a> *CreateMod (string name, string driver, ConfigEntMap & section); +00070 <font class="keywordtype">void</font> DeleteMods (); +00071 <font class="keywordtype">char</font> configType; <font class="comment">// 0 = file; 1 = directory</font> +00072 FilterMap optionFilters; +00073 FilterMap cipherFilters; +00074 <a class="code" href="class_swfilter.html">SWFilter</a> *gbfplain; +00075 <a class="code" href="class_swfilter.html">SWFilter</a> *thmlplain; +00076 FilterList cleanupFilters; +00077 OptionsList options; +00078 <font class="keyword">virtual</font> <font class="keywordtype">void</font> init (); <font class="comment">// use to initialize before loading modules</font> +00079 <font class="keyword">virtual</font> <font class="keywordtype">char</font> AddModToConfig (<font class="keywordtype">int</font> conffd, <font class="keyword">const</font> <font class="keywordtype">char</font> *fname); +00080 <font class="keyword">virtual</font> <font class="keywordtype">void</font> loadConfigDir (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath); +00081 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddGlobalOptions (<a class="code" href="class_swmodule.html">SWModule</a> * module, ConfigEntMap & section, +00082 ConfigEntMap::iterator start, +00083 ConfigEntMap::iterator end); +00084 <font class="keyword">virtual</font> <font class="keywordtype">void</font> AddLocalOptions (<a class="code" href="class_swmodule.html">SWModule</a> * module, ConfigEntMap & section, +00085 ConfigEntMap::iterator start, +00086 ConfigEntMap::iterator end); +00092 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#b8">AddRenderFilters</a> (<a class="code" href="class_swmodule.html">SWModule</a> * module, ConfigEntMap & section); +00098 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#b9">AddStripFilters</a> (<a class="code" href="class_swmodule.html">SWModule</a> * module, ConfigEntMap & section); +00104 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#b10">AddRawFilters</a> (<a class="code" href="class_swmodule.html">SWModule</a> * module, ConfigEntMap & section); +00105 +00106 <font class="keyword">public</font>: +<a name="l00110"></a><a class="code" href="class_swmgr.html#p0">00110</a> <font class="keyword">static</font> <font class="keywordtype">bool</font> debug; +00114 <font class="keyword">static</font> <font class="keywordtype">void</font> findConfig (<font class="keywordtype">char</font> *configType, <font class="keywordtype">char</font> **prefixPath, +00115 <font class="keywordtype">char</font> **configPath); +<a name="l00122"></a><a class="code" href="class_swmgr.html#m0">00122</a> <a class="code" href="class_swconfig.html">SWConfig</a> *config; +00126 <a class="code" href="class_swconfig.html">SWConfig</a> *sysconfig; +<a name="l00130"></a><a class="code" href="class_swmgr.html#m2">00130</a> ModMap Modules; +<a name="l00134"></a><a class="code" href="class_swmgr.html#m3">00134</a> <font class="keywordtype">char</font> *prefixPath; +00138 <font class="keywordtype">char</font> *configPath; +00145 <a class="code" href="class_swmgr.html#a0">SWMgr</a> (<a class="code" href="class_swconfig.html">SWConfig</a> * iconfig = 0, <a class="code" href="class_swconfig.html">SWConfig</a> * isysconfig = 0, <font class="keywordtype">bool</font> autoload = <font class="keyword">true</font>); +00149 <a class="code" href="class_swmgr.html#a0">SWMgr</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *iConfigPath, <font class="keywordtype">bool</font> autoload = <font class="keyword">true</font>); +00155 <font class="keyword">virtual</font> <a class="code" href="class_swmgr.html#a2">~SWMgr</a> (); +00159 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#a3">InstallScan</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *dir); +00164 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#a4">Load</a> (); +00171 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmgr.html#a5">setGlobalOption</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *option, <font class="keyword">const</font> <font class="keywordtype">char</font> *value); +00176 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmgr.html#a6">getGlobalOption</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *option); +00182 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmgr.html#a7">getGlobalOptionTip</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *option); +00186 <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swmgr.html#a8">getGlobalOptions</a> (); +00190 <font class="keyword">virtual</font> OptionsList getGlobalOptionValues (<font class="keyword">const</font> <font class="keywordtype">char</font> *option); +00232 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmgr.html#a10">setCipherKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *modName, <font class="keyword">const</font> <font class="keywordtype">char</font> *key); +00233 +<a name="l00239"></a><a class="code" href="class_swmgr.html#a11">00239</a> <font class="keyword">const</font> <font class="keywordtype">float</font> <a class="code" href="class_swmgr.html#a11">Version</a>()<font class="keyword"> const </font>{<font class="keywordflow">return</font> 1.52;}; +00240 }; +00241 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swmodule.h-source.html b/doc/api-documentation/html/swmodule.h-source.html new file mode 100644 index 0000000..c031f05 --- /dev/null +++ b/doc/api-documentation/html/swmodule.h-source.html @@ -0,0 +1,246 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swmodule.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swmodule.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swmodule.h - code for base class 'module'. Module is the basis for all +</font>00003 <font class="comment"> * types of modules (e.g. texts, commentaries, maps, lexicons, +</font>00004 <font class="comment"> * etc.) +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * $Id: swmodule.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00007 <font class="comment"> * +</font>00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00009 <font class="comment"> * CrossWire Bible Society +</font>00010 <font class="comment"> * P. O. Box 2528 +</font>00011 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00012 <font class="comment"> * +</font>00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00014 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00015 <font class="comment"> * Free Software Foundation version 2. +</font>00016 <font class="comment"> * +</font>00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00020 <font class="comment"> * General Public License for more details. +</font>00021 <font class="comment"> * +</font>00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef SWMODULE_H +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#define SWMODULE_H +</font>00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <swdisp.h></font> +00028 <font class="preprocessor">#include <swkey.h></font> +00029 <font class="preprocessor">#include <listkey.h></font> +00030 <font class="preprocessor">#include <swfilter.h></font> +00031 <font class="preprocessor">#include <list></font> +00032 +00033 <font class="preprocessor">#include <defs.h></font> +00034 +00035 <font class="preprocessor">#define FILTERPAD 5 +</font>00036 <font class="preprocessor"></font> +00037 <font class="keyword">using</font> <font class="keyword">namespace</font> std; +00038 +00039 <font class="keyword">typedef</font> list < SWFilter * >FilterList; +00040 +00041 +<a name="l00047"></a><a class="code" href="class_swmodule.html">00047</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swmodule.html">SWModule</a> { +00048 +00049 <font class="keyword">protected</font>: +00050 +00051 <font class="keywordtype">char</font> error; +00052 +<a name="l00054"></a><a class="code" href="class_swmodule.html#n1">00054</a> <a class="code" href="class_swkey.html">SWKey</a> *key; +00055 +00056 <a class="code" href="class_listkey.html">ListKey</a> listkey; +00057 <font class="keywordtype">char</font> *modname; +00058 <font class="keywordtype">char</font> *moddesc; +00059 <font class="keywordtype">char</font> *modtype; +00060 +<a name="l00062"></a><a class="code" href="class_swmodule.html#n6">00062</a> <a class="code" href="class_swdisplay.html">SWDisplay</a> *disp; +00063 +00064 <font class="keyword">static</font> <a class="code" href="class_swdisplay.html">SWDisplay</a> rawdisp; +00065 <font class="keywordtype">char</font> *entrybuf; +00066 +<a name="l00068"></a><a class="code" href="class_swmodule.html#n8">00068</a> FilterList *stripFilters; +00069 +<a name="l00071"></a><a class="code" href="class_swmodule.html#n9">00071</a> FilterList *rawFilters; +00072 +<a name="l00074"></a><a class="code" href="class_swmodule.html#n10">00074</a> FilterList *renderFilters; +00075 +<a name="l00077"></a><a class="code" href="class_swmodule.html#n11">00077</a> FilterList *optionFilters; +00078 +00079 <font class="keywordtype">bool</font> render; +00080 +00081 <font class="keyword">public</font>: +00082 +00089 <font class="keyword">static</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#d0">nullPercent</a> (<font class="keywordtype">char</font> percent, <font class="keywordtype">void</font> *userData); +00090 +<a name="l00095"></a><a class="code" href="class_swmodule.html#m0">00095</a> <font class="keywordtype">bool</font> terminateSearch; +00096 +00109 <a class="code" href="class_swmodule.html#a0">SWModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">char</font> *imodtype = 0); +00110 +00113 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html#a1">~ SWModule</a> (); +00114 +00119 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a2">Error</a> (); +00120 +00127 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a3">SetKey</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *ikey); +00128 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a3">SetKey</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> &ikey); +00129 +<a name="l00133"></a><a class="code" href="class_swmodule.html#a5">00133</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> & <a class="code" href="class_swmodule.html#a5">Key</a> ()<font class="keyword"> const </font>{ +00134 <font class="keywordflow">return</font> *key; +00135 } +00136 +<a name="l00143"></a><a class="code" href="class_swmodule.html#a6">00143</a> <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a5">Key</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> </font>{ +00144 <font class="keywordflow">return</font> <a class="code" href="class_swmodule.html#a3">SetKey</a> (ikey); +00145 } +00146 +00153 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a7">KeyText</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodtype = 0); +00154 +00159 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a8">Display</a> (); +00160 +00167 <font class="keyword">virtual</font> <a class="code" href="class_swdisplay.html">SWDisplay</a> *<a class="code" href="class_swmodule.html#a9">Disp</a> (<a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00168 +00175 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a10">Name</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0); +00176 +00183 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a11">Description</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0); +00184 +00191 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a12">Type</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodtype = 0); +00192 +00193 <font class="comment">// search methods</font> +00194 +00206 <font class="keyword">virtual</font> <a class="code" href="class_listkey.html">ListKey</a> & <a class="code" href="class_swmodule.html#a13">Search</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType = 0, <font class="keywordtype">int</font> flags = 0, +00207 <a class="code" href="class_swkey.html">SWKey</a> * scope = 0, +00208 <font class="keywordtype">bool</font> * justCheckIfSupported = 0, +00209 <font class="keywordtype">void</font> (*percent) (<font class="keywordtype">char</font>, <font class="keywordtype">void</font> *) = &nullPercent, +00210 <font class="keywordtype">void</font> *percentUserData = 0); +00214 <font class="keyword">virtual</font> <font class="keywordtype">char</font> createSearchFramework ()<font class="keyword"> </font>{ +00215 <font class="keywordflow">return</font> 0; +00216 } <font class="comment">// special search framework</font> +00217 +00221 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> hasSearchFramework ()<font class="keyword"> </font>{ +00222 <font class="keywordflow">return</font> <font class="keyword">false</font>; +00223 } <font class="comment">// special search framework</font> +00224 +00228 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> isSearchOptimallySupported (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType, +00229 <font class="keywordtype">int</font> flags, <a class="code" href="class_swkey.html">SWKey</a> * scope)<font class="keyword"> </font>{ +00230 <font class="keywordtype">bool</font> retVal = <font class="keyword">false</font>; +00231 <a class="code" href="class_swmodule.html#a13">Search</a> (istr, searchType, flags, scope, &retVal); +00232 <font class="keywordflow">return</font> retVal; +00233 } +00234 +00239 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swmodule.html#a17">CreateKey</a> (); +00240 +00244 <font class="keyword">virtual</font> operator char *(); +00245 +00250 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a19">getRawEntry</a> () = 0; +00251 +00255 <font class="keyword">virtual</font> operator SWKey & ()<font class="keyword"> </font>{ +00256 <font class="keywordflow">return</font> *key; +00257 } +00258 +00262 <font class="keyword">virtual</font> operator SWKey *()<font class="keyword"> </font>{ +00263 <font class="keywordflow">return</font> key; +00264 } +00265 +00266 <font class="comment">// write interface ---------------------------- +</font><a name="l00270"></a><a class="code" href="class_swmodule.html#a22">00270</a> <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a22">isWritable</a> ()<font class="keyword"> </font>{ +00271 <font class="keywordflow">return</font> <font class="keyword">false</font>; +00272 } +00273 +<a name="l00278"></a><a class="code" href="class_swmodule.html#d1">00278</a> <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"> </font>{ +00279 <font class="keywordflow">return</font> -1; +00280 } +00281 +<a name="l00286"></a><a class="code" href="class_swmodule.html#a23">00286</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"> </font>{ +00287 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00288 } +00289 +<a name="l00294"></a><a class="code" href="class_swmodule.html#a24">00294</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *)<font class="keyword"> </font>{ +00295 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00296 } +00297 +<a name="l00301"></a><a class="code" href="class_swmodule.html#a25">00301</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a25">deleteEntry</a> ()<font class="keyword"> </font>{ +00302 } +00303 +00304 <font class="comment">// end write interface ------------------------</font> +00305 +00311 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a26"> operator -= </a>(<font class="keywordtype">int</font> decrement); +00312 +00318 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a27"> operator += </a>(<font class="keywordtype">int</font> increment); +00319 +<a name="l00323"></a><a class="code" href="class_swmodule.html#a28">00323</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a28"> operator++ </a>(<font class="keywordtype">int</font>)<font class="keyword"> </font>{ +00324 <font class="keywordflow">return</font> *<font class="keyword">this</font> += 1; +00325 } +00326 +<a name="l00330"></a><a class="code" href="class_swmodule.html#a29">00330</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a29"> operator-- </a>(<font class="keywordtype">int</font>)<font class="keyword"> </font>{ +00331 <font class="keywordflow">return</font> *<font class="keyword">this</font> -= 1; +00332 } +00333 +00339 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a30"> operator = </a>(SW_POSITION p); +00340 +<a name="l00345"></a><a class="code" href="class_swmodule.html#a31">00345</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a31">AddRenderFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{ +00346 renderFilters->push_back (newfilter); +00347 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00348 } +00349 +<a name="l00356"></a><a class="code" href="class_swmodule.html#a32">00356</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a32">renderFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{ +00357 <a class="code" href="class_swmodule.html#a36">filterBuffer</a>(renderFilters, buf, size, key); +00358 } +00359 +<a name="l00364"></a><a class="code" href="class_swmodule.html#a33">00364</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a33">AddStripFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{ +00365 stripFilters->push_back (newfilter); +00366 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00367 } +00368 +<a name="l00375"></a><a class="code" href="class_swmodule.html#a34">00375</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a34">stripFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{ +00376 <a class="code" href="class_swmodule.html#a36">filterBuffer</a>(stripFilters, buf, size, key); +00377 } +00378 +<a name="l00383"></a><a class="code" href="class_swmodule.html#a35">00383</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a35">AddRawFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{ +00384 rawFilters->push_back (newfilter); +00385 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00386 } +00387 +<a name="l00395"></a><a class="code" href="class_swmodule.html#a36">00395</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a36">filterBuffer</a> (FilterList *filters, <font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{ +00396 FilterList::iterator it; +00397 <font class="keywordflow">for</font> (it = filters->begin(); it != filters->end(); it++) { +00398 (*it)->ProcessText(buf, size, key); +00399 } +00400 } +00401 +<a name="l00408"></a><a class="code" href="class_swmodule.html#a37">00408</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a37">rawFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{ +00409 <a class="code" href="class_swmodule.html#a36">filterBuffer</a>(rawFilters, buf, size, key); +00410 } +00411 +<a name="l00416"></a><a class="code" href="class_swmodule.html#a38">00416</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a38">AddOptionFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{ +00417 optionFilters->push_back (newfilter); +00418 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00419 } +00420 +<a name="l00427"></a><a class="code" href="class_swmodule.html#a39">00427</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a39">optionFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{ +00428 <a class="code" href="class_swmodule.html#a36">filterBuffer</a>(optionFilters, buf, size, key); +00429 } +00430 +00438 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a40">StripText</a> (<font class="keywordtype">char</font> *buf = 0, <font class="keywordtype">int</font> len = -1); +00439 +00447 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a41">RenderText</a> (<font class="keywordtype">char</font> *buf = 0, <font class="keywordtype">int</font> len = -1); +00448 +00454 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a40">StripText</a> (<a class="code" href="class_swkey.html">SWKey</a> * tmpKey); +00455 +00461 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a41">RenderText</a> (<a class="code" href="class_swkey.html">SWKey</a> * tmpKey); +00462 +00463 }; +00464 +00465 +00466 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swmodule_8h-source.html b/doc/api-documentation/html/swmodule_8h-source.html new file mode 100644 index 0000000..61841d0 --- /dev/null +++ b/doc/api-documentation/html/swmodule_8h-source.html @@ -0,0 +1,257 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swmodule.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swmodule.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swmodule.h - code for base class 'module'. Module is the basis for all</font> +00003 <font class="comment"> * types of modules (e.g. texts, commentaries, maps, lexicons,</font> +00004 <font class="comment"> * etc.)</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: swmodule_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef SWMODULE_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define SWMODULE_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <swdisp.h></font> +00028 <font class="preprocessor">#include <swkey.h></font> +00029 <font class="preprocessor">#include <listkey.h></font> +00030 <font class="preprocessor">#include <swfilter.h></font> +00031 <font class="preprocessor">#include <list></font> +00032 +00033 <font class="preprocessor">#include <defs.h></font> +00034 +00035 <font class="preprocessor">#define FILTERPAD 80</font> +00036 <font class="preprocessor"></font> +00037 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00038 +00039 <font class="keyword">typedef</font> list < SWFilter * >FilterList; +00040 +00041 <font class="preprocessor">#define SWTextDirection char</font> +00042 <font class="preprocessor"></font><font class="preprocessor">#define SWTextEncoding char</font> +00043 <font class="preprocessor"></font><font class="preprocessor">#define SWTextMarkup char</font> +00044 <font class="preprocessor"></font> +00045 <font class="keyword">enum</font> {DIRECTION_LTR = 0, DIRECTION_RTL, DIRECTION_BIDI}; +00046 <font class="keyword">enum</font> {FMT_UNKNOWN = 0, FMT_PLAIN, FMT_THML, FMT_GBF, FMT_HTML, FMT_HTMLHREF, FMT_RTF, FMT_OSIS}; +00047 <font class="keyword">enum</font> {ENC_UNKNOWN = 0, ENC_LATIN1, ENC_UTF8, ENC_SCSU, ENC_UTF16, ENC_RTF, ENC_HTML}; +00048 +<a name="l00057"></a><a class="code" href="class_s_w_module.html">00057</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_module.html">SWModule</a> { +00058 +00059 <font class="keyword">protected</font>: +00060 +00061 <font class="keywordtype">char</font> error; +00062 +<a name="l00064"></a><a class="code" href="class_s_w_module.html#n1">00064</a> <a class="code" href="class_s_w_key.html">SWKey</a> *key; +00065 +00066 <a class="code" href="class_list_key.html">ListKey</a> listkey; +00067 <font class="keywordtype">char</font> *modname; +00068 <font class="keywordtype">char</font> *moddesc; +00069 <font class="keywordtype">char</font> *modtype; +00070 <font class="keywordtype">char</font> *modlang; +00071 +00072 <font class="keywordtype">char</font> direction; +00073 <font class="keywordtype">char</font> markup; +00074 <font class="keywordtype">char</font> encoding; +00075 +<a name="l00077"></a><a class="code" href="class_s_w_module.html#n10">00077</a> <a class="code" href="class_s_w_display.html">SWDisplay</a> *disp; +00078 +00079 <font class="keyword">static</font> <a class="code" href="class_s_w_display.html">SWDisplay</a> rawdisp; +00080 <font class="keywordtype">char</font> *entrybuf; +00081 +<a name="l00083"></a><a class="code" href="class_s_w_module.html#n12">00083</a> FilterList *stripFilters; +00084 +<a name="l00086"></a><a class="code" href="class_s_w_module.html#n13">00086</a> FilterList *rawFilters; +00087 +<a name="l00089"></a><a class="code" href="class_s_w_module.html#n14">00089</a> FilterList *renderFilters; +00090 +<a name="l00092"></a><a class="code" href="class_s_w_module.html#n15">00092</a> FilterList *optionFilters; +00093 +<a name="l00095"></a><a class="code" href="class_s_w_module.html#n16">00095</a> FilterList *encodingFilters; +00096 +00097 <font class="keywordtype">bool</font> render; +00098 <font class="keywordtype">int</font> entrySize; +00099 +00100 <font class="keyword">public</font>: +00107 <font class="keyword">static</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#d0">nullPercent</a> (<font class="keywordtype">char</font> percent, <font class="keywordtype">void</font> *userData); +<a name="l00112"></a><a class="code" href="class_s_w_module.html#m0">00112</a> <font class="keywordtype">bool</font> terminateSearch; +00125 <a class="code" href="class_s_w_module.html#a0">SWModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">char</font> *imodtype = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, <font class="keyword">const</font> <font class="keywordtype">char</font>* modlang = 0); +00128 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html#a1">~ SWModule</a> (); +00133 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#a2">Error</a> (); +<a name="l00137"></a><a class="code" href="class_s_w_module.html#a3">00137</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a3">isUnicode</a>()<font class="keyword"> const </font>{<font class="keywordflow">return</font> (encoding == ENC_UTF8 || encoding == ENC_SCSU);} +<a name="l00141"></a><a class="code" href="class_s_w_module.html#a4">00141</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">int</font> <a class="code" href="class_s_w_module.html#a4">getEntrySize</a>()<font class="keyword"> const </font>{<font class="keywordflow">return</font> entrySize;} +00149 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#a5">SetKey</a> (<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *ikey); +00155 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#a5">SetKey</a> (<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> &ikey); +<a name="l00159"></a><a class="code" href="class_s_w_module.html#a7">00159</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> & <a class="code" href="class_s_w_module.html#a7">Key</a> ()<font class="keyword"> const </font>{ +00160 <font class="keywordflow">return</font> *key; +00161 } +<a name="l00168"></a><a class="code" href="class_s_w_module.html#a8">00168</a> <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#a7">Key</a> (<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> & ikey)<font class="keyword"> </font>{ +00169 <font class="keywordflow">return</font> <a class="code" href="class_s_w_module.html#a5">SetKey</a> (ikey); +00170 } +00177 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a9">KeyText</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodtype = 0); +00182 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#a10">Display</a> (); +00189 <font class="keyword">virtual</font> <a class="code" href="class_s_w_display.html">SWDisplay</a> *<a class="code" href="class_s_w_module.html#a11">Disp</a> (<a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0); +00196 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a12">Name</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0); +00203 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a13">Description</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0); +00210 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a14">Type</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodtype = 0); +00217 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#a15">Direction</a>(<font class="keywordtype">signed</font> <font class="keywordtype">char</font> newdir = -1); +00224 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#a16">Encoding</a>(<font class="keywordtype">signed</font> <font class="keywordtype">char</font> enc = -1); +00231 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#a17">Markup</a>(<font class="keywordtype">signed</font> <font class="keywordtype">char</font> enc = -1); +00238 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a18">Lang</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodlang = 0); +00239 +00240 <font class="comment">// search methods</font> +00241 +00253 <font class="keyword">virtual</font> <a class="code" href="class_list_key.html">ListKey</a> & <a class="code" href="class_s_w_module.html#a19">Search</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType = 0, <font class="keywordtype">int</font> flags = 0, +00254 <a class="code" href="class_s_w_key.html">SWKey</a> * scope = 0, +00255 <font class="keywordtype">bool</font> * justCheckIfSupported = 0, +00256 <font class="keywordtype">void</font> (*percent) (<font class="keywordtype">char</font>, <font class="keywordtype">void</font> *) = &nullPercent, +00257 <font class="keywordtype">void</font> *percentUserData = 0); +00261 <font class="keyword">virtual</font> <font class="keywordtype">signed</font> <font class="keywordtype">char</font> createSearchFramework ()<font class="keyword"> </font>{ +00262 <font class="keywordflow">return</font> 0; +00263 } <font class="comment">// special search framework</font> +00267 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> hasSearchFramework ()<font class="keyword"> </font>{ +00268 <font class="keywordflow">return</font> <font class="keyword">false</font>; +00269 } <font class="comment">// special search framework</font> +<a name="l00274"></a><a class="code" href="class_s_w_module.html#a22">00274</a> <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a22">isSearchOptimallySupported</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType, +00275 <font class="keywordtype">int</font> flags, <a class="code" href="class_s_w_key.html">SWKey</a> * scope)<font class="keyword"> </font>{ +00276 <font class="keywordtype">bool</font> retVal = <font class="keyword">false</font>; +00277 <a class="code" href="class_s_w_module.html#a19">Search</a> (istr, searchType, flags, scope, &retVal); +00278 <font class="keywordflow">return</font> retVal; +00279 } +00286 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> *<a class="code" href="class_s_w_module.html#a23">CreateKey</a> (); +00290 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html#a24">operator char *</a>(); +00295 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a25">getRawEntry</a> () = 0; +<a name="l00301"></a><a class="code" href="class_s_w_module.html#a26">00301</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html#a26">operator SWKey & </a>()<font class="keyword"> </font>{ +00302 <font class="keywordflow">return</font> *key; +00303 } +<a name="l00312"></a><a class="code" href="class_s_w_module.html#a27">00312</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html#a27">operator SWKey *</a>()<font class="keyword"> </font>{ +00313 <font class="keywordflow">return</font> key; +00314 } +00315 +00316 +00317 <font class="comment">// write interface ----------------------------</font> +<a name="l00321"></a><a class="code" href="class_s_w_module.html#a28">00321</a> <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a28">isWritable</a> ()<font class="keyword"> </font>{ +00322 <font class="keywordflow">return</font> <font class="keyword">false</font>; +00323 } +<a name="l00328"></a><a class="code" href="class_s_w_module.html#d1">00328</a> <font class="keyword">static</font> <font class="keywordtype">signed</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"> </font>{ +00329 <font class="keywordflow">return</font> -1; +00330 } +<a name="l00335"></a><a class="code" href="class_s_w_module.html#a29">00335</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a29">setentry</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf, <font class="keywordtype">long</font> len)<font class="keyword"> </font>{ +00336 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00337 } +<a name="l00342"></a><a class="code" href="class_s_w_module.html#a30">00342</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"> </font>{ +00343 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00344 } +<a name="l00349"></a><a class="code" href="class_s_w_module.html#a31">00349</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *)<font class="keyword"> </font>{ +00350 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00351 } +<a name="l00355"></a><a class="code" href="class_s_w_module.html#a32">00355</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a32">deleteEntry</a> ()<font class="keyword"> </font>{ +00356 } +00357 <font class="comment">// end write interface ------------------------</font> +00358 +00364 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a33">operator -= </a>(<font class="keywordtype">int</font> decrement); +00370 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a34">operator += </a>(<font class="keywordtype">int</font> increment); +<a name="l00374"></a><a class="code" href="class_s_w_module.html#a35">00374</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a35">operator++ </a>(<font class="keywordtype">int</font>)<font class="keyword"> </font>{ +00375 <font class="keywordflow">return</font> *<font class="keyword">this</font> += 1; +00376 } +<a name="l00380"></a><a class="code" href="class_s_w_module.html#a36">00380</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a36">operator-- </a>(<font class="keywordtype">int</font>)<font class="keyword"> </font>{ +00381 <font class="keywordflow">return</font> *<font class="keyword">this</font> -= 1; +00382 } +00388 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a37">operator = </a>(SW_POSITION p); +<a name="l00393"></a><a class="code" href="class_s_w_module.html#a38">00393</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a38">AddRenderFilter</a> (SWFilter * newfilter)<font class="keyword"> </font>{ +00394 renderFilters->push_back (newfilter); +00395 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00396 } +<a name="l00401"></a><a class="code" href="class_s_w_module.html#a39">00401</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a39">RemoveRenderFilter</a> (SWFilter * oldfilter)<font class="keyword"> </font>{ +00402 renderFilters->remove (oldfilter); +00403 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00404 } +<a name="l00410"></a><a class="code" href="class_s_w_module.html#a40">00410</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a40">ReplaceRenderFilter</a> (SWFilter * oldfilter, SWFilter * newfilter)<font class="keyword"> </font>{ +00411 FilterList::iterator iter; +00412 <font class="keywordflow">for</font> (iter = renderFilters->begin(); iter != renderFilters->end(); iter++) +00413 <font class="keywordflow">if</font> (*iter == oldfilter) +00414 *iter = newfilter; +00415 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00416 } +<a name="l00423"></a><a class="code" href="class_s_w_module.html#a41">00423</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a41">renderFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_s_w_key.html">SWKey</a> *key)<font class="keyword"> </font>{ +00424 <a class="code" href="class_s_w_module.html#a49">filterBuffer</a>(renderFilters, buf, size, key); +00425 } +<a name="l00430"></a><a class="code" href="class_s_w_module.html#a42">00430</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a42">AddEncodingFilter</a> (SWFilter * newfilter)<font class="keyword"> </font>{ +00431 encodingFilters->push_back (newfilter); +00432 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00433 } +<a name="l00438"></a><a class="code" href="class_s_w_module.html#a43">00438</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a43">RemoveEncodingFilter</a> (SWFilter * oldfilter)<font class="keyword"> </font>{ +00439 encodingFilters->remove (oldfilter); +00440 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00441 } +<a name="l00447"></a><a class="code" href="class_s_w_module.html#a44">00447</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a44">ReplaceEncodingFilter</a> (SWFilter * oldfilter, SWFilter * newfilter)<font class="keyword"> </font>{ +00448 FilterList::iterator iter; +00449 <font class="keywordflow">for</font> (iter = encodingFilters->begin(); iter != encodingFilters->end(); iter++) +00450 <font class="keywordflow">if</font> (*iter == oldfilter) +00451 *iter = newfilter; +00452 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00453 } +<a name="l00460"></a><a class="code" href="class_s_w_module.html#a45">00460</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a45">encodingFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_s_w_key.html">SWKey</a> *key)<font class="keyword"> </font>{ +00461 <a class="code" href="class_s_w_module.html#a49">filterBuffer</a>(encodingFilters, buf, size, key); +00462 } +<a name="l00467"></a><a class="code" href="class_s_w_module.html#a46">00467</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a46">AddStripFilter</a> (SWFilter * newfilter)<font class="keyword"> </font>{ +00468 stripFilters->push_back (newfilter); +00469 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00470 } +<a name="l00477"></a><a class="code" href="class_s_w_module.html#a47">00477</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a47">stripFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_s_w_key.html">SWKey</a> *key)<font class="keyword"> </font>{ +00478 <a class="code" href="class_s_w_module.html#a49">filterBuffer</a>(stripFilters, buf, size, key); +00479 } +<a name="l00484"></a><a class="code" href="class_s_w_module.html#a48">00484</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a48">AddRawFilter</a> (SWFilter * newfilter)<font class="keyword"> </font>{ +00485 rawFilters->push_back (newfilter); +00486 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00487 } +<a name="l00495"></a><a class="code" href="class_s_w_module.html#a49">00495</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a49">filterBuffer</a> (FilterList *filters, <font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_s_w_key.html">SWKey</a> *key)<font class="keyword"> </font>{ +00496 FilterList::iterator it; +00497 <font class="keywordflow">for</font> (it = filters->begin(); it != filters->end(); it++) { +00498 (*it)->ProcessText(buf, size, key, <font class="keyword">this</font>); +00499 } +00500 } +<a name="l00507"></a><a class="code" href="class_s_w_module.html#a50">00507</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a50">rawFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_s_w_key.html">SWKey</a> *key)<font class="keyword"> </font>{ +00508 buf[size] = 0; +00509 <a class="code" href="class_s_w_module.html#a49">filterBuffer</a>(rawFilters, buf, size, key); +00510 } +<a name="l00515"></a><a class="code" href="class_s_w_module.html#a51">00515</a> <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a51">AddOptionFilter</a> (SWFilter * newfilter)<font class="keyword"> </font>{ +00516 optionFilters->push_back (newfilter); +00517 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00518 } +<a name="l00525"></a><a class="code" href="class_s_w_module.html#a52">00525</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a52">optionFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_s_w_key.html">SWKey</a> *key)<font class="keyword"> </font>{ +00526 <a class="code" href="class_s_w_module.html#a49">filterBuffer</a>(optionFilters, buf, size, key); +00527 } +00535 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a53">StripText</a> (<font class="keywordtype">char</font> *buf = 0, <font class="keywordtype">int</font> len = -1); +00543 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a54">RenderText</a> (<font class="keywordtype">char</font> *buf = 0, <font class="keywordtype">int</font> len = -1); +00549 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a53">StripText</a> (<a class="code" href="class_s_w_key.html">SWKey</a> * tmpKey); +00555 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a54">RenderText</a> (<a class="code" href="class_s_w_key.html">SWKey</a> * tmpKey); +00556 }; +00557 +00558 +00559 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swmodule_h-source.html b/doc/api-documentation/html/swmodule_h-source.html new file mode 100644 index 0000000..bfb5ed0 --- /dev/null +++ b/doc/api-documentation/html/swmodule_h-source.html @@ -0,0 +1,258 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swmodule.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swmodule.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swmodule.h - code for base class 'module'. Module is the basis for all</font> +00003 <font class="comment"> * types of modules (e.g. texts, commentaries, maps, lexicons,</font> +00004 <font class="comment"> * etc.)</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: swmodule_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef SWMODULE_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define SWMODULE_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <swdisp.h></font> +00028 <font class="preprocessor">#include <swkey.h></font> +00029 <font class="preprocessor">#include <listkey.h></font> +00030 <font class="preprocessor">#include <swfilter.h></font> +00031 <font class="preprocessor">#include <list></font> +00032 +00033 <font class="preprocessor">#include <defs.h></font> +00034 +00035 <font class="preprocessor">#define FILTERPAD 8</font> +00036 <font class="preprocessor"></font> +00037 <font class="keyword">using</font> <font class="keyword">namespace </font>std; +00038 +00039 <font class="keyword">typedef</font> list < SWFilter * >FilterList; +00040 +00041 +<a name="l00047"></a><a class="code" href="class_swmodule.html">00047</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swmodule.html">SWModule</a> { +00048 +00049 <font class="keyword">protected</font>: +00050 +00051 <font class="keywordtype">char</font> error; +00052 +<a name="l00054"></a><a class="code" href="class_swmodule.html#n1">00054</a> <a class="code" href="class_swkey.html">SWKey</a> *key; +00055 +00056 <a class="code" href="class_listkey.html">ListKey</a> listkey; +00057 <font class="keywordtype">char</font> *modname; +00058 <font class="keywordtype">char</font> *moddesc; +00059 <font class="keywordtype">char</font> *modtype; +00060 +<a name="l00062"></a><a class="code" href="class_swmodule.html#n6">00062</a> <a class="code" href="class_swdisplay.html">SWDisplay</a> *disp; +00063 +00064 <font class="keyword">static</font> <a class="code" href="class_swdisplay.html">SWDisplay</a> rawdisp; +00065 <font class="keywordtype">char</font> *entrybuf; +00066 +<a name="l00068"></a><a class="code" href="class_swmodule.html#n8">00068</a> FilterList *stripFilters; +00069 +<a name="l00071"></a><a class="code" href="class_swmodule.html#n9">00071</a> FilterList *rawFilters; +00072 +<a name="l00074"></a><a class="code" href="class_swmodule.html#n10">00074</a> FilterList *renderFilters; +00075 +<a name="l00077"></a><a class="code" href="class_swmodule.html#n11">00077</a> FilterList *optionFilters; +00078 +00079 <font class="keywordtype">bool</font> render; +00080 <font class="keywordtype">bool</font> unicode; +00081 <font class="keywordtype">int</font> entrySize; +00082 +00083 <font class="keyword">public</font>: +00084 +00091 <font class="keyword">static</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#d0">nullPercent</a> (<font class="keywordtype">char</font> percent, <font class="keywordtype">void</font> *userData); +00092 +<a name="l00097"></a><a class="code" href="class_swmodule.html#m0">00097</a> <font class="keywordtype">bool</font> terminateSearch; +00098 +00111 <a class="code" href="class_swmodule.html#a0">SWModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">char</font> *imodtype = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00112 +00115 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html#a1">~ SWModule</a> (); +00116 +00121 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a2">Error</a> (); +00122 +<a name="l00126"></a><a class="code" href="class_swmodule.html#a3">00126</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a3">isUnicode</a>()<font class="keyword"> const </font>{<font class="keywordflow">return</font> unicode;} +<a name="l00130"></a><a class="code" href="class_swmodule.html#a4">00130</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">int</font> <a class="code" href="class_swmodule.html#a4">getEntrySize</a>()<font class="keyword"> const </font>{<font class="keywordflow">return</font> entrySize;} +00131 +00139 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a5">SetKey</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *ikey); +00140 +00146 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a5">SetKey</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> &ikey); +00147 +<a name="l00151"></a><a class="code" href="class_swmodule.html#a7">00151</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> & <a class="code" href="class_swmodule.html#a7">Key</a> ()<font class="keyword"> const </font>{ +00152 <font class="keywordflow">return</font> *key; +00153 } +00154 +<a name="l00161"></a><a class="code" href="class_swmodule.html#a8">00161</a> <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a7">Key</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> </font>{ +00162 <font class="keywordflow">return</font> <a class="code" href="class_swmodule.html#a5">SetKey</a> (ikey); +00163 } +00164 +00171 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a9">KeyText</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodtype = 0); +00172 +00177 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a10">Display</a> (); +00178 +00185 <font class="keyword">virtual</font> <a class="code" href="class_swdisplay.html">SWDisplay</a> *<a class="code" href="class_swmodule.html#a11">Disp</a> (<a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00186 +00193 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a12">Name</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0); +00194 +00201 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a13">Description</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0); +00202 +00209 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a14">Type</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodtype = 0); +00210 +00211 <font class="comment">// search methods</font> +00212 +00224 <font class="keyword">virtual</font> <a class="code" href="class_listkey.html">ListKey</a> & <a class="code" href="class_swmodule.html#a15">Search</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType = 0, <font class="keywordtype">int</font> flags = 0, +00225 <a class="code" href="class_swkey.html">SWKey</a> * scope = 0, +00226 <font class="keywordtype">bool</font> * justCheckIfSupported = 0, +00227 <font class="keywordtype">void</font> (*percent) (<font class="keywordtype">char</font>, <font class="keywordtype">void</font> *) = &nullPercent, +00228 <font class="keywordtype">void</font> *percentUserData = 0); +00232 <font class="keyword">virtual</font> <font class="keywordtype">char</font> createSearchFramework ()<font class="keyword"> </font>{ +00233 <font class="keywordflow">return</font> 0; +00234 } <font class="comment">// special search framework</font> +00235 +00239 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> hasSearchFramework ()<font class="keyword"> </font>{ +00240 <font class="keywordflow">return</font> <font class="keyword">false</font>; +00241 } <font class="comment">// special search framework</font> +00242 +00246 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> isSearchOptimallySupported (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType, +00247 <font class="keywordtype">int</font> flags, <a class="code" href="class_swkey.html">SWKey</a> * scope)<font class="keyword"> </font>{ +00248 <font class="keywordtype">bool</font> retVal = <font class="keyword">false</font>; +00249 <a class="code" href="class_swmodule.html#a15">Search</a> (istr, searchType, flags, scope, &retVal); +00250 <font class="keywordflow">return</font> retVal; +00251 } +00252 +00257 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swmodule.html#a19">CreateKey</a> (); +00258 +00262 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html#a20">operator char *</a>(); +00263 +00268 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a21">getRawEntry</a> () = 0; +00269 +00273 <font class="keyword">virtual</font> operator SWKey & ()<font class="keyword"> </font>{ +00274 <font class="keywordflow">return</font> *key; +00275 } +00276 +00280 <font class="keyword">virtual</font> operator SWKey *()<font class="keyword"> </font>{ +00281 <font class="keywordflow">return</font> key; +00282 } +00283 +00284 <font class="comment">// write interface ----------------------------</font> +<a name="l00288"></a><a class="code" href="class_swmodule.html#a24">00288</a> <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a24">isWritable</a> ()<font class="keyword"> </font>{ +00289 <font class="keywordflow">return</font> <font class="keyword">false</font>; +00290 } +00291 +<a name="l00296"></a><a class="code" href="class_swmodule.html#d1">00296</a> <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"> </font>{ +00297 <font class="keywordflow">return</font> -1; +00298 } +00299 +<a name="l00304"></a><a class="code" href="class_swmodule.html#a25">00304</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"> </font>{ +00305 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00306 } +00307 +<a name="l00312"></a><a class="code" href="class_swmodule.html#a26">00312</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *)<font class="keyword"> </font>{ +00313 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00314 } +00315 +<a name="l00319"></a><a class="code" href="class_swmodule.html#a27">00319</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a27">deleteEntry</a> ()<font class="keyword"> </font>{ +00320 } +00321 +00322 <font class="comment">// end write interface ------------------------</font> +00323 +00329 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a28">operator -= </a>(<font class="keywordtype">int</font> decrement); +00330 +00336 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a29">operator += </a>(<font class="keywordtype">int</font> increment); +00337 +<a name="l00341"></a><a class="code" href="class_swmodule.html#a30">00341</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a30">operator++ </a>(<font class="keywordtype">int</font>)<font class="keyword"> </font>{ +00342 <font class="keywordflow">return</font> *<font class="keyword">this</font> += 1; +00343 } +00344 +<a name="l00348"></a><a class="code" href="class_swmodule.html#a31">00348</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a31">operator-- </a>(<font class="keywordtype">int</font>)<font class="keyword"> </font>{ +00349 <font class="keywordflow">return</font> *<font class="keyword">this</font> -= 1; +00350 } +00351 +00357 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a32">operator = </a>(SW_POSITION p); +00358 +<a name="l00363"></a><a class="code" href="class_swmodule.html#a33">00363</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a33">AddRenderFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{ +00364 renderFilters->push_back (newfilter); +00365 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00366 } +00367 +<a name="l00372"></a><a class="code" href="class_swmodule.html#a34">00372</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a34">RemoveRenderFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * oldfilter)<font class="keyword"> </font>{ +00373 renderFilters->remove (oldfilter); +00374 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00375 } +00376 +<a name="l00383"></a><a class="code" href="class_swmodule.html#a35">00383</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a35">renderFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{ +00384 <a class="code" href="class_swmodule.html#a39">filterBuffer</a>(renderFilters, buf, size, key); +00385 } +00386 +<a name="l00391"></a><a class="code" href="class_swmodule.html#a36">00391</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a36">AddStripFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{ +00392 stripFilters->push_back (newfilter); +00393 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00394 } +00395 +<a name="l00402"></a><a class="code" href="class_swmodule.html#a37">00402</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a37">stripFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{ +00403 <a class="code" href="class_swmodule.html#a39">filterBuffer</a>(stripFilters, buf, size, key); +00404 } +00405 +<a name="l00410"></a><a class="code" href="class_swmodule.html#a38">00410</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a38">AddRawFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{ +00411 rawFilters->push_back (newfilter); +00412 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00413 } +00414 +<a name="l00422"></a><a class="code" href="class_swmodule.html#a39">00422</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a39">filterBuffer</a> (FilterList *filters, <font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{ +00423 FilterList::iterator it; +00424 <font class="keywordflow">for</font> (it = filters->begin(); it != filters->end(); it++) { +00425 (*it)->ProcessText(buf, size, key); +00426 } +00427 } +00428 +<a name="l00435"></a><a class="code" href="class_swmodule.html#a40">00435</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a40">rawFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{ +00436 <a class="code" href="class_swmodule.html#a39">filterBuffer</a>(rawFilters, buf, size, key); +00437 } +00438 +<a name="l00443"></a><a class="code" href="class_swmodule.html#a41">00443</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a41">AddOptionFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{ +00444 optionFilters->push_back (newfilter); +00445 <font class="keywordflow">return</font> *<font class="keyword">this</font>; +00446 } +00447 +<a name="l00454"></a><a class="code" href="class_swmodule.html#a42">00454</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a42">optionFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{ +00455 <a class="code" href="class_swmodule.html#a39">filterBuffer</a>(optionFilters, buf, size, key); +00456 } +00457 +00465 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a43">StripText</a> (<font class="keywordtype">char</font> *buf = 0, <font class="keywordtype">int</font> len = -1); +00466 +00474 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a44">RenderText</a> (<font class="keywordtype">char</font> *buf = 0, <font class="keywordtype">int</font> len = -1); +00475 +00481 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a43">StripText</a> (<a class="code" href="class_swkey.html">SWKey</a> * tmpKey); +00482 +00488 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a44">RenderText</a> (<a class="code" href="class_swkey.html">SWKey</a> * tmpKey); +00489 +00490 }; +00491 +00492 +00493 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swobject.h-source.html b/doc/api-documentation/html/swobject.h-source.html new file mode 100644 index 0000000..5ffc221 --- /dev/null +++ b/doc/api-documentation/html/swobject.h-source.html @@ -0,0 +1,59 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swobject.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swobject.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef SWOBJECT_H +</font>00002 <font class="preprocessor"></font><font class="preprocessor">#define SWOBJECT_H +</font>00003 <font class="preprocessor"></font> +00004 <font class="preprocessor">#include <utilfuns.h></font> +00005 <font class="preprocessor">#if !defined(__GNUC__) && !defined(_WIN32_WCE) +</font>00006 <font class="preprocessor"></font><font class="preprocessor">#else +</font>00007 <font class="preprocessor"></font><font class="preprocessor">#include <unixstr.h></font> +00008 <font class="preprocessor">#endif +</font>00009 <font class="preprocessor"></font> +00010 <font class="preprocessor">#include <defs.h></font> +00011 <font class="preprocessor">#include <string.h></font> +00012 +00013 <font class="preprocessor">#define SWDYNAMIC_CAST(className, object) (className *)((object->getClass()->isAssignableFrom(#className))?object:0) +</font>00014 <font class="preprocessor"></font> +00015 <font class="keyword">class </font>SWDLLEXPORT SWClass { +00016 <font class="keyword">private</font>: +00017 <font class="keyword">const</font> <font class="keywordtype">char</font> **descends; +00018 +00019 <font class="keyword">public</font>: +00020 SWClass (<font class="keyword">const</font> <font class="keywordtype">char</font> **descends)<font class="keyword"> </font>{ +00021 this->descends = descends; +00022 } +00023 +00024 <font class="keywordtype">bool</font> isAssignableFrom (<font class="keyword">const</font> <font class="keywordtype">char</font> *className)<font class="keyword"> const </font>{ +00025 <font class="keywordflow">for</font> (<font class="keywordtype">int</font> i = 0; descends[i]; i++) { +00026 <font class="keywordflow">if</font> (!stricmp (descends[i], className)) +00027 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00028 } +00029 <font class="keywordflow">return</font> <font class="keyword">false</font>; +00030 } +00031 }; +00032 +00033 +00034 <font class="keyword">class </font>SWObject { +00035 <font class="keyword">protected</font>: +00036 SWClass * myclass; +00037 +00038 <font class="keyword">public</font>: +00039 <font class="keyword">const</font> SWClass *getClass ()<font class="keyword"> const </font>{ +00040 <font class="keywordflow">return</font> myclass; +00041 } +00042 }; +00043 +00044 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swobject_8h-source.html b/doc/api-documentation/html/swobject_8h-source.html new file mode 100644 index 0000000..d2f067b --- /dev/null +++ b/doc/api-documentation/html/swobject_8h-source.html @@ -0,0 +1,58 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swobject.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swobject.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef SWOBJECT_H</font> +00002 <font class="preprocessor"></font><font class="preprocessor">#define SWOBJECT_H</font> +00003 <font class="preprocessor"></font> +00004 <font class="preprocessor">#include <utilfuns.h></font> +00005 <font class="preprocessor">#if !defined(__GNUC__) && !defined(_WIN32_WCE)</font> +00006 <font class="preprocessor"></font><font class="preprocessor">#else</font> +00007 <font class="preprocessor"></font><font class="preprocessor">#include <unixstr.h></font> +00008 <font class="preprocessor">#endif</font> +00009 <font class="preprocessor"></font> +00010 <font class="preprocessor">#include <defs.h></font> +00011 <font class="preprocessor">#include <string.h></font> +00012 +00013 <font class="preprocessor">#define SWDYNAMIC_CAST(className, object) (className *)((object->getClass()->isAssignableFrom(#className))?object:0)</font> +00014 <font class="preprocessor"></font> +<a name="l00018"></a><a class="code" href="class_s_w_class.html">00018</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_class.html">SWClass</a> { +00019 <font class="keyword">private</font>: +00020 <font class="keyword">const</font> <font class="keywordtype">char</font> **descends; +00021 +00022 <font class="keyword">public</font>: +00023 SWClass (<font class="keyword">const</font> <font class="keywordtype">char</font> **descends)<font class="keyword"> </font>{ +00024 this->descends = descends; +00025 } +00026 +00027 <font class="keywordtype">bool</font> isAssignableFrom (<font class="keyword">const</font> <font class="keywordtype">char</font> *className)<font class="keyword"> const </font>{ +00028 <font class="keywordflow">for</font> (<font class="keywordtype">int</font> i = 0; descends[i]; i++) { +00029 <font class="keywordflow">if</font> (!stricmp (descends[i], className)) +00030 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00031 } +00032 <font class="keywordflow">return</font> <font class="keyword">false</font>; +00033 } +00034 }; +00035 +<a name="l00041"></a><a class="code" href="class_s_w_object.html">00041</a> <font class="keyword">class </font><a class="code" href="class_s_w_object.html">SWObject</a> { +00042 <font class="keyword">protected</font>: +00043 <a class="code" href="class_s_w_class.html">SWClass</a> * myclass; +00044 +00045 <font class="keyword">public</font>: +<a name="l00049"></a><a class="code" href="class_s_w_object.html#a0">00049</a> <font class="keyword">const</font> <a class="code" href="class_s_w_class.html">SWClass</a> *<a class="code" href="class_s_w_object.html#a0">getClass</a> ()<font class="keyword"> const </font>{ +00050 <font class="keywordflow">return</font> myclass; +00051 } +00052 }; +00053 +00054 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swobject_h-source.html b/doc/api-documentation/html/swobject_h-source.html new file mode 100644 index 0000000..0f7f8a6 --- /dev/null +++ b/doc/api-documentation/html/swobject_h-source.html @@ -0,0 +1,59 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swobject.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swobject.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef SWOBJECT_H</font> +00002 <font class="preprocessor"></font><font class="preprocessor">#define SWOBJECT_H</font> +00003 <font class="preprocessor"></font> +00004 <font class="preprocessor">#include <utilfuns.h></font> +00005 <font class="preprocessor">#if !defined(__GNUC__) && !defined(_WIN32_WCE)</font> +00006 <font class="preprocessor"></font><font class="preprocessor">#else</font> +00007 <font class="preprocessor"></font><font class="preprocessor">#include <unixstr.h></font> +00008 <font class="preprocessor">#endif</font> +00009 <font class="preprocessor"></font> +00010 <font class="preprocessor">#include <defs.h></font> +00011 <font class="preprocessor">#include <string.h></font> +00012 +00013 <font class="preprocessor">#define SWDYNAMIC_CAST(className, object) (className *)((object->getClass()->isAssignableFrom(#className))?object:0)</font> +00014 <font class="preprocessor"></font> +<a name="l00018"></a><a class="code" href="class_swclass.html">00018</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swclass.html">SWClass</a> { +00019 <font class="keyword">private</font>: +00020 <font class="keyword">const</font> <font class="keywordtype">char</font> **descends; +00021 +00022 <font class="keyword">public</font>: +00023 SWClass (<font class="keyword">const</font> <font class="keywordtype">char</font> **descends)<font class="keyword"> </font>{ +00024 this->descends = descends; +00025 } +00026 +00027 <font class="keywordtype">bool</font> isAssignableFrom (<font class="keyword">const</font> <font class="keywordtype">char</font> *className)<font class="keyword"> const </font>{ +00028 <font class="keywordflow">for</font> (<font class="keywordtype">int</font> i = 0; descends[i]; i++) { +00029 <font class="keywordflow">if</font> (!stricmp (descends[i], className)) +00030 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00031 } +00032 <font class="keywordflow">return</font> <font class="keyword">false</font>; +00033 } +00034 }; +00035 +<a name="l00041"></a><a class="code" href="class_swobject.html">00041</a> <font class="keyword">class </font><a class="code" href="class_swobject.html">SWObject</a> { +00042 <font class="keyword">protected</font>: +00043 <a class="code" href="class_swclass.html">SWClass</a> * myclass; +00044 +00045 <font class="keyword">public</font>: +<a name="l00049"></a><a class="code" href="class_swobject.html#a0">00049</a> <font class="keyword">const</font> <a class="code" href="class_swclass.html">SWClass</a> *<a class="code" href="class_swobject.html#a0">getClass</a> ()<font class="keyword"> const </font>{ +00050 <font class="keywordflow">return</font> myclass; +00051 } +00052 }; +00053 +00054 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swtext.h-source.html b/doc/api-documentation/html/swtext.h-source.html new file mode 100644 index 0000000..55b6fab --- /dev/null +++ b/doc/api-documentation/html/swtext.h-source.html @@ -0,0 +1,56 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swtext.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swtext.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swtext.h - code for base class 'SWText'. SWText is the basis for all +</font>00003 <font class="comment"> * types of text modules +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swtext.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWTEXT_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define SWTEXT_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swmodule.h></font> +00027 <font class="preprocessor">#include <versekey.h></font> +00028 <font class="preprocessor">#include <listkey.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +<a name="l00034"></a><a class="code" href="class_swtext.html">00034</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swtext.html">SWText</a>:<font class="keyword">public</font> <a class="code" href="class_swmodule.html">SWModule</a> +00035 { +00036 <font class="keyword">public</font>: +00043 <a class="code" href="class_swtext.html#a0">SWText</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00044 <font class="keyword">virtual</font> ~ SWText (); +00047 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swmodule.html#a17">CreateKey</a> (); +00048 }; +00049 +00050 +00051 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swtext_8h-source.html b/doc/api-documentation/html/swtext_8h-source.html new file mode 100644 index 0000000..3032cc2 --- /dev/null +++ b/doc/api-documentation/html/swtext_8h-source.html @@ -0,0 +1,56 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swtext.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swtext.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swtext.h - code for base class 'SWText'. SWText is the basis for all</font> +00003 <font class="comment"> * types of text modules</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swtext_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWTEXT_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWTEXT_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swmodule.h></font> +00027 <font class="preprocessor">#include <versekey.h></font> +00028 <font class="preprocessor">#include <listkey.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +<a name="l00034"></a><a class="code" href="class_s_w_text.html">00034</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_s_w_text.html">SWText</a>:<font class="keyword">public</font> <a class="code" href="class_s_w_module.html">SWModule</a> +00035 { +00036 <font class="keyword">public</font>: +00043 <a class="code" href="class_s_w_text.html#a0">SWText</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); +00044 <font class="keyword">virtual</font> ~ SWText (); +00047 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> *<a class="code" href="class_s_w_module.html#a23">CreateKey</a> (); +00048 }; +00049 +00050 +00051 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swtext_h-source.html b/doc/api-documentation/html/swtext_h-source.html new file mode 100644 index 0000000..ee27339 --- /dev/null +++ b/doc/api-documentation/html/swtext_h-source.html @@ -0,0 +1,57 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swtext.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swtext.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swtext.h - code for base class 'SWText'. SWText is the basis for all</font> +00003 <font class="comment"> * types of text modules</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swtext_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef SWTEXT_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define SWTEXT_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swmodule.h></font> +00027 <font class="preprocessor">#include <versekey.h></font> +00028 <font class="preprocessor">#include <listkey.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +<a name="l00034"></a><a class="code" href="class_swtext.html">00034</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swtext.html">SWText</a>:<font class="keyword">public</font> <a class="code" href="class_swmodule.html">SWModule</a> +00035 { +00036 <font class="keyword">public</font>: +00043 <a class="code" href="class_swtext.html#a0">SWText</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00044 <font class="keyword">virtual</font> ~ SWText (); +00047 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swmodule.html#a19">CreateKey</a> (); +00048 }; +00049 +00050 +00051 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swunicod_8h-source.html b/doc/api-documentation/html/swunicod_8h-source.html new file mode 100644 index 0000000..412e64f --- /dev/null +++ b/doc/api-documentation/html/swunicod_8h-source.html @@ -0,0 +1,43 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swunicod.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swunicod.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00004 <font class="comment"> * CrossWire Bible Society</font> +00005 <font class="comment"> * P. O. Box 2528</font> +00006 <font class="comment"> * Tempe, AZ 85280-2528</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00009 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00010 <font class="comment"> * Free Software Foundation version 2.</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00013 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00014 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00015 <font class="comment"> * General Public License for more details.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> */</font> +00018 +00019 +00020 <font class="preprocessor">#ifndef SWUNICOD_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define SWUNICOD_H</font> +00022 <font class="preprocessor"></font> +00028 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font>* UTF32to8 (<font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> utf32, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> * utf8); +00029 +00030 +00036 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> UTF8to32 (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> * utf8, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> utf32); +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swunicod_h-source.html b/doc/api-documentation/html/swunicod_h-source.html new file mode 100644 index 0000000..4ec1afd --- /dev/null +++ b/doc/api-documentation/html/swunicod_h-source.html @@ -0,0 +1,44 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swunicod.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swunicod.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00004 <font class="comment"> * CrossWire Bible Society</font> +00005 <font class="comment"> * P. O. Box 2528</font> +00006 <font class="comment"> * Tempe, AZ 85280-2528</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00009 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00010 <font class="comment"> * Free Software Foundation version 2.</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00013 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00014 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00015 <font class="comment"> * General Public License for more details.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> */</font> +00018 +00019 +00020 <font class="preprocessor">#ifndef SWUNICOD_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define SWUNICOD_H</font> +00022 <font class="preprocessor"></font> +00028 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font>* UTF32to8 (<font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> utf32, <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> * utf8); +00029 +00030 +00036 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> UTF8to32 (<font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> * utf8, <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> utf32); +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swversion_8h-source.html b/doc/api-documentation/html/swversion_8h-source.html new file mode 100644 index 0000000..69fee7e --- /dev/null +++ b/doc/api-documentation/html/swversion_8h-source.html @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swversion.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swversion.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swversion.h - definition of class SWVersion used to compare version info</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: swversion_8h-source.html,v 1.2 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef SWORDVER</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define SWORDVER "1.5.3"</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#ifndef SWVERSION_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define SWVERSION_H</font> +00028 <font class="preprocessor"></font> +00029 <font class="keyword">class </font>SWVersion { +00030 <font class="keyword">public</font>: +00031 <font class="keywordtype">int</font> major, minor, minor2, minor3; +00032 +00033 SWVersion(<font class="keyword">const</font> <font class="keywordtype">char</font> *version = <font class="stringliteral">"0.0"</font>); +00034 <font class="keywordtype">int</font> compare(<font class="keyword">const</font> SWVersion &vi) <font class="keyword">const</font>; +00035 operator const char *() <font class="keyword">const</font>; +00036 <font class="keywordtype">bool</font> operator>(<font class="keyword">const</font> SWVersion &vi)<font class="keyword"> const </font>{<font class="keywordflow">return</font> (compare(vi) > 0);} +00037 <font class="keywordtype">bool</font> operator<(<font class="keyword">const</font> SWVersion &vi)<font class="keyword"> const </font>{<font class="keywordflow">return</font> (compare(vi) < 0);} +00038 <font class="keywordtype">bool</font> operator==(<font class="keyword">const</font> SWVersion &vi)<font class="keyword"> const </font>{<font class="keywordflow">return</font> (compare(vi) == 0);} +00039 +00040 <font class="comment">// current sword library version</font> +00041 <font class="keyword">static</font> SWVersion currentVersion; +00042 }; +00043 +00044 <font class="preprocessor">#endif</font> +00045 <font class="preprocessor"></font> +</pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swwinlog.h-source.html b/doc/api-documentation/html/swwinlog.h-source.html new file mode 100644 index 0000000..e100389 --- /dev/null +++ b/doc/api-documentation/html/swwinlog.h-source.html @@ -0,0 +1,57 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>swwinlog.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swwinlog.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swwinlog.h - definition of SWWinLog-- a derivitive of SWLog used to +</font>00003 <font class="comment"> * handle logging in the MSWindows environment +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: swwinlog.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="comment">//---------------------------------------------------------------------------</font> +00024 <font class="preprocessor">#ifndef swwinlogH +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#define swwinlogH +</font>00026 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00027 +00028 <font class="preprocessor">#include <swlog.h></font> +00029 +00030 <font class="keyword">class </font>SWWinLog:<font class="keyword">public</font> SWLog +00031 { +00032 HWND parent; +00033 <font class="keyword">public</font>: +00034 SWWinLog (HWND iparent); +00035 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogWarning (<font class="keywordtype">char</font> *fmt, ...); +00036 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogError (<font class="keywordtype">char</font> *fmt, ...); +00037 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogTimedInformation (<font class="keywordtype">char</font> *fmt, ...); +00038 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogInformation (<font class="keywordtype">char</font> *fmt, ...); +00039 }; +00040 +00041 +00042 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swwinlog_8h-source.html b/doc/api-documentation/html/swwinlog_8h-source.html new file mode 100644 index 0000000..24585c5 --- /dev/null +++ b/doc/api-documentation/html/swwinlog_8h-source.html @@ -0,0 +1,57 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swwinlog.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swwinlog.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swwinlog.h - definition of SWWinLog-- a derivitive of SWLog used to</font> +00003 <font class="comment"> * handle logging in the MSWindows environment</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swwinlog_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="comment">//---------------------------------------------------------------------------</font> +00024 <font class="preprocessor">#ifndef swwinlogH</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define swwinlogH</font> +00026 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00027 +00028 <font class="preprocessor">#include <swlog.h></font> +00029 +00030 <font class="keyword">class </font>SWWinLog:<font class="keyword">public</font> SWLog +00031 { +00032 HWND parent; +00033 <font class="keyword">public</font>: +00034 SWWinLog (HWND iparent); +00035 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogWarning (<font class="keywordtype">char</font> *fmt, ...); +00036 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogError (<font class="keywordtype">char</font> *fmt, ...); +00037 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogTimedInformation (<font class="keywordtype">char</font> *fmt, ...); +00038 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogInformation (<font class="keywordtype">char</font> *fmt, ...); +00039 }; +00040 +00041 +00042 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/swwinlog_h-source.html b/doc/api-documentation/html/swwinlog_h-source.html new file mode 100644 index 0000000..fc62243 --- /dev/null +++ b/doc/api-documentation/html/swwinlog_h-source.html @@ -0,0 +1,58 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>swwinlog.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>swwinlog.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swwinlog.h - definition of SWWinLog-- a derivitive of SWLog used to</font> +00003 <font class="comment"> * handle logging in the MSWindows environment</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: swwinlog_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="comment">//---------------------------------------------------------------------------</font> +00024 <font class="preprocessor">#ifndef swwinlogH</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define swwinlogH</font> +00026 <font class="preprocessor"></font><font class="comment">//---------------------------------------------------------------------------</font> +00027 +00028 <font class="preprocessor">#include <swlog.h></font> +00029 +00030 <font class="keyword">class </font>SWWinLog:<font class="keyword">public</font> SWLog +00031 { +00032 HWND parent; +00033 <font class="keyword">public</font>: +00034 SWWinLog (HWND iparent); +00035 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogWarning (<font class="keywordtype">char</font> *fmt, ...); +00036 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogError (<font class="keywordtype">char</font> *fmt, ...); +00037 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogTimedInformation (<font class="keywordtype">char</font> *fmt, ...); +00038 <font class="keyword">virtual</font> <font class="keywordtype">void</font> LogInformation (<font class="keywordtype">char</font> *fmt, ...); +00039 }; +00040 +00041 +00042 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/tbdisp.h-source.html b/doc/api-documentation/html/tbdisp.h-source.html new file mode 100644 index 0000000..ee965e7 --- /dev/null +++ b/doc/api-documentation/html/tbdisp.h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>tbdisp.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>tbdisp.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * tbdisp.cpp - code for class 'tbdisp'. tbdisp writes module output to a +</font>00003 <font class="comment"> * MSWindows TextBox (or any other control that takes a +</font>00004 <font class="comment"> * SetDialogItemText +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * $Id: tbdisp.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00007 <font class="comment"> * +</font>00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00009 <font class="comment"> * CrossWire Bible Society +</font>00010 <font class="comment"> * P. O. Box 2528 +</font>00011 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00012 <font class="comment"> * +</font>00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00014 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00015 <font class="comment"> * Free Software Foundation version 2. +</font>00016 <font class="comment"> * +</font>00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00020 <font class="comment"> * General Public License for more details. +</font>00021 <font class="comment"> * +</font>00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef TBDISP_H +</font>00025 <font class="preprocessor"></font><font class="preprocessor">#define TBDISP_H +</font>00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <windows.h></font> +00028 <font class="keyword">class </font><a class="code" href="class_swmodule.html">SWModule</a>; +00029 +00030 <font class="keyword">class </font>TBDisp:<font class="keyword">public</font> <a class="code" href="class_swdisplay.html">SWDisplay</a> +00031 { +00032 <font class="keyword">protected</font>: +00033 HWND wnd; +00034 <font class="keywordtype">int</font> ctrlid; +00035 <font class="keyword">public</font>: +00036 TBDisp (HWND iwnd, <font class="keywordtype">int</font> ictrlid); +00037 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swdisplay.html#a1">Display</a> (<a class="code" href="class_swmodule.html">SWModule</a> & imodule); +00038 }; +00039 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/tbdisp_8h-source.html b/doc/api-documentation/html/tbdisp_8h-source.html new file mode 100644 index 0000000..d18c2c5 --- /dev/null +++ b/doc/api-documentation/html/tbdisp_8h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>tbdisp.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>tbdisp.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * tbdisp.cpp - code for class 'tbdisp'. tbdisp writes module output to a</font> +00003 <font class="comment"> * MSWindows TextBox (or any other control that takes a</font> +00004 <font class="comment"> * SetDialogItemText</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: tbdisp_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef TBDISP_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define TBDISP_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <windows.h></font> +00028 <font class="keyword">class </font><a class="code" href="class_s_w_module.html">SWModule</a>; +00029 +00030 <font class="keyword">class </font>TBDisp:<font class="keyword">public</font> <a class="code" href="class_s_w_display.html">SWDisplay</a> +00031 { +00032 <font class="keyword">protected</font>: +00033 HWND wnd; +00034 <font class="keywordtype">int</font> ctrlid; +00035 <font class="keyword">public</font>: +00036 TBDisp (HWND iwnd, <font class="keywordtype">int</font> ictrlid); +00037 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_display.html#a1">Display</a> (<a class="code" href="class_s_w_module.html">SWModule</a> & imodule); +00038 }; +00039 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/tbdisp_h-source.html b/doc/api-documentation/html/tbdisp_h-source.html new file mode 100644 index 0000000..464197e --- /dev/null +++ b/doc/api-documentation/html/tbdisp_h-source.html @@ -0,0 +1,55 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>tbdisp.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>tbdisp.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * tbdisp.cpp - code for class 'tbdisp'. tbdisp writes module output to a</font> +00003 <font class="comment"> * MSWindows TextBox (or any other control that takes a</font> +00004 <font class="comment"> * SetDialogItemText</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * $Id: tbdisp_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00009 <font class="comment"> * CrossWire Bible Society</font> +00010 <font class="comment"> * P. O. Box 2528</font> +00011 <font class="comment"> * Tempe, AZ 85280-2528</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00015 <font class="comment"> * Free Software Foundation version 2.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00020 <font class="comment"> * General Public License for more details.</font> +00021 <font class="comment"> *</font> +00022 <font class="comment"> */</font> +00023 +00024 <font class="preprocessor">#ifndef TBDISP_H</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define TBDISP_H</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <windows.h></font> +00028 <font class="keyword">class </font><a class="code" href="class_swmodule.html">SWModule</a>; +00029 +00030 <font class="keyword">class </font>TBDisp:<font class="keyword">public</font> <a class="code" href="class_swdisplay.html">SWDisplay</a> +00031 { +00032 <font class="keyword">protected</font>: +00033 HWND wnd; +00034 <font class="keywordtype">int</font> ctrlid; +00035 <font class="keyword">public</font>: +00036 TBDisp (HWND iwnd, <font class="keywordtype">int</font> ictrlid); +00037 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swdisplay.html#a1">Display</a> (<a class="code" href="class_swmodule.html">SWModule</a> & imodule); +00038 }; +00039 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlfootnotes_8h-source.html b/doc/api-documentation/html/thmlfootnotes_8h-source.html new file mode 100644 index 0000000..f76faa2 --- /dev/null +++ b/doc/api-documentation/html/thmlfootnotes_8h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlfootnotes.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlfootnotes.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id:</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLFOOTNOTES_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLFOOTNOTES_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_th_m_l_footnotes.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_footnotes.html">ThMLFootnotes</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 ThMLFootnotes (); +00040 <font class="keyword">virtual</font> ~ ThMLFootnotes (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00042 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +00046 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00052 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlgbf.h-source.html b/doc/api-documentation/html/thmlgbf.h-source.html new file mode 100644 index 0000000..f792d87 --- /dev/null +++ b/doc/api-documentation/html/thmlgbf.h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>thmlgbf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlgbf.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * thmlgbf.h +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLGBF_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLGBF_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_thmlgbf.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlgbf.html">ThMLGBF</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLGBF (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlgbf_8h-source.html b/doc/api-documentation/html/thmlgbf_8h-source.html new file mode 100644 index 0000000..ba80ae1 --- /dev/null +++ b/doc/api-documentation/html/thmlgbf_8h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlgbf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlgbf.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * thmlgbf.h</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLGBF_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLGBF_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_th_m_l_g_b_f.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_g_b_f.html">ThMLGBF</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLGBF (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlgbf_h-source.html b/doc/api-documentation/html/thmlgbf_h-source.html new file mode 100644 index 0000000..8a70341 --- /dev/null +++ b/doc/api-documentation/html/thmlgbf_h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlgbf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlgbf.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * thmlgbf.h</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLGBF_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLGBF_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_thmlgbf.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlgbf.html">ThMLGBF</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLGBF (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlheadings_8h-source.html b/doc/api-documentation/html/thmlheadings_8h-source.html new file mode 100644 index 0000000..0dde41c --- /dev/null +++ b/doc/api-documentation/html/thmlheadings_8h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlheadings.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlheadings.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: </font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLHEADINGS_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLHEADINGS_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_th_m_l_headings.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_headings.html">ThMLHeadings</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 ThMLHeadings (); +00040 <font class="keyword">virtual</font> ~ ThMLHeadings (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00042 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +00046 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00052 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlhtml.h-source.html b/doc/api-documentation/html/thmlhtml.h-source.html new file mode 100644 index 0000000..f039039 --- /dev/null +++ b/doc/api-documentation/html/thmlhtml.h-source.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>thmlhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/*************************************************************************** +</font>00002 <font class="comment"> thmlhtml.h - description +</font>00003 <font class="comment"> ------------------- +</font>00004 <font class="comment"> begin : 1999-10-28 +</font>00005 <font class="comment"> +</font>00006 <font class="comment"> copyright : 1999 by Chris Little +</font>00007 <font class="comment"> email : chrislit@chiasma.org +</font>00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/*************************************************************************** +</font>00011 <font class="comment"> * * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify * +</font>00013 <font class="comment"> * it under the terms of the GNU General Public License as published by * +</font>00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or * +</font>00015 <font class="comment"> * (at your option) any later version. * +</font>00016 <font class="comment"> * * +</font>00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="preprocessor">#ifndef THMLHTML_H +</font>00020 <font class="preprocessor"></font><font class="preprocessor">#define THMLHTML_H +</font>00021 <font class="preprocessor"></font> +00022 <font class="preprocessor">#include <swfilter.h></font> +00023 +00024 <font class="preprocessor">#include <defs.h></font> +00025 +<a name="l00028"></a><a class="code" href="class_thmlhtml.html">00028</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlhtml.html">ThMLHTML</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00029 { +00030 <font class="keyword">public</font>: +00031 ThMLHTML (); +00032 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00033 }; +00034 +00035 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlhtml_8h-source.html b/doc/api-documentation/html/thmlhtml_8h-source.html new file mode 100644 index 0000000..282ac9a --- /dev/null +++ b/doc/api-documentation/html/thmlhtml_8h-source.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> thmlhtml.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : 1999-10-28</font> +00005 <font class="comment"></font> +00006 <font class="comment"> copyright : 1999 by Chris Little</font> +00007 <font class="comment"> email : chrislit@chiasma.org</font> +00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/***************************************************************************</font> +00011 <font class="comment"> * *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00013 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00015 <font class="comment"> * (at your option) any later version. *</font> +00016 <font class="comment"> * *</font> +00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="preprocessor">#ifndef THMLHTML_H</font> +00020 <font class="preprocessor"></font><font class="preprocessor">#define THMLHTML_H</font> +00021 <font class="preprocessor"></font> +00022 <font class="preprocessor">#include <swbasicfilter.h></font> +00023 +00024 <font class="preprocessor">#include <defs.h></font> +00025 +<a name="l00028"></a><a class="code" href="class_th_m_l_h_t_m_l.html">00028</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_h_t_m_l.html">ThMLHTML</a> : <font class="keyword">public</font> SWBasicFilter { +00029 <font class="keyword">protected</font>: +00030 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token, DualStringMap &userData); +00031 <font class="keyword">public</font>: +00032 ThMLHTML(); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlhtml_h-source.html b/doc/api-documentation/html/thmlhtml_h-source.html new file mode 100644 index 0000000..4a84ef7 --- /dev/null +++ b/doc/api-documentation/html/thmlhtml_h-source.html @@ -0,0 +1,49 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlhtml.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlhtml.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> thmlhtml.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : 1999-10-28</font> +00005 <font class="comment"></font> +00006 <font class="comment"> copyright : 1999 by Chris Little</font> +00007 <font class="comment"> email : chrislit@chiasma.org</font> +00008 <font class="comment"> ***************************************************************************/</font> +00009 +00010 <font class="comment">/***************************************************************************</font> +00011 <font class="comment"> * *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00013 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00014 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00015 <font class="comment"> * (at your option) any later version. *</font> +00016 <font class="comment"> * *</font> +00017 <font class="comment"> ***************************************************************************/</font> +00018 +00019 <font class="preprocessor">#ifndef THMLHTML_H</font> +00020 <font class="preprocessor"></font><font class="preprocessor">#define THMLHTML_H</font> +00021 <font class="preprocessor"></font> +00022 <font class="preprocessor">#include <swbasicfilter.h></font> +00023 +00024 <font class="preprocessor">#include <defs.h></font> +00025 +<a name="l00028"></a><a class="code" href="class_thmlhtml.html">00028</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlhtml.html">ThMLHTML</a> : <font class="keyword">public</font> SWBasicFilter { +00029 <font class="keyword">protected</font>: +00030 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token, DualStringMap &userData); +00031 <font class="keyword">public</font>: +00032 ThMLHTML(); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlhtmlhref_8h-source.html b/doc/api-documentation/html/thmlhtmlhref_8h-source.html new file mode 100644 index 0000000..e5d9d49 --- /dev/null +++ b/doc/api-documentation/html/thmlhtmlhref_8h-source.html @@ -0,0 +1,46 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlhtmlhref.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlhtmlhref.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> thmlhtmlhref.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : 2001-09-03</font> +00005 <font class="comment"> copyright : 2001 by CrossWire Bible Society</font> +00006 <font class="comment"> ***************************************************************************/</font> +00007 +00008 <font class="comment">/***************************************************************************</font> +00009 <font class="comment"> * *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00013 <font class="comment"> * (at your option) any later version. *</font> +00014 <font class="comment"> * *</font> +00015 <font class="comment"> ***************************************************************************/</font> +00016 +00017 <font class="preprocessor">#ifndef _THMLHTMLHREF_H</font> +00018 <font class="preprocessor"></font><font class="preprocessor">#define _THMLHTMLHREF_H</font> +00019 <font class="preprocessor"></font> +00020 <font class="preprocessor">#include <swbasicfilter.h></font> +00021 +00022 <font class="preprocessor">#include <defs.h></font> +00023 +<a name="l00026"></a><a class="code" href="class_th_m_l_h_t_m_l_h_r_e_f.html">00026</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_h_t_m_l_h_r_e_f.html">ThMLHTMLHREF</a> : <font class="keyword">public</font> SWBasicFilter { +00027 <font class="keyword">protected</font>: +00028 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token, DualStringMap &userData); +00029 <font class="keyword">public</font>: +00030 ThMLHTMLHREF(); +00031 }; +00032 +00033 <font class="preprocessor">#endif </font><font class="comment">/* _THMLHTMLHREF_H */</font> +</pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlhtmlhref_h-source.html b/doc/api-documentation/html/thmlhtmlhref_h-source.html new file mode 100644 index 0000000..e3c830d --- /dev/null +++ b/doc/api-documentation/html/thmlhtmlhref_h-source.html @@ -0,0 +1,47 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlhtmlhref.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlhtmlhref.h</h1><div class="fragment"><pre>00001 <font class="comment">/***************************************************************************</font> +00002 <font class="comment"> thmlhtmlhref.h - description</font> +00003 <font class="comment"> -------------------</font> +00004 <font class="comment"> begin : 2001-09-03</font> +00005 <font class="comment"> copyright : 2001 by CrossWire Bible Society</font> +00006 <font class="comment"> ***************************************************************************/</font> +00007 +00008 <font class="comment">/***************************************************************************</font> +00009 <font class="comment"> * *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify *</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by *</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2 of the License, or *</font> +00013 <font class="comment"> * (at your option) any later version. *</font> +00014 <font class="comment"> * *</font> +00015 <font class="comment"> ***************************************************************************/</font> +00016 +00017 <font class="preprocessor">#ifndef _THMLHTMLHREF_H</font> +00018 <font class="preprocessor"></font><font class="preprocessor">#define _THMLHTMLHREF_H</font> +00019 <font class="preprocessor"></font> +00020 <font class="preprocessor">#include <swbasicfilter.h></font> +00021 +00022 <font class="preprocessor">#include <defs.h></font> +00023 +<a name="l00026"></a><a class="code" href="class_thmlhtmlhref.html">00026</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlhtmlhref.html">ThMLHTMLHREF</a> : <font class="keyword">public</font> SWBasicFilter { +00027 <font class="keyword">protected</font>: +00028 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token, DualStringMap &userData); +00029 <font class="keyword">public</font>: +00030 ThMLHTMLHREF(); +00031 }; +00032 +00033 <font class="preprocessor">#endif </font><font class="comment">/* _THMLHTMLHREF_H */</font> +</pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmllemma_8h-source.html b/doc/api-documentation/html/thmllemma_8h-source.html new file mode 100644 index 0000000..c7204f0 --- /dev/null +++ b/doc/api-documentation/html/thmllemma_8h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmllemma.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmllemma.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: </font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLLEMMA_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLLEMMA_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_th_m_l_lemma.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_lemma.html">ThMLLemma</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 ThMLLemma (); +00040 <font class="keyword">virtual</font> ~ ThMLLemma (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00042 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +00046 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00052 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlmorph_8h-source.html b/doc/api-documentation/html/thmlmorph_8h-source.html new file mode 100644 index 0000000..4c1c294 --- /dev/null +++ b/doc/api-documentation/html/thmlmorph_8h-source.html @@ -0,0 +1,70 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlmorph.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlmorph.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> * $Id:</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef THMLMORPH_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define THMLMORPH_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_th_m_l_morph.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_morph.html">ThMLMorph</a>:<font class="keyword">public</font> SWFilter +00030 { +00031 <font class="keywordtype">bool</font> option; +00032 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00036 OptionsList options; +00037 <font class="keyword">public</font>: +00038 ThMLMorph (); +00039 <font class="keyword">virtual</font> ~ ThMLMorph (); +00040 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00041 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00042 <font class="keyword"> </font>{ +00043 <font class="keywordflow">return</font> optName; +00044 } +00045 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> optTip; +00048 } +00049 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00050 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00051 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> options; +00054 } +00055 }; +00056 +00057 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlolb.h-source.html b/doc/api-documentation/html/thmlolb.h-source.html new file mode 100644 index 0000000..0336b0d --- /dev/null +++ b/doc/api-documentation/html/thmlolb.h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>thmlolb.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlolb.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * thmlolb.h +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLOLB_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLOLB_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_thmlolb.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlolb.html">ThMLOLB</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLOLB (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlolb_8h-source.html b/doc/api-documentation/html/thmlolb_8h-source.html new file mode 100644 index 0000000..2a5f949 --- /dev/null +++ b/doc/api-documentation/html/thmlolb_8h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlolb.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlolb.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * thmlolb.h</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLOLB_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLOLB_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_th_m_l_o_l_b.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_o_l_b.html">ThMLOLB</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLOLB (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlolb_h-source.html b/doc/api-documentation/html/thmlolb_h-source.html new file mode 100644 index 0000000..3872272 --- /dev/null +++ b/doc/api-documentation/html/thmlolb_h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlolb.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlolb.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * thmlolb.h</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLOLB_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLOLB_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_thmlolb.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlolb.html">ThMLOLB</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLOLB (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlplain.h-source.html b/doc/api-documentation/html/thmlplain.h-source.html new file mode 100644 index 0000000..2822702 --- /dev/null +++ b/doc/api-documentation/html/thmlplain.h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>thmlplain.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlplain.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * thmlplain.h +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLPLAIN_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLPLAIN_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_thmlplain.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlplain.html">ThMLPlain</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLPlain (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlplain_8h-source.html b/doc/api-documentation/html/thmlplain_8h-source.html new file mode 100644 index 0000000..17b94f4 --- /dev/null +++ b/doc/api-documentation/html/thmlplain_8h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlplain.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlplain.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * thmlplain.h</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLPLAIN_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLPLAIN_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_th_m_l_plain.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_plain.html">ThMLPlain</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLPlain (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlplain_h-source.html b/doc/api-documentation/html/thmlplain_h-source.html new file mode 100644 index 0000000..427a1e6 --- /dev/null +++ b/doc/api-documentation/html/thmlplain_h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlplain.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlplain.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * thmlplain.h</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLPLAIN_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLPLAIN_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_thmlplain.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlplain.html">ThMLPlain</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLPlain (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlrtf.h-source.html b/doc/api-documentation/html/thmlrtf.h-source.html new file mode 100644 index 0000000..76ae342 --- /dev/null +++ b/doc/api-documentation/html/thmlrtf.h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>thmlrtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlrtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * thmlrtf.h +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLRTF_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLRTF_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_thmlrtf.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlrtf.html">ThMLRTF</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLRTF (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlrtf_8h-source.html b/doc/api-documentation/html/thmlrtf_8h-source.html new file mode 100644 index 0000000..778a61a --- /dev/null +++ b/doc/api-documentation/html/thmlrtf_8h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlrtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlrtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * thmlrtf.h</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLRTF_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLRTF_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swbasicfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_th_m_l_r_t_f.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_r_t_f.html">ThMLRTF</a>:<font class="keyword">public</font> SWBasicFilter +00031 { +00032 <font class="keyword">protected</font>: +00033 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> handleToken(<font class="keywordtype">char</font> **buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *token, DualStringMap &userData); +00034 <font class="keyword">public</font>: +00035 ThMLRTF (); +00036 }; +00037 +00038 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlrtf_h-source.html b/doc/api-documentation/html/thmlrtf_h-source.html new file mode 100644 index 0000000..01bf64d --- /dev/null +++ b/doc/api-documentation/html/thmlrtf_h-source.html @@ -0,0 +1,51 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlrtf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlrtf.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * thmlrtf.h</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLRTF_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLRTF_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_thmlrtf.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_thmlrtf.html">ThMLRTF</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00031 { +00032 <font class="keyword">public</font>: +00033 ThMLRTF (); +00034 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen = -1); +00035 }; +00036 +00037 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlscripref_8h-source.html b/doc/api-documentation/html/thmlscripref_8h-source.html new file mode 100644 index 0000000..9ab6bca --- /dev/null +++ b/doc/api-documentation/html/thmlscripref_8h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlscripref.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlscripref.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: </font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLSCRIPREF_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLSCRIPREF_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_th_m_l_scripref.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_scripref.html">ThMLScripref</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 ThMLScripref (); +00040 <font class="keyword">virtual</font> ~ ThMLScripref (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00042 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +00046 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00052 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/thmlstrongs_8h-source.html b/doc/api-documentation/html/thmlstrongs_8h-source.html new file mode 100644 index 0000000..35a4c2f --- /dev/null +++ b/doc/api-documentation/html/thmlstrongs_8h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>thmlstrongs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>thmlstrongs.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id:</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef THMLSTRONGS_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define THMLSTRONGS_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_th_m_l_strongs.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_th_m_l_strongs.html">ThMLStrongs</a>:<font class="keyword">public</font> SWFilter +00031 { +00032 <font class="keywordtype">bool</font> option; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00036 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00037 OptionsList options; +00038 <font class="keyword">public</font>: +00039 ThMLStrongs (); +00040 <font class="keyword">virtual</font> ~ ThMLStrongs (); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00042 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00043 <font class="keyword"> </font>{ +00044 <font class="keywordflow">return</font> optName; +00045 } +00046 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> optTip; +00049 } +00050 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00052 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> options; +00055 } +00056 }; +00057 +00058 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/unicodertf.h-source.html b/doc/api-documentation/html/unicodertf.h-source.html new file mode 100644 index 0000000..633eef6 --- /dev/null +++ b/doc/api-documentation/html/unicodertf.h-source.html @@ -0,0 +1,49 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>unicodertf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>unicodertf.h</h1><div class="fragment"><pre>00001 <font class="comment">/* +</font>00002 <font class="comment"> * +</font>00003 <font class="comment"> * $Id: unicodertf.h-source.html,v 1.1 2001/05/25 10:50:59 jansorg Exp $ +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00006 <font class="comment"> * CrossWire Bible Society +</font>00007 <font class="comment"> * P. O. Box 2528 +</font>00008 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00009 <font class="comment"> * +</font>00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00011 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00012 <font class="comment"> * Free Software Foundation version 2. +</font>00013 <font class="comment"> * +</font>00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00017 <font class="comment"> * General Public License for more details. +</font>00018 <font class="comment"> * +</font>00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef UNICODERTF_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define UNICODERTF_H +</font>00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_unicodertf.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_unicodertf.html">UnicodeRTF</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> { +00031 <font class="keyword">public</font>: +00032 UnicodeRTF(); +00033 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *key); +00034 }; +00035 +00036 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/unicodertf_8h-source.html b/doc/api-documentation/html/unicodertf_8h-source.html new file mode 100644 index 0000000..22ff11d --- /dev/null +++ b/doc/api-documentation/html/unicodertf_8h-source.html @@ -0,0 +1,49 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>unicodertf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>unicodertf.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: unicodertf_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef UNICODERTF_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define UNICODERTF_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_unicode_r_t_f.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_unicode_r_t_f.html">UnicodeRTF</a>:<font class="keyword">public</font> SWFilter { +00031 <font class="keyword">public</font>: +00032 UnicodeRTF(); +00033 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00034 }; +00035 +00036 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/unicodertf_h-source.html b/doc/api-documentation/html/unicodertf_h-source.html new file mode 100644 index 0000000..4c38d64 --- /dev/null +++ b/doc/api-documentation/html/unicodertf_h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>unicodertf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>unicodertf.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * $Id: unicodertf_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00006 <font class="comment"> * CrossWire Bible Society</font> +00007 <font class="comment"> * P. O. Box 2528</font> +00008 <font class="comment"> * Tempe, AZ 85280-2528</font> +00009 <font class="comment"> *</font> +00010 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00011 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00012 <font class="comment"> * Free Software Foundation version 2.</font> +00013 <font class="comment"> *</font> +00014 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00015 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00016 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00017 <font class="comment"> * General Public License for more details.</font> +00018 <font class="comment"> *</font> +00019 <font class="comment"> */</font> +00020 +00021 <font class="preprocessor">#ifndef UNICODERTF_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define UNICODERTF_H</font> +00023 <font class="preprocessor"></font> +00024 <font class="preprocessor">#include <swfilter.h></font> +00025 +00026 <font class="preprocessor">#include <defs.h></font> +00027 +<a name="l00030"></a><a class="code" href="class_unicodertf.html">00030</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_unicodertf.html">UnicodeRTF</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> { +00031 <font class="keyword">public</font>: +00032 UnicodeRTF(); +00033 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *key); +00034 }; +00035 +00036 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/unixstr.h-source.html b/doc/api-documentation/html/unixstr.h-source.html new file mode 100644 index 0000000..635d8f8 --- /dev/null +++ b/doc/api-documentation/html/unixstr.h-source.html @@ -0,0 +1,43 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>unixstr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>unixstr.h</h1><div class="fragment"><pre>00001 <font class="comment">// Include only if your UNIX compiler does not include stricmp but does include strcasecmp</font> +00002 <font class="comment">/* +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: unixstr.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef UNIXSTR_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define UNIXSTR_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#include <string.h></font> +00025 +00026 <font class="keywordtype">int</font> stricmp (<font class="keyword">const</font> <font class="keywordtype">char</font> *s1, <font class="keyword">const</font> <font class="keywordtype">char</font> *s2); +00027 +00028 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/unixstr_8h-source.html b/doc/api-documentation/html/unixstr_8h-source.html new file mode 100644 index 0000000..867efe7 --- /dev/null +++ b/doc/api-documentation/html/unixstr_8h-source.html @@ -0,0 +1,43 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>unixstr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>unixstr.h</h1><div class="fragment"><pre>00001 <font class="comment">// Include only if your UNIX compiler does not include stricmp but does include strcasecmp</font> +00002 <font class="comment">/*</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: unixstr_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef UNIXSTR_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define UNIXSTR_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#include <string.h></font> +00025 +00026 <font class="keywordtype">int</font> stricmp (<font class="keyword">const</font> <font class="keywordtype">char</font> *s1, <font class="keyword">const</font> <font class="keywordtype">char</font> *s2); +00027 +00028 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/unixstr_h-source.html b/doc/api-documentation/html/unixstr_h-source.html new file mode 100644 index 0000000..e94f152 --- /dev/null +++ b/doc/api-documentation/html/unixstr_h-source.html @@ -0,0 +1,44 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>unixstr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>unixstr.h</h1><div class="fragment"><pre>00001 <font class="comment">// Include only if your UNIX compiler does not include stricmp but does include strcasecmp</font> +00002 <font class="comment">/*</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: unixstr_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef UNIXSTR_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define UNIXSTR_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#include <string.h></font> +00025 +00026 <font class="keywordtype">int</font> stricmp (<font class="keyword">const</font> <font class="keywordtype">char</font> *s1, <font class="keyword">const</font> <font class="keywordtype">char</font> *s2); +00027 +00028 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/untgz.h-source.html b/doc/api-documentation/html/untgz.h-source.html new file mode 100644 index 0000000..704a2d6 --- /dev/null +++ b/doc/api-documentation/html/untgz.h-source.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>untgz.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>untgz.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef UNTGZ_H +</font>00002 <font class="preprocessor"></font><font class="preprocessor">#define UNTGZ_H +</font>00003 <font class="preprocessor"></font> +00004 <font class="preprocessor">#include "zlib.h"</font> +00005 +00006 <font class="keywordtype">int</font> untargz(<font class="keywordtype">int</font> fd, <font class="keyword">const</font> <font class="keywordtype">char</font> *dest); +00007 <font class="keywordtype">int</font> untar(gzFile in, <font class="keyword">const</font> <font class="keywordtype">char</font> *dest); +00008 +00009 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/untgz_8h-source.html b/doc/api-documentation/html/untgz_8h-source.html new file mode 100644 index 0000000..4036c70 --- /dev/null +++ b/doc/api-documentation/html/untgz_8h-source.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>untgz.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>untgz.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef UNTGZ_H</font> +00002 <font class="preprocessor"></font><font class="preprocessor">#define UNTGZ_H</font> +00003 <font class="preprocessor"></font> +00004 <font class="preprocessor">#include "zlib.h"</font> +00005 +00006 <font class="keywordtype">int</font> untargz(<font class="keywordtype">int</font> fd, <font class="keyword">const</font> <font class="keywordtype">char</font> *dest); +00007 <font class="keywordtype">int</font> untar(gzFile in, <font class="keyword">const</font> <font class="keywordtype">char</font> *dest); +00008 +00009 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/untgz_h-source.html b/doc/api-documentation/html/untgz_h-source.html new file mode 100644 index 0000000..46a3ae3 --- /dev/null +++ b/doc/api-documentation/html/untgz_h-source.html @@ -0,0 +1,25 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>untgz.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>untgz.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef UNTGZ_H</font> +00002 <font class="preprocessor"></font><font class="preprocessor">#define UNTGZ_H</font> +00003 <font class="preprocessor"></font> +00004 <font class="preprocessor">#include "zlib.h"</font> +00005 +00006 <font class="keywordtype">int</font> untargz(<font class="keywordtype">int</font> fd, <font class="keyword">const</font> <font class="keywordtype">char</font> *dest); +00007 <font class="keywordtype">int</font> untar(gzFile in, <font class="keyword">const</font> <font class="keywordtype">char</font> *dest); +00008 +00009 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf16utf8_8h-source.html b/doc/api-documentation/html/utf16utf8_8h-source.html new file mode 100644 index 0000000..9475854 --- /dev/null +++ b/doc/api-documentation/html/utf16utf8_8h-source.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf16utf8.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf16utf8.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF16UTF8_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF16UTF8_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_u_t_f16_u_t_f8.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_u_t_f16_u_t_f8.html">UTF16UTF8</a>:<font class="keyword">public</font> SWFilter { +00030 <font class="keyword">public</font>: +00031 UTF16UTF8(); +00032 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf16utf8_h-source.html b/doc/api-documentation/html/utf16utf8_h-source.html new file mode 100644 index 0000000..6911fdc --- /dev/null +++ b/doc/api-documentation/html/utf16utf8_h-source.html @@ -0,0 +1,49 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf16utf8.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf16utf8.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF16UTF8_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF16UTF8_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_utf16utf8.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_utf16utf8.html">UTF16UTF8</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> { +00030 <font class="keyword">public</font>: +00031 UTF16UTF8(); +00032 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *key); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8arshaping_8h-source.html b/doc/api-documentation/html/utf8arshaping_8h-source.html new file mode 100644 index 0000000..87e671b --- /dev/null +++ b/doc/api-documentation/html/utf8arshaping_8h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8arshaping.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8arshaping.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)</font> +00004 <font class="comment"> * CrossWire Bible Society</font> +00005 <font class="comment"> * P. O. Box 2528</font> +00006 <font class="comment"> * Tempe, AZ 85280-2528</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00009 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00010 <font class="comment"> * Free Software Foundation version 2.</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00013 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00014 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00015 <font class="comment"> * General Public License for more details.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> */</font> +00018 <font class="preprocessor">#ifdef _ICU_</font> +00019 <font class="preprocessor"></font> +00020 <font class="preprocessor">#ifndef UTF8ARSHAPING_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8ARSHAPING_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <unicode/utypes.h></font> +00026 <font class="preprocessor">#include <unicode/ucnv.h></font> +00027 <font class="preprocessor">#include <unicode/uchar.h></font> +00028 <font class="preprocessor">#include <unicode/ushape.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00034 <font class="keyword">class </font>SWDLLEXPORT UTF8arShaping : <font class="keyword">public</font> SWFilter +00035 { +00036 <font class="keyword">private</font>: +00037 UConverter* conv; +00038 UErrorCode err; +00039 <font class="keyword">public</font>: +00040 UTF8arShaping(); +00041 ~UTF8arShaping(); +00042 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00043 }; +00044 +00045 <font class="preprocessor">#endif</font> +00046 <font class="preprocessor"></font> +00047 <font class="preprocessor">#endif</font> +00048 <font class="preprocessor"></font> +</pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8bidireorder_8h-source.html b/doc/api-documentation/html/utf8bidireorder_8h-source.html new file mode 100644 index 0000000..b729ff4 --- /dev/null +++ b/doc/api-documentation/html/utf8bidireorder_8h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8bidireorder.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8bidireorder.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)</font> +00004 <font class="comment"> * CrossWire Bible Society</font> +00005 <font class="comment"> * P. O. Box 2528</font> +00006 <font class="comment"> * Tempe, AZ 85280-2528</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00009 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00010 <font class="comment"> * Free Software Foundation version 2.</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00013 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00014 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00015 <font class="comment"> * General Public License for more details.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> */</font> +00018 <font class="preprocessor">#ifdef _ICU_</font> +00019 <font class="preprocessor"></font> +00020 <font class="preprocessor">#ifndef UTF8BIDIREORDER_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8BIDIREORDER_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <unicode/utypes.h></font> +00026 <font class="preprocessor">#include <unicode/ucnv.h></font> +00027 <font class="preprocessor">#include <unicode/uchar.h></font> +00028 <font class="preprocessor">#include <unicode/bidi.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00034 <font class="keyword">class </font>SWDLLEXPORT UTF8BiDiReorder : <font class="keyword">public</font> SWFilter +00035 { +00036 <font class="keyword">private</font>: +00037 UConverter* conv; +00038 UErrorCode err; +00039 <font class="keyword">public</font>: +00040 UTF8BiDiReorder(); +00041 ~UTF8BiDiReorder(); +00042 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00043 }; +00044 +00045 <font class="preprocessor">#endif</font> +00046 <font class="preprocessor"></font> +00047 <font class="preprocessor">#endif</font> +00048 <font class="preprocessor"></font> +</pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8cantillation_8h-source.html b/doc/api-documentation/html/utf8cantillation_8h-source.html new file mode 100644 index 0000000..9b078ae --- /dev/null +++ b/doc/api-documentation/html/utf8cantillation_8h-source.html @@ -0,0 +1,70 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8cantillation.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8cantillation.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF8CANTILLATION_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8CANTILLATION_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_u_t_f8_cantillation.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_u_t_f8_cantillation.html">UTF8Cantillation</a>:<font class="keyword">public</font> SWFilter +00030 { +00031 <font class="keywordtype">bool</font> option; +00032 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00036 OptionsList options; +00037 <font class="keyword">public</font>: +00038 UTF8Cantillation (); +00039 <font class="keyword">virtual</font> ~ UTF8Cantillation (); +00040 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00041 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00042 <font class="keyword"> </font>{ +00043 <font class="keywordflow">return</font> optName; +00044 } +00045 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> optTip; +00048 } +00049 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00050 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00051 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> options; +00054 } +00055 }; +00056 +00057 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:48 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8cantillation_h-source.html b/doc/api-documentation/html/utf8cantillation_h-source.html new file mode 100644 index 0000000..b4b203e --- /dev/null +++ b/doc/api-documentation/html/utf8cantillation_h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8cantillation.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8cantillation.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF8CANTILLATION_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8CANTILLATION_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_utf8cantillation.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_utf8cantillation.html">UTF8Cantillation</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00030 { +00031 <font class="keywordtype">bool</font> option; +00032 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00036 OptionsList options; +00037 <font class="keyword">public</font>: +00038 UTF8Cantillation (); +00039 <font class="keyword">virtual</font> ~ UTF8Cantillation (); +00040 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +<a name="l00041"></a><a class="code" href="class_utf8cantillation.html#a3">00041</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"></font> +00042 <font class="keyword"> </font>{ +00043 <font class="keywordflow">return</font> optName; +00044 } +<a name="l00045"></a><a class="code" href="class_utf8cantillation.html#a4">00045</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"></font> +00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> optTip; +00048 } +00049 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00050 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00051"></a><a class="code" href="class_utf8cantillation.html#a7">00051</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> options; +00054 } +00055 }; +00056 +00057 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8greekaccents_8h-source.html b/doc/api-documentation/html/utf8greekaccents_8h-source.html new file mode 100644 index 0000000..ef333ce --- /dev/null +++ b/doc/api-documentation/html/utf8greekaccents_8h-source.html @@ -0,0 +1,70 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8greekaccents.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8greekaccents.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF8GREEKACCENTS_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8GREEKACCENTS_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_u_t_f8_greek_accents.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_u_t_f8_greek_accents.html">UTF8GreekAccents</a>:<font class="keyword">public</font> SWFilter +00030 { +00031 <font class="keywordtype">bool</font> option; +00032 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00036 OptionsList options; +00037 <font class="keyword">public</font>: +00038 UTF8GreekAccents (); +00039 <font class="keyword">virtual</font> ~ UTF8GreekAccents (); +00040 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00041 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00042 <font class="keyword"> </font>{ +00043 <font class="keywordflow">return</font> optName; +00044 } +00045 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> optTip; +00048 } +00049 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00050 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00051 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> options; +00054 } +00055 }; +00056 +00057 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8greekaccents_h-source.html b/doc/api-documentation/html/utf8greekaccents_h-source.html new file mode 100644 index 0000000..6f43651 --- /dev/null +++ b/doc/api-documentation/html/utf8greekaccents_h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8greekaccents.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8greekaccents.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF8GREEKACCENTS_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8GREEKACCENTS_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_utf8greekaccents.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_utf8greekaccents.html">UTF8GreekAccents</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00030 { +00031 <font class="keywordtype">bool</font> option; +00032 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00036 OptionsList options; +00037 <font class="keyword">public</font>: +00038 UTF8GreekAccents (); +00039 <font class="keyword">virtual</font> ~ UTF8GreekAccents (); +00040 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +<a name="l00041"></a><a class="code" href="class_utf8greekaccents.html#a3">00041</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"></font> +00042 <font class="keyword"> </font>{ +00043 <font class="keywordflow">return</font> optName; +00044 } +<a name="l00045"></a><a class="code" href="class_utf8greekaccents.html#a4">00045</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"></font> +00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> optTip; +00048 } +00049 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00050 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00051"></a><a class="code" href="class_utf8greekaccents.html#a7">00051</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> options; +00054 } +00055 }; +00056 +00057 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8hebrewpoints_8h-source.html b/doc/api-documentation/html/utf8hebrewpoints_8h-source.html new file mode 100644 index 0000000..b16ec30 --- /dev/null +++ b/doc/api-documentation/html/utf8hebrewpoints_8h-source.html @@ -0,0 +1,70 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8hebrewpoints.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8hebrewpoints.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF8HEBREWPOINTS_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8HEBREWPOINTS_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_u_t_f8_hebrew_points.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_u_t_f8_hebrew_points.html">UTF8HebrewPoints</a>:<font class="keyword">public</font> SWFilter +00030 { +00031 <font class="keywordtype">bool</font> option; +00032 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00036 OptionsList options; +00037 <font class="keyword">public</font>: +00038 UTF8HebrewPoints (); +00039 <font class="keyword">virtual</font> ~ UTF8HebrewPoints (); +00040 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00041 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00042 <font class="keyword"> </font>{ +00043 <font class="keywordflow">return</font> optName; +00044 } +00045 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> optTip; +00048 } +00049 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00050 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00051 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> options; +00054 } +00055 }; +00056 +00057 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8hebrewpoints_h-source.html b/doc/api-documentation/html/utf8hebrewpoints_h-source.html new file mode 100644 index 0000000..d329561 --- /dev/null +++ b/doc/api-documentation/html/utf8hebrewpoints_h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8hebrewpoints.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8hebrewpoints.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF8HEBREWPOINTS_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8HEBREWPOINTS_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_utf8hebrewpoints.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_utf8hebrewpoints.html">UTF8HebrewPoints</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00030 { +00031 <font class="keywordtype">bool</font> option; +00032 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> on[]; +00033 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> off[]; +00034 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00035 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00036 OptionsList options; +00037 <font class="keyword">public</font>: +00038 UTF8HebrewPoints (); +00039 <font class="keyword">virtual</font> ~ UTF8HebrewPoints (); +00040 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +<a name="l00041"></a><a class="code" href="class_utf8hebrewpoints.html#a3">00041</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"></font> +00042 <font class="keyword"> </font>{ +00043 <font class="keywordflow">return</font> optName; +00044 } +<a name="l00045"></a><a class="code" href="class_utf8hebrewpoints.html#a4">00045</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"></font> +00046 <font class="keyword"> </font>{ +00047 <font class="keywordflow">return</font> optTip; +00048 } +00049 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00050 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +<a name="l00051"></a><a class="code" href="class_utf8hebrewpoints.html#a7">00051</a> <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> options; +00054 } +00055 }; +00056 +00057 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8html_8h-source.html b/doc/api-documentation/html/utf8html_8h-source.html new file mode 100644 index 0000000..4b76d18 --- /dev/null +++ b/doc/api-documentation/html/utf8html_8h-source.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8html.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8html.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF8HTML_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8HTML_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_u_t_f8_h_t_m_l.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_u_t_f8_h_t_m_l.html">UTF8HTML</a>:<font class="keyword">public</font> SWFilter { +00030 <font class="keyword">public</font>: +00031 UTF8HTML(); +00032 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8latin1_8h-source.html b/doc/api-documentation/html/utf8latin1_8h-source.html new file mode 100644 index 0000000..02d9e45 --- /dev/null +++ b/doc/api-documentation/html/utf8latin1_8h-source.html @@ -0,0 +1,49 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8latin1.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8latin1.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF8Latin1_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8Latin1_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_u_t_f8_latin1.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_u_t_f8_latin1.html">UTF8Latin1</a>:<font class="keyword">public</font> SWFilter { +00030 <font class="keywordtype">char</font> replacementChar; +00031 <font class="keyword">public</font>: +00032 UTF8Latin1(<font class="keywordtype">char</font> rchar = <font class="charliteral">'?'</font>); +00033 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00034 }; +00035 +00036 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8nfc_8h-source.html b/doc/api-documentation/html/utf8nfc_8h-source.html new file mode 100644 index 0000000..caba6c4 --- /dev/null +++ b/doc/api-documentation/html/utf8nfc_8h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8nfc.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8nfc.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)</font> +00004 <font class="comment"> * CrossWire Bible Society</font> +00005 <font class="comment"> * P. O. Box 2528</font> +00006 <font class="comment"> * Tempe, AZ 85280-2528</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00009 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00010 <font class="comment"> * Free Software Foundation version 2.</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00013 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00014 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00015 <font class="comment"> * General Public License for more details.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> */</font> +00018 <font class="preprocessor">#ifdef _ICU_</font> +00019 <font class="preprocessor"></font> +00020 <font class="preprocessor">#ifndef UTF8NFC_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8NFC_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <unicode/utypes.h></font> +00026 <font class="preprocessor">#include <unicode/ucnv.h></font> +00027 <font class="preprocessor">#include <unicode/uchar.h></font> +00028 <font class="preprocessor">#include <unicode/unorm.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT UTF8NFC : <font class="keyword">public</font> SWFilter +00033 { +00034 <font class="keyword">private</font>: +00035 UConverter* conv; +00036 UChar *source, *target; +00037 UErrorCode err; +00038 <font class="keyword">public</font>: +00039 UTF8NFC(); +00040 ~UTF8NFC(); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00042 }; +00043 +00044 <font class="preprocessor">#endif</font> +00045 <font class="preprocessor"></font> +00046 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8nfkd_8h-source.html b/doc/api-documentation/html/utf8nfkd_8h-source.html new file mode 100644 index 0000000..2df26f6 --- /dev/null +++ b/doc/api-documentation/html/utf8nfkd_8h-source.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8nfkd.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8nfkd.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)</font> +00004 <font class="comment"> * CrossWire Bible Society</font> +00005 <font class="comment"> * P. O. Box 2528</font> +00006 <font class="comment"> * Tempe, AZ 85280-2528</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00009 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00010 <font class="comment"> * Free Software Foundation version 2.</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00013 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00014 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00015 <font class="comment"> * General Public License for more details.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> */</font> +00018 <font class="preprocessor">#ifdef _ICU_</font> +00019 <font class="preprocessor"></font> +00020 <font class="preprocessor">#ifndef UTF8NFKD_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8NFKD_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <unicode/utypes.h></font> +00026 <font class="preprocessor">#include <unicode/ucnv.h></font> +00027 <font class="preprocessor">#include <unicode/uchar.h></font> +00028 <font class="preprocessor">#include <unicode/unorm.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT UTF8NFKD : <font class="keyword">public</font> SWFilter +00033 { +00034 <font class="keyword">private</font>: +00035 UConverter* conv; +00036 UChar *source, *target; +00037 UErrorCode err; +00038 <font class="keyword">public</font>: +00039 UTF8NFKD(); +00040 ~UTF8NFKD(); +00041 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00042 }; +00043 +00044 <font class="preprocessor">#endif</font> +00045 <font class="preprocessor"></font> +00046 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8transliterator_8h-source.html b/doc/api-documentation/html/utf8transliterator_8h-source.html new file mode 100644 index 0000000..a0d9f47 --- /dev/null +++ b/doc/api-documentation/html/utf8transliterator_8h-source.html @@ -0,0 +1,86 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8transliterator.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8transliterator.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)</font> +00004 <font class="comment"> * CrossWire Bible Society</font> +00005 <font class="comment"> * P. O. Box 2528</font> +00006 <font class="comment"> * Tempe, AZ 85280-2528</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00009 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00010 <font class="comment"> * Free Software Foundation version 2.</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00013 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00014 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00015 <font class="comment"> * General Public License for more details.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> */</font> +00018 <font class="preprocessor">#ifdef _ICU_</font> +00019 <font class="preprocessor"></font> +00020 <font class="preprocessor">#ifndef UTF8TRANSLITERATOR_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8TRANSLITERATOR_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="keyword">enum</font> scriptEnum {SE_OFF, SE_LATIN, <font class="comment">/*one-way (to) transliterators*/</font> SE_BASICLATIN, SE_BETA, SE_BGREEK, <font class="comment">/*two-way transliterators*/</font> SE_GREEK, SE_HEBREW, SE_CYRILLIC, SE_ARABIC, SE_SYRIAC, SE_KATAKANA, SE_HIRAGANA, SE_JAMO, SE_HANGUL, SE_DEVANAGARI, SE_TAMIL, SE_BENGALI, SE_GURMUKHI, SE_GUJARATI, SE_ORIYA, SE_TELUGU, SE_KANNADA, SE_MALAYALAM, SE_THAI, SE_GEORGIAN, SE_ARMENIAN, SE_ETHIOPIC, SE_GOTHIC, SE_UGARITIC, SE_COPTIC, <font class="comment">/*one-way (from) transliterators*/</font> SE_HAN, SE_KANJI}; +00024 <font class="preprocessor">#define NUMSCRIPTS 32</font> +00025 <font class="preprocessor"></font><font class="preprocessor">#define NUMTARGETSCRIPTS 5</font> +00026 <font class="preprocessor"></font> +00027 <font class="preprocessor">#include <swfilter.h></font> +00028 <font class="preprocessor">#include <swmodule.h></font> +00029 +00030 <font class="preprocessor">#include <unicode/utypes.h></font> +00031 <font class="preprocessor">#include <unicode/ucnv.h></font> +00032 <font class="preprocessor">#include <unicode/ustring.h></font> +00033 <font class="preprocessor">#include <unicode/uchar.h></font> +00034 +00035 <font class="preprocessor">#include <unicode/unistr.h></font> +00036 <font class="preprocessor">#include <unicode/translit.h></font> +00037 +00038 <font class="preprocessor">#include <defs.h></font> +00039 +00042 <font class="keyword">class </font>SWDLLEXPORT UTF8Transliterator : <font class="keyword">public</font> SWFilter +00043 { +00044 <font class="keywordtype">char</font> option; +00045 +00046 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optionstring[NUMTARGETSCRIPTS][16]; +00047 +00048 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00049 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00050 OptionsList options; +00051 +00052 <font class="keyword">public</font>: +00053 UTF8Transliterator (); +00054 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00055 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionName ()<font class="keyword"></font> +00056 <font class="keyword"> </font>{ +00057 <font class="keywordflow">return</font> optName; +00058 } +00059 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionTip ()<font class="keyword"></font> +00060 <font class="keyword"> </font>{ +00061 <font class="keywordflow">return</font> optTip; +00062 } +00063 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOptionValue (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00064 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00065 <font class="keyword">virtual</font> OptionsList getOptionValues ()<font class="keyword"></font> +00066 <font class="keyword"> </font>{ +00067 <font class="keywordflow">return</font> options; +00068 } +00069 }; +00070 +00071 <font class="preprocessor">#endif</font> +00072 <font class="preprocessor"></font> +00073 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8transliterator_h-source.html b/doc/api-documentation/html/utf8transliterator_h-source.html new file mode 100644 index 0000000..0aaaeeb --- /dev/null +++ b/doc/api-documentation/html/utf8transliterator_h-source.html @@ -0,0 +1,79 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8transliterator.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8transliterator.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)</font> +00004 <font class="comment"> * CrossWire Bible Society</font> +00005 <font class="comment"> * P. O. Box 2528</font> +00006 <font class="comment"> * Tempe, AZ 85280-2528</font> +00007 <font class="comment"> *</font> +00008 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00009 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00010 <font class="comment"> * Free Software Foundation version 2.</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00013 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00014 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00015 <font class="comment"> * General Public License for more details.</font> +00016 <font class="comment"> *</font> +00017 <font class="comment"> */</font> +00018 <font class="preprocessor">#ifdef ICU</font> +00019 <font class="preprocessor"></font> +00020 <font class="preprocessor">#ifndef UTF8TRANSLITERATOR_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8TRANSLITERATOR_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="keyword">enum</font> scriptEnum {SE_OFF, SE_LATIN, SE_GREEK, SE_HEBREW, SE_CYRILLIC, SE_ARABIC, SE_KANA, SE_JAMO, SE_HANGUL, SE_DEVANAGARI, SE_TAMIL, SE_BENGALI, SE_GURMUKHI, SE_GUJARATI, SE_ORIYA, SE_TELUGU, SE_KANNADA, SE_MALAYALAM}; +00024 +00025 +00026 <font class="preprocessor">#define NUMSCRIPTS 18</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include <swfilter.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00034 <font class="keyword">class </font>SWDLLEXPORT UTF8Transliterator : <font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> +00035 { +00036 <font class="keywordtype">char</font> option; +00037 +00038 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optionstring[][NUMSCRIPTS]; +00039 +00040 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optName[]; +00041 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> optTip[]; +00042 OptionsList options; +00043 <font class="keyword">public</font>: +00044 UTF8Transliterator (); +00045 <font class="keyword">virtual</font> ~ UTF8Transliterator (); +00046 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * key); +00047 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a1">getOptionName</a> ()<font class="keyword"></font> +00048 <font class="keyword"> </font>{ +00049 <font class="keywordflow">return</font> optName; +00050 } +00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swfilter.html#a2">getOptionTip</a> ()<font class="keyword"></font> +00052 <font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> optTip; +00054 } +00055 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swfilter.html#a4">setOptionValue</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ival); +00056 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getOptionValue (); +00057 <font class="keyword">virtual</font> OptionsList <a class="code" href="class_swfilter.html#a3">getOptionValues</a> ()<font class="keyword"></font> +00058 <font class="keyword"> </font>{ +00059 <font class="keywordflow">return</font> options; +00060 } +00061 }; +00062 +00063 <font class="preprocessor">#endif</font> +00064 <font class="preprocessor"></font> +00065 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8utf16_8h-source.html b/doc/api-documentation/html/utf8utf16_8h-source.html new file mode 100644 index 0000000..363ad5b --- /dev/null +++ b/doc/api-documentation/html/utf8utf16_8h-source.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8utf16.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8utf16.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF8UTF16_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8UTF16_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_u_t_f8_u_t_f16.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_u_t_f8_u_t_f16.html">UTF8UTF16</a>:<font class="keyword">public</font> SWFilter { +00030 <font class="keyword">public</font>: +00031 UTF8UTF16(); +00032 <font class="keyword">virtual</font> <font class="keywordtype">char</font> ProcessText (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> *key, <font class="keyword">const</font> <a class="code" href="class_s_w_module.html">SWModule</a> * = 0); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utf8utf16_h-source.html b/doc/api-documentation/html/utf8utf16_h-source.html new file mode 100644 index 0000000..162bc2c --- /dev/null +++ b/doc/api-documentation/html/utf8utf16_h-source.html @@ -0,0 +1,49 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utf8utf16.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utf8utf16.h</h1><div class="fragment"><pre>00001 <font class="comment">/*</font> +00002 <font class="comment"> *</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00005 <font class="comment"> * CrossWire Bible Society</font> +00006 <font class="comment"> * P. O. Box 2528</font> +00007 <font class="comment"> * Tempe, AZ 85280-2528</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00010 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00011 <font class="comment"> * Free Software Foundation version 2.</font> +00012 <font class="comment"> *</font> +00013 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00014 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00015 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00016 <font class="comment"> * General Public License for more details.</font> +00017 <font class="comment"> *</font> +00018 <font class="comment"> */</font> +00019 +00020 <font class="preprocessor">#ifndef UTF8UTF16_H</font> +00021 <font class="preprocessor"></font><font class="preprocessor">#define UTF8UTF16_H</font> +00022 <font class="preprocessor"></font> +00023 <font class="preprocessor">#include <swfilter.h></font> +00024 +00025 <font class="preprocessor">#include <defs.h></font> +00026 +<a name="l00029"></a><a class="code" href="class_utf8utf16.html">00029</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_utf8utf16.html">UTF8UTF16</a>:<font class="keyword">public</font> <a class="code" href="class_swfilter.html">SWFilter</a> { +00030 <font class="keyword">public</font>: +00031 UTF8UTF16(); +00032 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swfilter.html#a6">ProcessText</a> (<font class="keywordtype">char</font> *text, <font class="keywordtype">int</font> maxlen, <font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *key); +00033 }; +00034 +00035 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utilconf.h-source.html b/doc/api-documentation/html/utilconf.h-source.html new file mode 100644 index 0000000..ddb5760 --- /dev/null +++ b/doc/api-documentation/html/utilconf.h-source.html @@ -0,0 +1,23 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>utilconf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utilconf.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef UTILCONF_H +</font>00002 <font class="preprocessor"></font><font class="preprocessor">#define UTILCONF_H +</font>00003 <font class="preprocessor"></font> +00004 +00005 <font class="keywordtype">char</font> getconfent (<font class="keywordtype">char</font> *filename, <font class="keywordtype">char</font> *entryname, <font class="keywordtype">char</font> *buf, <font class="keywordtype">int</font> len); +00006 +00007 +00008 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utilconf_8h-source.html b/doc/api-documentation/html/utilconf_8h-source.html new file mode 100644 index 0000000..6d92f05 --- /dev/null +++ b/doc/api-documentation/html/utilconf_8h-source.html @@ -0,0 +1,23 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utilconf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utilconf.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef UTILCONF_H</font> +00002 <font class="preprocessor"></font><font class="preprocessor">#define UTILCONF_H</font> +00003 <font class="preprocessor"></font> +00004 +00005 <font class="keywordtype">char</font> getconfent (<font class="keywordtype">char</font> *filename, <font class="keywordtype">char</font> *entryname, <font class="keywordtype">char</font> *buf, <font class="keywordtype">int</font> len); +00006 +00007 +00008 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utilconf_h-source.html b/doc/api-documentation/html/utilconf_h-source.html new file mode 100644 index 0000000..d7c4d21 --- /dev/null +++ b/doc/api-documentation/html/utilconf_h-source.html @@ -0,0 +1,24 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utilconf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utilconf.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef UTILCONF_H</font> +00002 <font class="preprocessor"></font><font class="preprocessor">#define UTILCONF_H</font> +00003 <font class="preprocessor"></font> +00004 +00005 <font class="keywordtype">char</font> getconfent (<font class="keywordtype">char</font> *filename, <font class="keywordtype">char</font> *entryname, <font class="keywordtype">char</font> *buf, <font class="keywordtype">int</font> len); +00006 +00007 +00008 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utilfuns.h-source.html b/doc/api-documentation/html/utilfuns.h-source.html new file mode 100644 index 0000000..11cd17d --- /dev/null +++ b/doc/api-documentation/html/utilfuns.h-source.html @@ -0,0 +1,44 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>utilfuns.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utilfuns.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * utilfuns.h - utility function prototypes +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: utilfuns.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 <font class="preprocessor">#ifndef UTILFUNS_H +</font>00022 <font class="preprocessor"></font><font class="preprocessor">#define UTILFUNS_H +</font>00023 <font class="preprocessor"></font> +00024 +00025 <font class="preprocessor">#include <utilstr.h></font> +00026 <font class="preprocessor">#include <utilconf.h></font> +00027 +00028 +00029 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utilfuns_8h-source.html b/doc/api-documentation/html/utilfuns_8h-source.html new file mode 100644 index 0000000..97ec005 --- /dev/null +++ b/doc/api-documentation/html/utilfuns_8h-source.html @@ -0,0 +1,44 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utilfuns.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utilfuns.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * utilfuns.h - utility function prototypes</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: utilfuns_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 <font class="preprocessor">#ifndef UTILFUNS_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define UTILFUNS_H</font> +00023 <font class="preprocessor"></font> +00024 +00025 <font class="preprocessor">#include <utilstr.h></font> +00026 <font class="preprocessor">#include <utilconf.h></font> +00027 +00028 +00029 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utilfuns_h-source.html b/doc/api-documentation/html/utilfuns_h-source.html new file mode 100644 index 0000000..a109dbf --- /dev/null +++ b/doc/api-documentation/html/utilfuns_h-source.html @@ -0,0 +1,45 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utilfuns.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utilfuns.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * utilfuns.h - utility function prototypes</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: utilfuns_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 <font class="preprocessor">#ifndef UTILFUNS_H</font> +00022 <font class="preprocessor"></font><font class="preprocessor">#define UTILFUNS_H</font> +00023 <font class="preprocessor"></font> +00024 +00025 <font class="preprocessor">#include <utilstr.h></font> +00026 <font class="preprocessor">#include <utilconf.h></font> +00027 +00028 +00029 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utilstr.h-source.html b/doc/api-documentation/html/utilstr.h-source.html new file mode 100644 index 0000000..f4d06f9 --- /dev/null +++ b/doc/api-documentation/html/utilstr.h-source.html @@ -0,0 +1,50 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>utilstr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utilstr.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * utilstr.h - prototypes for string utility functions +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: utilstr.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef UTILSTR_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define UTILSTR_H +</font>00024 <font class="preprocessor"></font> +00027 <font class="keywordtype">char</font> *stdstr (<font class="keywordtype">char</font> **iistr, <font class="keyword">const</font> <font class="keywordtype">char</font> *istr); +00028 <font class="keywordtype">char</font> *strstrip (<font class="keywordtype">char</font> *istr); +00029 <font class="keyword">const</font> <font class="keywordtype">char</font> *stristr (<font class="keyword">const</font> <font class="keywordtype">char</font> *s1, <font class="keyword">const</font> <font class="keywordtype">char</font> *s2); +00030 <font class="keyword">const</font> <font class="keywordtype">char</font> strnicmp(<font class="keyword">const</font> <font class="keywordtype">char</font> *s1, <font class="keyword">const</font> <font class="keywordtype">char</font> *s2, <font class="keywordtype">int</font> len); +00031 +00032 <font class="comment">/* +</font>00033 <font class="comment">extern "C" { +</font>00034 <font class="comment">int stricmp(const char *s1, const char *s2); +</font>00035 <font class="comment">} +</font>00036 <font class="comment">*/</font> +00037 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utilstr_8h-source.html b/doc/api-documentation/html/utilstr_8h-source.html new file mode 100644 index 0000000..e658f0e --- /dev/null +++ b/doc/api-documentation/html/utilstr_8h-source.html @@ -0,0 +1,96 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utilstr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utilstr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * utilstr.h - prototypes for string utility functions</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: utilstr_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef UTILSTR_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define UTILSTR_H</font> +00024 <font class="preprocessor"></font> +00027 <font class="keywordtype">char</font> *stdstr (<font class="keywordtype">char</font> **iistr, <font class="keyword">const</font> <font class="keywordtype">char</font> *istr); +00028 <font class="keywordtype">char</font> *strstrip (<font class="keywordtype">char</font> *istr); +00029 <font class="keyword">const</font> <font class="keywordtype">char</font> *stristr (<font class="keyword">const</font> <font class="keywordtype">char</font> *s1, <font class="keyword">const</font> <font class="keywordtype">char</font> *s2); +00030 <font class="keyword">const</font> <font class="keywordtype">char</font> strnicmp(<font class="keyword">const</font> <font class="keywordtype">char</font> *s1, <font class="keyword">const</font> <font class="keywordtype">char</font> *s2, <font class="keywordtype">int</font> len); +00031 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> strlenw(<font class="keyword">const</font> <font class="keywordtype">char</font> *s1); +00032 <font class="keywordtype">char</font> *toupperstr(<font class="keywordtype">char</font> *buf); +00033 +00034 <font class="comment">/*</font> +00035 <font class="comment">extern "C" {</font> +00036 <font class="comment">int stricmp(const char *s1, const char *s2);</font> +00037 <font class="comment">}</font> +00038 <font class="comment">*/</font> +00039 +00040 <font class="comment">/******************************************************************************</font> +00041 <font class="comment"> * SW_toupper - array of uppercase values for any given Latin-1 value</font> +00042 <font class="comment"> *</font> +00043 <font class="comment"> * use this instead of toupper() for fast lookups on accented characters</font> +00044 <font class="comment"> */</font> +00045 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> SW_toupper_array[256] = +00046 { +00047 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, +00048 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f, +00049 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, +00050 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, +00051 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, +00052 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f, +00053 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, +00054 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f, +00055 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, +00056 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f, +00057 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, +00058 0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f, +00059 0x60, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, +00060 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f, +00061 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, +00062 0x58, 0x59, 0x5a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f, +00063 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, +00064 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, +00065 0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, +00066 0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f, +00067 0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, +00068 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf, +00069 0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7, +00070 0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf, +00071 0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7, +00072 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf, +00073 0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, +00074 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf, +00075 0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7, +00076 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf, +00077 0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xf7, +00078 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xff +00079 }; +00080 +00081 <font class="preprocessor">#define SW_toupper(c) SW_toupper_array[(unsigned char)c]</font> +00082 <font class="preprocessor"></font> +00083 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/utilstr_h-source.html b/doc/api-documentation/html/utilstr_h-source.html new file mode 100644 index 0000000..2816220 --- /dev/null +++ b/doc/api-documentation/html/utilstr_h-source.html @@ -0,0 +1,53 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>utilstr.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>utilstr.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * utilstr.h - prototypes for string utility functions</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: utilstr_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef UTILSTR_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define UTILSTR_H</font> +00024 <font class="preprocessor"></font> +00027 <font class="keywordtype">char</font> *stdstr (<font class="keywordtype">char</font> **iistr, <font class="keyword">const</font> <font class="keywordtype">char</font> *istr); +00028 <font class="keywordtype">char</font> *strstrip (<font class="keywordtype">char</font> *istr); +00029 <font class="keyword">const</font> <font class="keywordtype">char</font> *stristr (<font class="keyword">const</font> <font class="keywordtype">char</font> *s1, <font class="keyword">const</font> <font class="keywordtype">char</font> *s2); +00030 <font class="keyword">const</font> <font class="keywordtype">char</font> strnicmp(<font class="keyword">const</font> <font class="keywordtype">char</font> *s1, <font class="keyword">const</font> <font class="keywordtype">char</font> *s2, <font class="keywordtype">int</font> len); +00031 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> strlenw(<font class="keyword">const</font> <font class="keywordtype">char</font> *s1); +00032 <font class="keywordtype">char</font> *toupperstr(<font class="keywordtype">char</font> *buf); +00033 +00034 <font class="comment">/*</font> +00035 <font class="comment">extern "C" {</font> +00036 <font class="comment">int stricmp(const char *s1, const char *s2);</font> +00037 <font class="comment">}</font> +00038 <font class="comment">*/</font> +00039 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/versekey.h-source.html b/doc/api-documentation/html/versekey.h-source.html new file mode 100644 index 0000000..6e9d331 --- /dev/null +++ b/doc/api-documentation/html/versekey.h-source.html @@ -0,0 +1,221 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>versekey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>versekey.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * versekey.h - code for class 'versekey'- a standard Biblical verse key +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: versekey.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 +00023 <font class="preprocessor">#ifndef VERSEKEY_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define VERSEKEY_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swkey.h></font> +00027 <font class="preprocessor">#include <swmacs.h></font> +00028 <font class="preprocessor">#include <listkey.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="preprocessor">#define POS_MAXVERSE ((char)3) +</font>00033 <font class="preprocessor"></font><font class="preprocessor">#define POS_MAXCHAPTER ((char)4) +</font>00034 <font class="preprocessor"></font><font class="preprocessor">#define POS_MAXBOOK ((char)5) +</font>00035 <font class="preprocessor"></font> +00036 <font class="preprocessor">#define MAXVERSE SW_POSITION(POS_MAXVERSE) +</font>00037 <font class="preprocessor"></font><font class="preprocessor">#define MAXCHAPTER SW_POSITION(POS_MAXCHAPTER) +</font>00038 <font class="preprocessor"></font><font class="preprocessor">#define MAXBOOK SW_POSITION(POS_MAXBOOK) +</font>00039 <font class="preprocessor"></font> +00040 <font class="keyword">struct </font>sbook +00041 { +00044 <font class="keyword">const</font> <font class="keywordtype">char</font> *name; +00047 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> chapmax; +00050 <font class="keywordtype">int</font> *versemax; +00051 }; +00052 +00053 <font class="keyword">struct </font>abbrev +00054 { +00055 <font class="keyword">const</font> <font class="keywordtype">char</font> *ab; +00056 <font class="keywordtype">int</font> book; +00057 }; +00058 +00059 +00060 <font class="keyword">class </font><a class="code" href="class_swlocale.html">SWLocale</a>; +00061 +<a name="l00066"></a><a class="code" href="class_versekey.html">00066</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_versekey.html">VerseKey</a>:<font class="keyword">public</font> <a class="code" href="class_swkey.html">SWKey</a> +00067 { +00068 <font class="keyword">class </font>LocaleCache +00069 { +00070 <font class="keyword">public</font>: +00071 <font class="keywordtype">char</font> *name; +00072 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> abbrevsCnt; +00073 <a class="code" href="class_swlocale.html">SWLocale</a> *locale; +00074 LocaleCache ()<font class="keyword"> +</font>00075 <font class="keyword"> </font>{ +00076 name = 0; +00077 abbrevsCnt = 0; +00078 locale = 0; +00079 } +00080 <font class="keyword">virtual</font> ~LocaleCache ()<font class="keyword"> +</font>00081 <font class="keyword"> </font>{ +00082 <font class="keywordflow">if</font> (name) +00083 <font class="keyword">delete</font>[]name; +00084 } +00085 }; +00086 +00087 <font class="keyword">static</font> SWClass classdef; +00088 +00089 <font class="keyword">static</font> <font class="keywordtype">long</font> *offsets[2][2]; +00090 <font class="keyword">static</font> <font class="keywordtype">int</font> offsize[2][2]; +<a name="l00093"></a><a class="code" href="class_versekey.html#r3">00093</a> <font class="keyword">static</font> <font class="keywordtype">int</font> instance; +00094 <font class="keyword">static</font> <font class="keyword">struct </font>sbook otbooks[]; +00095 <font class="keyword">static</font> <font class="keyword">struct </font>sbook ntbooks[]; +00096 <font class="keyword">static</font> <font class="keywordtype">long</font> otbks[]; +00097 <font class="keyword">static</font> <font class="keywordtype">long</font> otcps[]; +00098 <font class="keyword">static</font> <font class="keywordtype">long</font> ntbks[]; +00099 <font class="keyword">static</font> <font class="keywordtype">long</font> ntcps[]; +00100 <font class="keyword">static</font> <font class="keywordtype">int</font> vm[]; +00101 <font class="keyword">static</font> LocaleCache localeCache; +00102 <a class="code" href="class_listkey.html">ListKey</a> internalListKey; +00103 +00104 <font class="keyword">const</font> <font class="keyword">struct </font>abbrev *abbrevs; +00105 <font class="keywordtype">int</font> abbrevsCnt; +<a name="l00108"></a><a class="code" href="class_versekey.html#o3">00108</a> <font class="keywordtype">char</font> testament; +00109 <font class="keyword">mutable</font> <font class="keywordtype">char</font> book; +00110 <font class="keyword">mutable</font> <font class="keywordtype">int</font> chapter; +00111 <font class="keyword">mutable</font> <font class="keywordtype">int</font> verse; +<a name="l00114"></a><a class="code" href="class_versekey.html#o7">00114</a> <font class="keywordtype">char</font> autonorm; +<a name="l00117"></a><a class="code" href="class_versekey.html#o8">00117</a> <font class="keywordtype">char</font> headings; +00118 +00119 <font class="keywordtype">int</font> getBookAbbrev (<font class="keywordtype">char</font> *abbr); +00120 <font class="keywordtype">void</font> initBounds () <font class="keyword">const</font>; +00123 <font class="keywordtype">void</font> initstatics (); +00126 <font class="keywordtype">void</font> init (); +00131 <font class="keywordtype">void</font> freshtext () <font class="keyword">const</font>; +00135 <font class="keyword">virtual</font> <font class="keywordtype">char</font> parse (); +00144 <font class="keywordtype">int</font> findindex (<font class="keywordtype">long</font> *array, <font class="keywordtype">int</font> size, <font class="keywordtype">long</font> value); +00145 <font class="keyword">mutable</font> <a class="code" href="class_versekey.html">VerseKey</a> *lowerBound, *upperBound; +00146 +00147 <font class="keyword">public</font>: +00148 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> builtin_BMAX[2]; +00149 <font class="keyword">static</font> <font class="keyword">struct </font>sbook *builtin_books[2]; +00150 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keyword">struct </font>abbrev builtin_abbrevs[]; +00151 <font class="keyword">const</font> <font class="keywordtype">char</font> *BMAX; +00152 <font class="keyword">struct </font>sbook **books; +00153 +00160 VerseKey (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00161 +00168 VerseKey (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * ikey); +00169 +00176 VerseKey (<font class="keyword">const</font> <font class="keywordtype">char</font> *min, <font class="keyword">const</font> <font class="keywordtype">char</font> *max); +00177 +00183 VerseKey (<a class="code" href="class_versekey.html">VerseKey</a> <font class="keyword">const</font> &k); +00184 +00188 <font class="keyword">virtual</font> ~ VerseKey (); +00189 +00196 <a class="code" href="class_versekey.html">VerseKey</a> & LowerBound (<font class="keyword">const</font> <font class="keywordtype">char</font> *lb); +00197 +00203 <a class="code" href="class_versekey.html">VerseKey</a> & UpperBound (<font class="keyword">const</font> <font class="keywordtype">char</font> *ub); +00204 +00208 <a class="code" href="class_versekey.html">VerseKey</a> & LowerBound ()<font class="keyword">const</font>; +00209 +00213 <a class="code" href="class_versekey.html">VerseKey</a> & UpperBound ()<font class="keyword">const</font>; +00214 +00217 <font class="keywordtype">void</font> ClearBounds (); +00218 +00222 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swkey.html#a3">clone</a> () <font class="keyword">const</font>; +00223 +00227 <font class="keyword">virtual</font> operator const char *() <font class="keyword">const</font>; +<a name="l00228"></a><a class="code" href="class_versekey.html#a12">00228</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey)<font class="keyword"> </font>{ <a class="code" href="class_swkey.html">SWKey</a> & retval = +00229 <a class="code" href="class_swkey.html#a7">SWKey::operator = </a>(ikey); +00230 parse (); +00231 <font class="keywordflow">return</font> retval; +00232 } +00233 +00236 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey); +00237 +00240 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(<font class="keyword">const</font> <a class="code" href="class_versekey.html">VerseKey</a> & ikey); +00241 +00247 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a7"> operator = </a>(SW_POSITION); +00248 +00254 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a18"> operator -= </a>(<font class="keywordtype">int</font> decrement); +00255 +00261 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> &<a class="code" href="class_swkey.html#a19"> operator += </a>(<font class="keywordtype">int</font> increment); +00262 <font class="comment">/* +</font>00263 <font class="comment"> virtual VerseKey &operator ++(int) { return *this += 1; } +</font>00264 <font class="comment"> virtual VerseKey &operator --(int) { return *this -= 1; } +</font>00265 <font class="comment">*/</font> +00266 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable ()<font class="keyword"> +</font>00267 <font class="keyword"> </font>{ +00268 <font class="keywordflow">return</font> 1; +00269 } +00270 +00275 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Testament () <font class="keyword">const</font>; +00276 +00281 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Book () <font class="keyword">const</font>; +00282 +00287 <font class="keyword">virtual</font> <font class="keywordtype">int</font> Chapter () <font class="keyword">const</font>; +00288 +00293 <font class="keyword">virtual</font> <font class="keywordtype">int</font> Verse () <font class="keyword">const</font>; +00294 +00302 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Testament (<font class="keywordtype">char</font> itestament); +00303 +00311 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Book (<font class="keywordtype">char</font> ibook); +00312 +00320 <font class="keyword">virtual</font> <font class="keywordtype">int</font> Chapter (<font class="keywordtype">int</font> ichapter); +00321 +00329 <font class="keyword">virtual</font> <font class="keywordtype">int</font> Verse (<font class="keywordtype">int</font> iverse); +00330 +00337 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Normalize (<font class="keywordtype">char</font> autocheck = 0); +00338 +00347 <font class="keyword">virtual</font> <font class="keywordtype">char</font> AutoNormalize (<font class="keywordtype">char</font> iautonorm = MAXPOS (<font class="keywordtype">char</font>)); +00348 +00357 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Headings (<font class="keywordtype">char</font> iheadings = MAXPOS (<font class="keywordtype">char</font>)); +00358 +00359 <font class="keyword">virtual</font> <font class="keywordtype">long</font> NewIndex () <font class="keyword">const</font>; +00360 +00365 <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a23">Index</a> () <font class="keyword">const</font>; +00366 +00372 <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a23">Index</a> (<font class="keywordtype">long</font> iindex); +00373 +00374 <font class="keyword">virtual</font> <a class="code" href="class_listkey.html">ListKey</a> ParseVerseList (<font class="keyword">const</font> <font class="keywordtype">char</font> *buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *defaultKey = +00375 <font class="stringliteral">"Genesis 1:1"</font>, <font class="keywordtype">bool</font> expandRange = <font class="keyword">false</font>); +00383 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_swkey.html#a10">compare</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey); +00384 +00392 <font class="keyword">virtual</font> <font class="keywordtype">int</font> _compare (<font class="keyword">const</font> <a class="code" href="class_versekey.html">VerseKey</a> & ikey); +00393 +00394 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setBookAbbrevs (<font class="keyword">const</font> <font class="keyword">struct</font> abbrev *bookAbbrevs, +00395 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> size = +00396 0 <font class="comment">/* default determine size */</font> ); +00397 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setBooks (<font class="keyword">const</font> <font class="keywordtype">char</font> *iBMAX, <font class="keyword">struct</font> sbook **ibooks); +00398 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setLocale (<font class="keyword">const</font> <font class="keywordtype">char</font> *name); +00399 }; +00400 +00401 +00402 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/versekey_8h-source.html b/doc/api-documentation/html/versekey_8h-source.html new file mode 100644 index 0000000..5680543 --- /dev/null +++ b/doc/api-documentation/html/versekey_8h-source.html @@ -0,0 +1,214 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>versekey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>versekey.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * versekey.h - code for class 'versekey'- a standard Biblical verse key</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: versekey_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 +00023 <font class="preprocessor">#ifndef VERSEKEY_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define VERSEKEY_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swkey.h></font> +00027 <font class="preprocessor">#include <swmacs.h></font> +00028 <font class="preprocessor">#include <listkey.h></font> +00029 <font class="preprocessor">#include <ctype.h></font> +00030 +00031 <font class="preprocessor">#include <defs.h></font> +00032 +00033 <font class="preprocessor">#define POS_MAXVERSE ((char)3)</font> +00034 <font class="preprocessor"></font><font class="preprocessor">#define POS_MAXCHAPTER ((char)4)</font> +00035 <font class="preprocessor"></font><font class="preprocessor">#define POS_MAXBOOK ((char)5)</font> +00036 <font class="preprocessor"></font> +00037 <font class="preprocessor">#define MAXVERSE SW_POSITION(POS_MAXVERSE)</font> +00038 <font class="preprocessor"></font><font class="preprocessor">#define MAXCHAPTER SW_POSITION(POS_MAXCHAPTER)</font> +00039 <font class="preprocessor"></font><font class="preprocessor">#define MAXBOOK SW_POSITION(POS_MAXBOOK)</font> +00040 <font class="preprocessor"></font> +00041 <font class="keyword">struct </font>sbook +00042 { +00045 <font class="keyword">const</font> <font class="keywordtype">char</font> *name; +00048 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> chapmax; +00051 <font class="keywordtype">int</font> *versemax; +00052 }; +00053 +00054 <font class="keyword">struct </font>abbrev +00055 { +00056 <font class="keyword">const</font> <font class="keywordtype">char</font> *ab; +00057 <font class="keywordtype">int</font> book; +00058 }; +00059 +00060 +00061 <font class="keyword">class </font><a class="code" href="class_s_w_locale.html">SWLocale</a>; +00062 +<a name="l00067"></a><a class="code" href="class_verse_key.html">00067</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_verse_key.html">VerseKey</a>:<font class="keyword">public</font> <a class="code" href="class_s_w_key.html">SWKey</a> +00068 { +00069 <font class="keyword">class </font>LocaleCache +00070 { +00071 <font class="keyword">public</font>: +00072 <font class="keywordtype">char</font> *name; +00073 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> abbrevsCnt; +00074 <a class="code" href="class_s_w_locale.html">SWLocale</a> *locale; +00075 LocaleCache ()<font class="keyword"></font> +00076 <font class="keyword"> </font>{ +00077 name = 0; +00078 abbrevsCnt = 0; +00079 locale = 0; +00080 } +00081 <font class="keyword">virtual</font> ~LocaleCache ()<font class="keyword"></font> +00082 <font class="keyword"> </font>{ +00083 <font class="keywordflow">if</font> (name) +00084 <font class="keyword">delete</font>[]name; +00085 } +00086 }; +00087 +00088 <font class="keyword">static</font> <a class="code" href="class_s_w_class.html">SWClass</a> classdef; +00089 +00090 <font class="keyword">static</font> <font class="keywordtype">long</font> *offsets[2][2]; +00091 <font class="keyword">static</font> <font class="keywordtype">int</font> offsize[2][2]; +<a name="l00094"></a><a class="code" href="class_verse_key.html#r3">00094</a> <font class="keyword">static</font> <font class="keywordtype">int</font> instance; +00095 <font class="keyword">static</font> <font class="keyword">struct </font>sbook otbooks[]; +00096 <font class="keyword">static</font> <font class="keyword">struct </font>sbook ntbooks[]; +00097 <font class="keyword">static</font> <font class="keywordtype">long</font> otbks[]; +00098 <font class="keyword">static</font> <font class="keywordtype">long</font> otcps[]; +00099 <font class="keyword">static</font> <font class="keywordtype">long</font> ntbks[]; +00100 <font class="keyword">static</font> <font class="keywordtype">long</font> ntcps[]; +00101 <font class="keyword">static</font> <font class="keywordtype">int</font> vm[]; +00102 <font class="keyword">static</font> LocaleCache localeCache; +00103 <a class="code" href="class_list_key.html">ListKey</a> internalListKey; +00104 +00105 <font class="keyword">const</font> <font class="keyword">struct </font>abbrev *abbrevs; +00106 <font class="keywordtype">int</font> abbrevsCnt; +<a name="l00109"></a><a class="code" href="class_verse_key.html#o3">00109</a> <font class="keywordtype">char</font> testament; +00110 <font class="keyword">mutable</font> <font class="keywordtype">char</font> book; +00111 <font class="keyword">mutable</font> <font class="keywordtype">int</font> chapter; +00112 <font class="keyword">mutable</font> <font class="keywordtype">int</font> verse; +<a name="l00115"></a><a class="code" href="class_verse_key.html#o7">00115</a> <font class="keywordtype">char</font> autonorm; +<a name="l00118"></a><a class="code" href="class_verse_key.html#o8">00118</a> <font class="keywordtype">char</font> headings; +00119 +00120 <font class="keywordtype">int</font> getBookAbbrev (<font class="keyword">const</font> <font class="keywordtype">char</font> *abbr); +00121 <font class="keywordtype">void</font> initBounds () <font class="keyword">const</font>; +00124 <font class="keywordtype">void</font> <a class="code" href="class_verse_key.html#c2">initstatics</a> (); +00127 <font class="keywordtype">void</font> <a class="code" href="class_verse_key.html#c3">init</a> (); +00132 <font class="keywordtype">void</font> <a class="code" href="class_verse_key.html#c4">freshtext</a> () <font class="keyword">const</font>; +00136 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_verse_key.html#c5">parse</a> (); +00145 <font class="keywordtype">int</font> <a class="code" href="class_verse_key.html#c6">findindex</a> (<font class="keywordtype">long</font> *array, <font class="keywordtype">int</font> size, <font class="keywordtype">long</font> value); +00146 <font class="keyword">mutable</font> <a class="code" href="class_verse_key.html">VerseKey</a> *lowerBound, *upperBound; +00147 +00148 <font class="keyword">public</font>: +00149 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> builtin_BMAX[2]; +00150 <font class="keyword">static</font> <font class="keyword">struct </font>sbook *builtin_books[2]; +00151 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keyword">struct </font>abbrev builtin_abbrevs[]; +00152 <font class="keyword">const</font> <font class="keywordtype">char</font> *BMAX; +00153 <font class="keyword">struct </font>sbook **books; +00154 +00161 <a class="code" href="class_verse_key.html#a0">VerseKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00162 +00169 <a class="code" href="class_verse_key.html#a0">VerseKey</a> (<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * ikey); +00170 +00177 <a class="code" href="class_verse_key.html#a0">VerseKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *min, <font class="keyword">const</font> <font class="keywordtype">char</font> *max); +00178 +00184 <a class="code" href="class_verse_key.html#a0">VerseKey</a> (<a class="code" href="class_verse_key.html">VerseKey</a> <font class="keyword">const</font> &k); +00185 +00189 <font class="keyword">virtual</font> <a class="code" href="class_verse_key.html#a4">~ VerseKey</a> (); +00190 +00197 <a class="code" href="class_verse_key.html">VerseKey</a> & <a class="code" href="class_verse_key.html#a7">LowerBound</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *lb); +00198 +00204 <a class="code" href="class_verse_key.html">VerseKey</a> & <a class="code" href="class_verse_key.html#a8">UpperBound</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ub); +00205 +00209 <a class="code" href="class_verse_key.html">VerseKey</a> & <a class="code" href="class_verse_key.html#a7">LowerBound</a> ()<font class="keyword">const</font>; +00210 +00214 <a class="code" href="class_verse_key.html">VerseKey</a> & <a class="code" href="class_verse_key.html#a8">UpperBound</a> ()<font class="keyword">const</font>; +00215 +00218 <font class="keywordtype">void</font> <a class="code" href="class_verse_key.html#a9">ClearBounds</a> (); +00219 +00223 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> *<a class="code" href="class_s_w_key.html#a3">clone</a> () <font class="keyword">const</font>; +00224 +00228 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_key.html#a9">getText</a>() <font class="keyword">const</font>; +<a name="l00229"></a><a class="code" href="class_verse_key.html#a12">00229</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a7">setText</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey)<font class="keyword"> </font>{ <a class="code" href="class_s_w_key.html#a7">SWKey::setText</a>(ikey); <a class="code" href="class_verse_key.html#c5">parse</a> (); } +00230 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> & ikey); +00231 +00234 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_verse_key.html">VerseKey</a> & ikey); +00235 +00241 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_verse_key.html#a15">setPosition</a>(SW_POSITION); +00242 +00248 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a13">decrement</a>(<font class="keywordtype">int</font> step); +00249 +00255 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a14">increment</a>(<font class="keywordtype">int</font> step); +00256 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable ()<font class="keyword"> </font>{ <font class="keywordflow">return</font> 1; } +00257 +00262 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_verse_key.html#a19">Testament</a> () <font class="keyword">const</font>; +00263 +00268 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_verse_key.html#a20">Book</a> () <font class="keyword">const</font>; +00269 +00274 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_verse_key.html#a21">Chapter</a> () <font class="keyword">const</font>; +00275 +00280 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_verse_key.html#a22">Verse</a> () <font class="keyword">const</font>; +00281 +00289 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_verse_key.html#a19">Testament</a> (<font class="keywordtype">char</font> itestament); +00290 +00298 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_verse_key.html#a20">Book</a> (<font class="keywordtype">char</font> ibook); +00299 +00307 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_verse_key.html#a21">Chapter</a> (<font class="keywordtype">int</font> ichapter); +00308 +00316 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_verse_key.html#a22">Verse</a> (<font class="keywordtype">int</font> iverse); +00317 +00324 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_verse_key.html#a27">Normalize</a> (<font class="keywordtype">char</font> autocheck = 0); +00325 +00334 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_verse_key.html#a28">AutoNormalize</a> (<font class="keywordtype">char</font> iautonorm = MAXPOS (<font class="keywordtype">char</font>)); +00335 +00344 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_verse_key.html#a29">Headings</a> (<font class="keywordtype">char</font> iheadings = MAXPOS (<font class="keywordtype">char</font>)); +00345 +00346 <font class="keyword">virtual</font> <font class="keywordtype">long</font> NewIndex () <font class="keyword">const</font>; +00347 +00352 <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_s_w_key.html#a16">Index</a> () <font class="keyword">const</font>; +00353 +00359 <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_s_w_key.html#a16">Index</a> (<font class="keywordtype">long</font> iindex); +00360 +00361 <font class="keyword">virtual</font> <a class="code" href="class_list_key.html">ListKey</a> ParseVerseList (<font class="keyword">const</font> <font class="keywordtype">char</font> *buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *defaultKey = +00362 <font class="stringliteral">"Genesis 1:1"</font>, <font class="keywordtype">bool</font> expandRange = <font class="keyword">false</font>); +00370 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_s_w_key.html#a10">compare</a> (<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> & ikey); +00371 +00379 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_verse_key.html#a35">_compare</a> (<font class="keyword">const</font> <a class="code" href="class_verse_key.html">VerseKey</a> & ikey); +00380 +00381 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setBookAbbrevs (<font class="keyword">const</font> <font class="keyword">struct</font> abbrev *bookAbbrevs, +00382 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> size = +00383 0 <font class="comment">/* default determine size */</font> ); +00384 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setBooks (<font class="keyword">const</font> <font class="keywordtype">char</font> *iBMAX, <font class="keyword">struct</font> sbook **ibooks); +00385 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setLocale (<font class="keyword">const</font> <font class="keywordtype">char</font> *name); +00386 +00387 SWKEY_OPERATORS +00388 +00389 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> & operator = (<font class="keyword">const</font> <a class="code" href="class_verse_key.html">VerseKey</a> & ikey)<font class="keyword"> </font>{ <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(ikey); <font class="keywordflow">return</font> *<font class="keyword">this</font>; } +00390 }; +00391 +00392 +00393 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/versekey_h-source.html b/doc/api-documentation/html/versekey_h-source.html new file mode 100644 index 0000000..b698907 --- /dev/null +++ b/doc/api-documentation/html/versekey_h-source.html @@ -0,0 +1,214 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>versekey.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>versekey.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * versekey.h - code for class 'versekey'- a standard Biblical verse key</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: versekey_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 +00023 <font class="preprocessor">#ifndef VERSEKEY_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define VERSEKEY_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <swkey.h></font> +00027 <font class="preprocessor">#include <swmacs.h></font> +00028 <font class="preprocessor">#include <listkey.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="preprocessor">#define POS_MAXVERSE ((char)3)</font> +00033 <font class="preprocessor"></font><font class="preprocessor">#define POS_MAXCHAPTER ((char)4)</font> +00034 <font class="preprocessor"></font><font class="preprocessor">#define POS_MAXBOOK ((char)5)</font> +00035 <font class="preprocessor"></font> +00036 <font class="preprocessor">#define MAXVERSE SW_POSITION(POS_MAXVERSE)</font> +00037 <font class="preprocessor"></font><font class="preprocessor">#define MAXCHAPTER SW_POSITION(POS_MAXCHAPTER)</font> +00038 <font class="preprocessor"></font><font class="preprocessor">#define MAXBOOK SW_POSITION(POS_MAXBOOK)</font> +00039 <font class="preprocessor"></font> +00040 <font class="keyword">struct </font>sbook +00041 { +00044 <font class="keyword">const</font> <font class="keywordtype">char</font> *name; +00047 <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> chapmax; +00050 <font class="keywordtype">int</font> *versemax; +00051 }; +00052 +00053 <font class="keyword">struct </font>abbrev +00054 { +00055 <font class="keyword">const</font> <font class="keywordtype">char</font> *ab; +00056 <font class="keywordtype">int</font> book; +00057 }; +00058 +00059 +00060 <font class="keyword">class </font><a class="code" href="class_swlocale.html">SWLocale</a>; +00061 +<a name="l00066"></a><a class="code" href="class_versekey.html">00066</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_versekey.html">VerseKey</a>:<font class="keyword">public</font> <a class="code" href="class_swkey.html">SWKey</a> +00067 { +00068 <font class="keyword">class </font>LocaleCache +00069 { +00070 <font class="keyword">public</font>: +00071 <font class="keywordtype">char</font> *name; +00072 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> abbrevsCnt; +00073 <a class="code" href="class_swlocale.html">SWLocale</a> *locale; +00074 LocaleCache ()<font class="keyword"></font> +00075 <font class="keyword"> </font>{ +00076 name = 0; +00077 abbrevsCnt = 0; +00078 locale = 0; +00079 } +00080 <font class="keyword">virtual</font> ~LocaleCache ()<font class="keyword"></font> +00081 <font class="keyword"> </font>{ +00082 <font class="keywordflow">if</font> (name) +00083 <font class="keyword">delete</font>[]name; +00084 } +00085 }; +00086 +00087 <font class="keyword">static</font> <a class="code" href="class_swclass.html">SWClass</a> classdef; +00088 +00089 <font class="keyword">static</font> <font class="keywordtype">long</font> *offsets[2][2]; +00090 <font class="keyword">static</font> <font class="keywordtype">int</font> offsize[2][2]; +<a name="l00093"></a><a class="code" href="class_versekey.html#r3">00093</a> <font class="keyword">static</font> <font class="keywordtype">int</font> instance; +00094 <font class="keyword">static</font> <font class="keyword">struct </font>sbook otbooks[]; +00095 <font class="keyword">static</font> <font class="keyword">struct </font>sbook ntbooks[]; +00096 <font class="keyword">static</font> <font class="keywordtype">long</font> otbks[]; +00097 <font class="keyword">static</font> <font class="keywordtype">long</font> otcps[]; +00098 <font class="keyword">static</font> <font class="keywordtype">long</font> ntbks[]; +00099 <font class="keyword">static</font> <font class="keywordtype">long</font> ntcps[]; +00100 <font class="keyword">static</font> <font class="keywordtype">int</font> vm[]; +00101 <font class="keyword">static</font> LocaleCache localeCache; +00102 <a class="code" href="class_listkey.html">ListKey</a> internalListKey; +00103 +00104 <font class="keyword">const</font> <font class="keyword">struct </font>abbrev *abbrevs; +00105 <font class="keywordtype">int</font> abbrevsCnt; +<a name="l00108"></a><a class="code" href="class_versekey.html#o3">00108</a> <font class="keywordtype">char</font> testament; +00109 <font class="keyword">mutable</font> <font class="keywordtype">char</font> book; +00110 <font class="keyword">mutable</font> <font class="keywordtype">int</font> chapter; +00111 <font class="keyword">mutable</font> <font class="keywordtype">int</font> verse; +<a name="l00114"></a><a class="code" href="class_versekey.html#o7">00114</a> <font class="keywordtype">char</font> autonorm; +<a name="l00117"></a><a class="code" href="class_versekey.html#o8">00117</a> <font class="keywordtype">char</font> headings; +00118 +00119 <font class="keywordtype">int</font> getBookAbbrev (<font class="keywordtype">char</font> *abbr); +00120 <font class="keywordtype">void</font> initBounds () <font class="keyword">const</font>; +00123 <font class="keywordtype">void</font> <a class="code" href="class_versekey.html#c2">initstatics</a> (); +00126 <font class="keywordtype">void</font> <a class="code" href="class_versekey.html#c3">init</a> (); +00131 <font class="keywordtype">void</font> <a class="code" href="class_versekey.html#c4">freshtext</a> () <font class="keyword">const</font>; +00135 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_versekey.html#c5">parse</a> (); +00144 <font class="keywordtype">int</font> <a class="code" href="class_versekey.html#c6">findindex</a> (<font class="keywordtype">long</font> *array, <font class="keywordtype">int</font> size, <font class="keywordtype">long</font> value); +00145 <font class="keyword">mutable</font> <a class="code" href="class_versekey.html">VerseKey</a> *lowerBound, *upperBound; +00146 +00147 <font class="keyword">public</font>: +00148 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> builtin_BMAX[2]; +00149 <font class="keyword">static</font> <font class="keyword">struct </font>sbook *builtin_books[2]; +00150 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keyword">struct </font>abbrev builtin_abbrevs[]; +00151 <font class="keyword">const</font> <font class="keywordtype">char</font> *BMAX; +00152 <font class="keyword">struct </font>sbook **books; +00153 +00160 <a class="code" href="class_versekey.html#a0">VerseKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0); +00161 +00168 <a class="code" href="class_versekey.html#a0">VerseKey</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * ikey); +00169 +00176 <a class="code" href="class_versekey.html#a0">VerseKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *min, <font class="keyword">const</font> <font class="keywordtype">char</font> *max); +00177 +00183 <a class="code" href="class_versekey.html#a0">VerseKey</a> (<a class="code" href="class_versekey.html">VerseKey</a> <font class="keyword">const</font> &k); +00184 +00188 <font class="keyword">virtual</font> <a class="code" href="class_versekey.html#a4">~ VerseKey</a> (); +00189 +00196 <a class="code" href="class_versekey.html">VerseKey</a> & <a class="code" href="class_versekey.html#a7">LowerBound</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *lb); +00197 +00203 <a class="code" href="class_versekey.html">VerseKey</a> & <a class="code" href="class_versekey.html#a8">UpperBound</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ub); +00204 +00208 <a class="code" href="class_versekey.html">VerseKey</a> & <a class="code" href="class_versekey.html#a7">LowerBound</a> ()<font class="keyword">const</font>; +00209 +00213 <a class="code" href="class_versekey.html">VerseKey</a> & <a class="code" href="class_versekey.html#a8">UpperBound</a> ()<font class="keyword">const</font>; +00214 +00217 <font class="keywordtype">void</font> <a class="code" href="class_versekey.html#a9">ClearBounds</a> (); +00218 +00222 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swkey.html#a3">clone</a> () <font class="keyword">const</font>; +00223 +00227 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swkey.html#a9">getText</a>() <font class="keyword">const</font>; +<a name="l00228"></a><a class="code" href="class_versekey.html#a12">00228</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a7">setText</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey)<font class="keyword"> </font>{ <a class="code" href="class_swkey.html#a7">SWKey::setText</a>(ikey); <a class="code" href="class_versekey.html#c5">parse</a> (); } +00229 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey); +00230 +00233 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_versekey.html">VerseKey</a> & ikey); +00234 +00240 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_versekey.html#a15">setPosition</a>(SW_POSITION); +00241 +00247 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a13">decrement</a>(<font class="keywordtype">int</font> step); +00248 +00254 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swkey.html#a14">increment</a>(<font class="keywordtype">int</font> step); +00255 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable ()<font class="keyword"> </font>{ <font class="keywordflow">return</font> 1; } +00256 +00261 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_versekey.html#a19">Testament</a> () <font class="keyword">const</font>; +00262 +00267 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_versekey.html#a20">Book</a> () <font class="keyword">const</font>; +00268 +00273 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_versekey.html#a21">Chapter</a> () <font class="keyword">const</font>; +00274 +00279 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_versekey.html#a22">Verse</a> () <font class="keyword">const</font>; +00280 +00288 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_versekey.html#a19">Testament</a> (<font class="keywordtype">char</font> itestament); +00289 +00297 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_versekey.html#a20">Book</a> (<font class="keywordtype">char</font> ibook); +00298 +00306 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_versekey.html#a21">Chapter</a> (<font class="keywordtype">int</font> ichapter); +00307 +00315 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_versekey.html#a22">Verse</a> (<font class="keywordtype">int</font> iverse); +00316 +00323 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_versekey.html#a27">Normalize</a> (<font class="keywordtype">char</font> autocheck = 0); +00324 +00333 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_versekey.html#a28">AutoNormalize</a> (<font class="keywordtype">char</font> iautonorm = MAXPOS (<font class="keywordtype">char</font>)); +00334 +00343 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_versekey.html#a29">Headings</a> (<font class="keywordtype">char</font> iheadings = MAXPOS (<font class="keywordtype">char</font>)); +00344 +00345 <font class="keyword">virtual</font> <font class="keywordtype">long</font> NewIndex () <font class="keyword">const</font>; +00346 +00351 <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a16">Index</a> () <font class="keyword">const</font>; +00352 +00358 <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_swkey.html#a16">Index</a> (<font class="keywordtype">long</font> iindex); +00359 +00360 <font class="keyword">virtual</font> <a class="code" href="class_listkey.html">ListKey</a> ParseVerseList (<font class="keyword">const</font> <font class="keywordtype">char</font> *buf, <font class="keyword">const</font> <font class="keywordtype">char</font> *defaultKey = +00361 <font class="stringliteral">"Genesis 1:1"</font>, <font class="keywordtype">bool</font> expandRange = <font class="keyword">false</font>); +00369 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_swkey.html#a10">compare</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey); +00370 +00378 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_versekey.html#a35">_compare</a> (<font class="keyword">const</font> <a class="code" href="class_versekey.html">VerseKey</a> & ikey); +00379 +00380 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setBookAbbrevs (<font class="keyword">const</font> <font class="keyword">struct</font> abbrev *bookAbbrevs, +00381 <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> size = +00382 0 <font class="comment">/* default determine size */</font> ); +00383 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setBooks (<font class="keyword">const</font> <font class="keywordtype">char</font> *iBMAX, <font class="keyword">struct</font> sbook **ibooks); +00384 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setLocale (<font class="keyword">const</font> <font class="keywordtype">char</font> *name); +00385 +00386 SWKEY_OPERATORS +00387 +00388 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> & operator = (<font class="keyword">const</font> <a class="code" href="class_versekey.html">VerseKey</a> & ikey)<font class="keyword"> </font>{ <a class="code" href="class_swkey.html#a8">copyFrom</a>(ikey); <font class="keywordflow">return</font> *<font class="keyword">this</font>; } +00389 }; +00390 +00391 +00392 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zcom.h-source.html b/doc/api-documentation/html/zcom.h-source.html new file mode 100644 index 0000000..03baaed --- /dev/null +++ b/doc/api-documentation/html/zcom.h-source.html @@ -0,0 +1,82 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>zcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * zcom.h - code for class 'zCom'- a module that reads compressed text +</font>00003 <font class="comment"> * files: ot and nt using indexs ??.vss +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: zcom.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef ZCOM_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define ZCOM_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <swcom.h></font> +00028 <font class="preprocessor">#include <swcomprs.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT zCom:<font class="keyword">public</font> zVerse, <font class="keyword">public</font> <a class="code" href="class_swcom.html">SWCom</a> { +00033 <font class="keywordtype">char</font> *versebuf; +00034 <a class="code" href="class_versekey.html">VerseKey</a> *lastWriteKey; +00035 <font class="keywordtype">bool</font> sameBlock (<a class="code" href="class_versekey.html">VerseKey</a> * lastWriteKey, <a class="code" href="class_versekey.html">VerseKey</a> * key); +00036 <font class="keywordtype">int</font> blockType; +00037 <font class="keyword">public</font>: +00038 +00039 +00040 zCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00041 0, <font class="keywordtype">int</font> blockType = CHAPTERBLOCKS, SWCompress * icomp = +00042 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00043 <font class="keyword">virtual</font> ~ zCom (); +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a19">getRawEntry</a> (); +00045 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a27"> operator += </a>(<font class="keywordtype">int</font> increment); +00046 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a26"> operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"> +</font>00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> this-><a class="code" href="class_swmodule.html#a27">operator += </a>(-decrement); +00049 } +00050 +00051 <font class="comment">// write interface ----------------------------</font> +00052 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a22">isWritable</a> ()<font class="keyword"> +</font>00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00055 } +00056 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound)<font class="keyword"> +</font>00057 <font class="keyword"> </font>{ +00058 <font class="keywordflow">return</font> zVerse::createModule (path, blockBound); +00059 } +00060 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00061 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00062 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a25">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00063 <font class="comment">// end write interface ------------------------</font> +00064 }; +00065 +00066 +00067 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zcom_8h-source.html b/doc/api-documentation/html/zcom_8h-source.html new file mode 100644 index 0000000..a12d183 --- /dev/null +++ b/doc/api-documentation/html/zcom_8h-source.html @@ -0,0 +1,84 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>zcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * zcom.h - code for class 'zCom'- a module that reads compressed text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.vss</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: zcom_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef ZCOM_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define ZCOM_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <swcom.h></font> +00028 <font class="preprocessor">#include <swcomprs.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT zCom:<font class="keyword">public</font> zVerse, <font class="keyword">public</font> <a class="code" href="class_s_w_com.html">SWCom</a> { +00033 <font class="keywordtype">char</font> *versebuf; +00034 <a class="code" href="class_verse_key.html">VerseKey</a> *lastWriteKey; +00035 <font class="keywordtype">bool</font> sameBlock (<a class="code" href="class_verse_key.html">VerseKey</a> * lastWriteKey, <a class="code" href="class_verse_key.html">VerseKey</a> * key); +00036 <font class="keywordtype">int</font> blockType; +00037 <font class="keyword">public</font>: +00038 +00039 +00040 zCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00041 0, <font class="keywordtype">int</font> blockType = CHAPTERBLOCKS, SWCompress * icomp = +00042 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, +00043 <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); +00044 <font class="keyword">virtual</font> ~ zCom (); +00045 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a25">getRawEntry</a> (); +00046 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a34">operator += </a>(<font class="keywordtype">int</font> increment); +00047 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a33">operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"></font> +00048 <font class="keyword"> </font>{ +00049 <font class="keywordflow">return</font> this-><a class="code" href="class_s_w_module.html#a34">operator += </a>(-decrement); +00050 } +00051 +00052 <font class="comment">// write interface ----------------------------</font> +00053 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a28">isWritable</a> ()<font class="keyword"></font> +00054 <font class="keyword"> </font>{ +00055 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00056 } +00057 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound)<font class="keyword"></font> +00058 <font class="keyword"> </font>{ +00059 <font class="keywordflow">return</font> zVerse::createModule (path, blockBound); +00060 } +00061 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a29">setentry</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf, <font class="keywordtype">long</font> len); <font class="comment">// Modify current module entry</font> +00062 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00063 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00064 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a32">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00065 <font class="comment">// end write interface ------------------------</font> +00066 }; +00067 +00068 +00069 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zcom_h-source.html b/doc/api-documentation/html/zcom_h-source.html new file mode 100644 index 0000000..db80431 --- /dev/null +++ b/doc/api-documentation/html/zcom_h-source.html @@ -0,0 +1,83 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>zcom.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * zcom.h - code for class 'zCom'- a module that reads compressed text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.vss</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: zcom_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef ZCOM_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define ZCOM_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <rawverse.h></font> +00027 <font class="preprocessor">#include <swcom.h></font> +00028 <font class="preprocessor">#include <swcomprs.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="keyword">class </font>SWDLLEXPORT zCom:<font class="keyword">public</font> zVerse, <font class="keyword">public</font> <a class="code" href="class_swcom.html">SWCom</a> { +00033 <font class="keywordtype">char</font> *versebuf; +00034 <a class="code" href="class_versekey.html">VerseKey</a> *lastWriteKey; +00035 <font class="keywordtype">bool</font> sameBlock (<a class="code" href="class_versekey.html">VerseKey</a> * lastWriteKey, <a class="code" href="class_versekey.html">VerseKey</a> * key); +00036 <font class="keywordtype">int</font> blockType; +00037 <font class="keyword">public</font>: +00038 +00039 +00040 zCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00041 0, <font class="keywordtype">int</font> blockType = CHAPTERBLOCKS, SWCompress * icomp = +00042 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00043 <font class="keyword">virtual</font> ~ zCom (); +00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a21">getRawEntry</a> (); +00045 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a29">operator += </a>(<font class="keywordtype">int</font> increment); +00046 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a28">operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"></font> +00047 <font class="keyword"> </font>{ +00048 <font class="keywordflow">return</font> this-><a class="code" href="class_swmodule.html#a29">operator += </a>(-decrement); +00049 } +00050 +00051 <font class="comment">// write interface ----------------------------</font> +00052 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a24">isWritable</a> ()<font class="keyword"></font> +00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00055 } +00056 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound)<font class="keyword"></font> +00057 <font class="keyword"> </font>{ +00058 <font class="keywordflow">return</font> zVerse::createModule (path, blockBound); +00059 } +00060 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00061 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00062 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a27">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00063 <font class="comment">// end write interface ------------------------</font> +00064 }; +00065 +00066 +00067 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zconf.h-source.html b/doc/api-documentation/html/zconf.h-source.html new file mode 100644 index 0000000..9126309 --- /dev/null +++ b/doc/api-documentation/html/zconf.h-source.html @@ -0,0 +1,294 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>zconf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zconf.h</h1><div class="fragment"><pre>00001 <font class="comment">/* zconf.h -- configuration of the zlib compression library +</font>00002 <font class="comment"> * Copyright (C) 1995-1998 Jean-loup Gailly. +</font>00003 <font class="comment"> * For conditions of distribution and use, see copyright notice in zlib.h +</font>00004 <font class="comment"> */</font> +00005 +00006 <font class="comment">/* @(#) $Id: zconf.h-source.html,v 1.1 2001/05/25 10:50:59 jansorg Exp $ */</font> +00007 +00008 <font class="preprocessor">#ifndef _ZCONF_H +</font>00009 <font class="preprocessor"></font><font class="preprocessor">#define _ZCONF_H +</font>00010 <font class="preprocessor"></font> +00011 <font class="comment">/* +</font>00012 <font class="comment"> * If you *really* need a unique prefix for all types and library functions, +</font>00013 <font class="comment"> * compile with -DZ_PREFIX. The "standard" zlib should be compiled without it. +</font>00014 <font class="comment"> */</font> +00015 <font class="preprocessor">#ifdef Z_PREFIX +</font>00016 <font class="preprocessor"></font><font class="preprocessor"># define deflateInit_ z_deflateInit_ +</font>00017 <font class="preprocessor"></font><font class="preprocessor"># define deflate z_deflate +</font>00018 <font class="preprocessor"></font><font class="preprocessor"># define deflateEnd z_deflateEnd +</font>00019 <font class="preprocessor"></font><font class="preprocessor"># define inflateInit_ z_inflateInit_ +</font>00020 <font class="preprocessor"></font><font class="preprocessor"># define inflate z_inflate +</font>00021 <font class="preprocessor"></font><font class="preprocessor"># define inflateEnd z_inflateEnd +</font>00022 <font class="preprocessor"></font><font class="preprocessor"># define deflateInit2_ z_deflateInit2_ +</font>00023 <font class="preprocessor"></font><font class="preprocessor"># define deflateSetDictionary z_deflateSetDictionary +</font>00024 <font class="preprocessor"></font><font class="preprocessor"># define deflateCopy z_deflateCopy +</font>00025 <font class="preprocessor"></font><font class="preprocessor"># define deflateReset z_deflateReset +</font>00026 <font class="preprocessor"></font><font class="preprocessor"># define deflateParams z_deflateParams +</font>00027 <font class="preprocessor"></font><font class="preprocessor"># define inflateInit2_ z_inflateInit2_ +</font>00028 <font class="preprocessor"></font><font class="preprocessor"># define inflateSetDictionary z_inflateSetDictionary +</font>00029 <font class="preprocessor"></font><font class="preprocessor"># define inflateSync z_inflateSync +</font>00030 <font class="preprocessor"></font><font class="preprocessor"># define inflateSyncPoint z_inflateSyncPoint +</font>00031 <font class="preprocessor"></font><font class="preprocessor"># define inflateReset z_inflateReset +</font>00032 <font class="preprocessor"></font><font class="preprocessor"># define compress z_compress +</font>00033 <font class="preprocessor"></font><font class="preprocessor"># define compress2 z_compress2 +</font>00034 <font class="preprocessor"></font><font class="preprocessor"># define uncompress z_uncompress +</font>00035 <font class="preprocessor"></font><font class="preprocessor"># define adler32 z_adler32 +</font>00036 <font class="preprocessor"></font><font class="preprocessor"># define crc32 z_crc32 +</font>00037 <font class="preprocessor"></font><font class="preprocessor"># define get_crc_table z_get_crc_table +</font>00038 <font class="preprocessor"></font> +00039 <font class="preprocessor"># define Byte z_Byte +</font>00040 <font class="preprocessor"></font><font class="preprocessor"># define uInt z_uInt +</font>00041 <font class="preprocessor"></font><font class="preprocessor"># define uLong z_uLong +</font>00042 <font class="preprocessor"></font><font class="preprocessor"># define Bytef z_Bytef +</font>00043 <font class="preprocessor"></font><font class="preprocessor"># define charf z_charf +</font>00044 <font class="preprocessor"></font><font class="preprocessor"># define intf z_intf +</font>00045 <font class="preprocessor"></font><font class="preprocessor"># define uIntf z_uIntf +</font>00046 <font class="preprocessor"></font><font class="preprocessor"># define uLongf z_uLongf +</font>00047 <font class="preprocessor"></font><font class="preprocessor"># define voidpf z_voidpf +</font>00048 <font class="preprocessor"></font><font class="preprocessor"># define voidp z_voidp +</font>00049 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00050 <font class="preprocessor"></font> +00051 <font class="preprocessor">#if (defined(_WIN32) || defined(__WIN32__)) && !defined(WIN32) +</font>00052 <font class="preprocessor"></font><font class="preprocessor"># define WIN32 +</font>00053 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00054 <font class="preprocessor"></font><font class="preprocessor">#if defined(__GNUC__) || defined(WIN32) || defined(__386__) || defined(i386) +</font>00055 <font class="preprocessor"></font><font class="preprocessor"># ifndef __32BIT__ +</font>00056 <font class="preprocessor"></font><font class="preprocessor"># define __32BIT__ +</font>00057 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00058 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00059 <font class="preprocessor"></font><font class="preprocessor">#if defined(__MSDOS__) && !defined(MSDOS) +</font>00060 <font class="preprocessor"></font><font class="preprocessor"># define MSDOS +</font>00061 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00062 <font class="preprocessor"></font> +00063 <font class="comment">/* +</font>00064 <font class="comment"> * Compile with -DMAXSEG_64K if the alloc function cannot allocate more +</font>00065 <font class="comment"> * than 64k bytes at a time (needed on systems with 16-bit int). +</font>00066 <font class="comment"> */</font> +00067 <font class="preprocessor">#if defined(MSDOS) && !defined(__32BIT__) +</font>00068 <font class="preprocessor"></font><font class="preprocessor"># define MAXSEG_64K +</font>00069 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00070 <font class="preprocessor"></font><font class="preprocessor">#ifdef MSDOS +</font>00071 <font class="preprocessor"></font><font class="preprocessor"># define UNALIGNED_OK +</font>00072 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00073 <font class="preprocessor"></font> +00074 <font class="preprocessor">#if (defined(MSDOS) || defined(_WINDOWS) || defined(WIN32)) && !defined(STDC) +</font>00075 <font class="preprocessor"></font><font class="preprocessor"># define STDC +</font>00076 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00077 <font class="preprocessor"></font><font class="preprocessor">#if defined(__STDC__) || defined(__cplusplus) || defined(__OS2__) +</font>00078 <font class="preprocessor"></font><font class="preprocessor"># ifndef STDC +</font>00079 <font class="preprocessor"></font><font class="preprocessor"># define STDC +</font>00080 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00081 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00082 <font class="preprocessor"></font> +00083 <font class="preprocessor">#ifndef STDC +</font>00084 <font class="preprocessor"></font><font class="preprocessor"># ifndef const </font><font class="comment">/* cannot use !defined(STDC) && !defined(const) on Mac */</font> +00085 <font class="preprocessor"># define const +</font>00086 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00087 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00088 <font class="preprocessor"></font> +00089 <font class="comment">/* Some Mac compilers merge all .h files incorrectly: */</font> +00090 <font class="preprocessor">#if defined(__MWERKS__) || defined(applec) ||defined(THINK_C) ||defined(__SC__) +</font>00091 <font class="preprocessor"></font><font class="preprocessor"># define NO_DUMMY_DECL +</font>00092 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00093 <font class="preprocessor"></font> +00094 <font class="comment">/* Old Borland C incorrectly complains about missing returns: */</font> +00095 <font class="preprocessor">#if defined(__BORLANDC__) && (__BORLANDC__ < 0x500) +</font>00096 <font class="preprocessor"></font><font class="preprocessor"># define NEED_DUMMY_RETURN +</font>00097 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00098 <font class="preprocessor"></font> +00099 +00100 <font class="comment">/* Maximum value for memLevel in deflateInit2 */</font> +00101 <font class="preprocessor">#ifndef MAX_MEM_LEVEL +</font>00102 <font class="preprocessor"></font><font class="preprocessor"># ifdef MAXSEG_64K +</font>00103 <font class="preprocessor"></font><font class="preprocessor"># define MAX_MEM_LEVEL 8 +</font>00104 <font class="preprocessor"></font><font class="preprocessor"># else +</font>00105 <font class="preprocessor"></font><font class="preprocessor"># define MAX_MEM_LEVEL 9 +</font>00106 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00107 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00108 <font class="preprocessor"></font> +00109 <font class="comment">/* Maximum value for windowBits in deflateInit2 and inflateInit2. +</font>00110 <font class="comment"> * WARNING: reducing MAX_WBITS makes minigzip unable to extract .gz files +</font>00111 <font class="comment"> * created by gzip. (Files created by minigzip can still be extracted by +</font>00112 <font class="comment"> * gzip.) +</font>00113 <font class="comment"> */</font> +00114 <font class="preprocessor">#ifndef MAX_WBITS +</font>00115 <font class="preprocessor"></font><font class="preprocessor"># define MAX_WBITS 15 </font><font class="comment">/* 32K LZ77 window */</font> +00116 <font class="preprocessor">#endif +</font>00117 <font class="preprocessor"></font> +00118 <font class="comment">/* The memory requirements for deflate are (in bytes): +</font>00119 <font class="comment"> (1 << (windowBits+2)) + (1 << (memLevel+9)) +</font>00120 <font class="comment"> that is: 128K for windowBits=15 + 128K for memLevel = 8 (default values) +</font>00121 <font class="comment"> plus a few kilobytes for small objects. For example, if you want to reduce +</font>00122 <font class="comment"> the default memory requirements from 256K to 128K, compile with +</font>00123 <font class="comment"> make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7" +</font>00124 <font class="comment"> Of course this will generally degrade compression (there's no free lunch). +</font>00125 <font class="comment"> +</font>00126 <font class="comment"> The memory requirements for inflate are (in bytes) 1 << windowBits +</font>00127 <font class="comment"> that is, 32K for windowBits=15 (default value) plus a few kilobytes +</font>00128 <font class="comment"> for small objects. +</font>00129 <font class="comment">*/</font> +00130 +00131 <font class="comment">/* Type declarations */</font> +00132 +00133 <font class="preprocessor">#ifndef OF </font><font class="comment">/* function prototypes */</font> +00134 <font class="preprocessor"># ifdef STDC +</font>00135 <font class="preprocessor"></font><font class="preprocessor"># define OF(args) args +</font>00136 <font class="preprocessor"></font><font class="preprocessor"># else +</font>00137 <font class="preprocessor"></font><font class="preprocessor"># define OF(args) () +</font>00138 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00139 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00140 <font class="preprocessor"></font> +00141 <font class="comment">/* The following definitions for FAR are needed only for MSDOS mixed +</font>00142 <font class="comment"> * model programming (small or medium model with some far allocations). +</font>00143 <font class="comment"> * This was tested only with MSC; for other MSDOS compilers you may have +</font>00144 <font class="comment"> * to define NO_MEMCPY in zutil.h. If you don't need the mixed model, +</font>00145 <font class="comment"> * just define FAR to be empty. +</font>00146 <font class="comment"> */</font> +00147 <font class="preprocessor">#if (defined(M_I86SM) || defined(M_I86MM)) && !defined(__32BIT__) +</font>00148 <font class="preprocessor"></font> <font class="comment">/* MSC small or medium model */</font> +00149 <font class="preprocessor"># define SMALL_MEDIUM +</font>00150 <font class="preprocessor"></font><font class="preprocessor"># ifdef _MSC_VER +</font>00151 <font class="preprocessor"></font><font class="preprocessor"># define FAR _far +</font>00152 <font class="preprocessor"></font><font class="preprocessor"># else +</font>00153 <font class="preprocessor"></font><font class="preprocessor"># define FAR far +</font>00154 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00155 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00156 <font class="preprocessor"></font><font class="preprocessor">#if defined(__BORLANDC__) && (defined(__SMALL__) || defined(__MEDIUM__)) +</font>00157 <font class="preprocessor"></font><font class="preprocessor"># ifndef __32BIT__ +</font>00158 <font class="preprocessor"></font><font class="preprocessor"># define SMALL_MEDIUM +</font>00159 <font class="preprocessor"></font><font class="preprocessor"># define FAR _far +</font>00160 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00161 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00162 <font class="preprocessor"></font> +00163 <font class="comment">/* Compile with -DZLIB_DLL for Windows DLL support */</font> +00164 <font class="preprocessor">#if defined(ZLIB_DLL) +</font>00165 <font class="preprocessor"></font><font class="preprocessor"># if defined(_WINDOWS) || defined(WINDOWS) +</font>00166 <font class="preprocessor"></font><font class="preprocessor"># ifdef FAR +</font>00167 <font class="preprocessor"></font><font class="preprocessor"># undef FAR +</font>00168 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00169 <font class="preprocessor"></font><font class="preprocessor"># include <windows.h></font> +00170 <font class="preprocessor"># define ZEXPORT WINAPI +</font>00171 <font class="preprocessor"></font><font class="preprocessor"># ifdef WIN32 +</font>00172 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA WINAPIV +</font>00173 <font class="preprocessor"></font><font class="preprocessor"># else +</font>00174 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA FAR _cdecl _export +</font>00175 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00176 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00177 <font class="preprocessor"></font><font class="preprocessor"># if defined (__BORLANDC__) +</font>00178 <font class="preprocessor"></font><font class="preprocessor"># if (__BORLANDC__ >= 0x0500) && defined (WIN32) +</font>00179 <font class="preprocessor"></font><font class="preprocessor"># include <windows.h></font> +00180 <font class="preprocessor"># define ZEXPORT __declspec(dllexport) WINAPI +</font>00181 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTRVA __declspec(dllexport) WINAPIV +</font>00182 <font class="preprocessor"></font><font class="preprocessor"># else +</font>00183 <font class="preprocessor"></font><font class="preprocessor"># if defined (_Windows) && defined (__DLL__) +</font>00184 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORT _export +</font>00185 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA _export +</font>00186 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00187 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00188 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00189 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00190 <font class="preprocessor"></font> +00191 <font class="preprocessor">#if defined (__BEOS__) +</font>00192 <font class="preprocessor"></font><font class="preprocessor"># if defined (ZLIB_DLL) +</font>00193 <font class="preprocessor"></font><font class="preprocessor"># define ZEXTERN extern __declspec(dllexport) +</font>00194 <font class="preprocessor"></font><font class="preprocessor"># else +</font>00195 <font class="preprocessor"></font><font class="preprocessor"># define ZEXTERN extern __declspec(dllimport) +</font>00196 <font class="preprocessor"></font><font class="preprocessor"># endif +</font>00197 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00198 <font class="preprocessor"></font> +00199 <font class="preprocessor">#ifndef ZEXPORT +</font>00200 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORT +</font>00201 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00202 <font class="preprocessor"></font><font class="preprocessor">#ifndef ZEXPORTVA +</font>00203 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA +</font>00204 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00205 <font class="preprocessor"></font><font class="preprocessor">#ifndef ZEXTERN +</font>00206 <font class="preprocessor"></font><font class="preprocessor"># define ZEXTERN extern +</font>00207 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00208 <font class="preprocessor"></font> +00209 <font class="preprocessor">#ifndef FAR +</font>00210 <font class="preprocessor"></font><font class="preprocessor"># define FAR +</font>00211 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00212 <font class="preprocessor"></font> +00213 <font class="preprocessor">#if !defined(MACOS) && !defined(TARGET_OS_MAC) && !defined(VCL) +</font>00214 <font class="preprocessor"></font><font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Byte; <font class="comment">/* 8 bits */</font> +00215 <font class="preprocessor">#endif +</font>00216 <font class="preprocessor"></font><font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> uInt; <font class="comment">/* 16 bits or more */</font> +00217 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> uLong; <font class="comment">/* 32 bits or more */</font> +00218 +00219 <font class="preprocessor">#ifdef SMALL_MEDIUM +</font>00220 <font class="preprocessor"></font> <font class="comment">/* Borland C/C++ and some old MSC versions ignore FAR inside typedef */</font> +00221 <font class="preprocessor"># define Bytef Byte FAR +</font>00222 <font class="preprocessor"></font><font class="preprocessor">#else +</font>00223 <font class="preprocessor"></font> <font class="keyword">typedef</font> Byte FAR Bytef; +00224 <font class="preprocessor">#endif +</font>00225 <font class="preprocessor"></font><font class="keyword">typedef</font> <font class="keywordtype">char</font> FAR charf; +00226 <font class="keyword">typedef</font> <font class="keywordtype">int</font> FAR intf; +00227 <font class="keyword">typedef</font> uInt FAR uIntf; +00228 <font class="keyword">typedef</font> uLong FAR uLongf; +00229 +00230 <font class="preprocessor">#ifdef STDC +</font>00231 <font class="preprocessor"></font> <font class="keyword">typedef</font> <font class="keywordtype">void</font> FAR *voidpf; +00232 <font class="keyword">typedef</font> <font class="keywordtype">void</font> *voidp; +00233 <font class="preprocessor">#else +</font>00234 <font class="preprocessor"></font> <font class="keyword">typedef</font> Byte FAR *voidpf; +00235 <font class="keyword">typedef</font> Byte *voidp; +00236 <font class="preprocessor">#endif +</font>00237 <font class="preprocessor"></font> +00238 <font class="preprocessor">#ifdef HAVE_UNISTD_H +</font>00239 <font class="preprocessor"></font><font class="preprocessor"># include <sys/types.h></font> <font class="comment">/* for off_t */</font> +00240 <font class="preprocessor"># include <unistd.h></font> <font class="comment">/* for SEEK_* and off_t */</font> +00241 <font class="preprocessor"># define z_off_t off_t +</font>00242 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00243 <font class="preprocessor"></font><font class="preprocessor">#ifndef SEEK_SET +</font>00244 <font class="preprocessor"></font><font class="preprocessor"># define SEEK_SET 0 </font><font class="comment">/* Seek from beginning of file. */</font> +00245 <font class="preprocessor"># define SEEK_CUR 1 </font><font class="comment">/* Seek from current position. */</font> +00246 <font class="preprocessor"># define SEEK_END 2 </font><font class="comment">/* Set file pointer to EOF plus "offset" */</font> +00247 <font class="preprocessor">#endif +</font>00248 <font class="preprocessor"></font><font class="preprocessor">#ifndef z_off_t +</font>00249 <font class="preprocessor"></font><font class="preprocessor"># define z_off_t long +</font>00250 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00251 <font class="preprocessor"></font> +00252 <font class="comment">/* MVS linker does not support external names larger than 8 bytes */</font> +00253 <font class="preprocessor">#if defined(__MVS__) +</font>00254 <font class="preprocessor"></font><font class="preprocessor"># pragma map(deflateInit_,"DEIN") +</font>00255 <font class="preprocessor"></font><font class="preprocessor"># pragma map(deflateInit2_,"DEIN2") +</font>00256 <font class="preprocessor"></font><font class="preprocessor"># pragma map(deflateEnd,"DEEND") +</font>00257 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateInit_,"ININ") +</font>00258 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateInit2_,"ININ2") +</font>00259 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateEnd,"INEND") +</font>00260 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateSync,"INSY") +</font>00261 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateSetDictionary,"INSEDI") +</font>00262 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks,"INBL") +</font>00263 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks_new,"INBLNE") +</font>00264 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks_free,"INBLFR") +</font>00265 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks_reset,"INBLRE") +</font>00266 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_codes_free,"INCOFR") +</font>00267 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_codes,"INCO") +</font>00268 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_fast,"INFA") +</font>00269 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_flush,"INFLU") +</font>00270 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_mask,"INMA") +</font>00271 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_set_dictionary,"INSEDI2") +</font>00272 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_copyright,"INCOPY") +</font>00273 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_bits,"INTRBI") +</font>00274 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_dynamic,"INTRDY") +</font>00275 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_fixed,"INTRFI") +</font>00276 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_free,"INTRFR") +</font>00277 <font class="preprocessor"></font><font class="preprocessor">#endif +</font>00278 <font class="preprocessor"></font> +00279 <font class="preprocessor">#endif </font><font class="comment">/* _ZCONF_H */</font> +</div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zconf_8h-source.html b/doc/api-documentation/html/zconf_8h-source.html new file mode 100644 index 0000000..2cdb129 --- /dev/null +++ b/doc/api-documentation/html/zconf_8h-source.html @@ -0,0 +1,294 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>zconf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zconf.h</h1><div class="fragment"><pre>00001 <font class="comment">/* zconf.h -- configuration of the zlib compression library</font> +00002 <font class="comment"> * Copyright (C) 1995-1998 Jean-loup Gailly.</font> +00003 <font class="comment"> * For conditions of distribution and use, see copyright notice in zlib.h </font> +00004 <font class="comment"> */</font> +00005 +00006 <font class="comment">/* @(#) $Id: zconf_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $ */</font> +00007 +00008 <font class="preprocessor">#ifndef _ZCONF_H</font> +00009 <font class="preprocessor"></font><font class="preprocessor">#define _ZCONF_H</font> +00010 <font class="preprocessor"></font> +00011 <font class="comment">/*</font> +00012 <font class="comment"> * If you *really* need a unique prefix for all types and library functions,</font> +00013 <font class="comment"> * compile with -DZ_PREFIX. The "standard" zlib should be compiled without it.</font> +00014 <font class="comment"> */</font> +00015 <font class="preprocessor">#ifdef Z_PREFIX</font> +00016 <font class="preprocessor"></font><font class="preprocessor"># define deflateInit_ z_deflateInit_</font> +00017 <font class="preprocessor"></font><font class="preprocessor"># define deflate z_deflate</font> +00018 <font class="preprocessor"></font><font class="preprocessor"># define deflateEnd z_deflateEnd</font> +00019 <font class="preprocessor"></font><font class="preprocessor"># define inflateInit_ z_inflateInit_</font> +00020 <font class="preprocessor"></font><font class="preprocessor"># define inflate z_inflate</font> +00021 <font class="preprocessor"></font><font class="preprocessor"># define inflateEnd z_inflateEnd</font> +00022 <font class="preprocessor"></font><font class="preprocessor"># define deflateInit2_ z_deflateInit2_</font> +00023 <font class="preprocessor"></font><font class="preprocessor"># define deflateSetDictionary z_deflateSetDictionary</font> +00024 <font class="preprocessor"></font><font class="preprocessor"># define deflateCopy z_deflateCopy</font> +00025 <font class="preprocessor"></font><font class="preprocessor"># define deflateReset z_deflateReset</font> +00026 <font class="preprocessor"></font><font class="preprocessor"># define deflateParams z_deflateParams</font> +00027 <font class="preprocessor"></font><font class="preprocessor"># define inflateInit2_ z_inflateInit2_</font> +00028 <font class="preprocessor"></font><font class="preprocessor"># define inflateSetDictionary z_inflateSetDictionary</font> +00029 <font class="preprocessor"></font><font class="preprocessor"># define inflateSync z_inflateSync</font> +00030 <font class="preprocessor"></font><font class="preprocessor"># define inflateSyncPoint z_inflateSyncPoint</font> +00031 <font class="preprocessor"></font><font class="preprocessor"># define inflateReset z_inflateReset</font> +00032 <font class="preprocessor"></font><font class="preprocessor"># define compress z_compress</font> +00033 <font class="preprocessor"></font><font class="preprocessor"># define compress2 z_compress2</font> +00034 <font class="preprocessor"></font><font class="preprocessor"># define uncompress z_uncompress</font> +00035 <font class="preprocessor"></font><font class="preprocessor"># define adler32 z_adler32</font> +00036 <font class="preprocessor"></font><font class="preprocessor"># define crc32 z_crc32</font> +00037 <font class="preprocessor"></font><font class="preprocessor"># define get_crc_table z_get_crc_table</font> +00038 <font class="preprocessor"></font> +00039 <font class="preprocessor"># define Byte z_Byte</font> +00040 <font class="preprocessor"></font><font class="preprocessor"># define uInt z_uInt</font> +00041 <font class="preprocessor"></font><font class="preprocessor"># define uLong z_uLong</font> +00042 <font class="preprocessor"></font><font class="preprocessor"># define Bytef z_Bytef</font> +00043 <font class="preprocessor"></font><font class="preprocessor"># define charf z_charf</font> +00044 <font class="preprocessor"></font><font class="preprocessor"># define intf z_intf</font> +00045 <font class="preprocessor"></font><font class="preprocessor"># define uIntf z_uIntf</font> +00046 <font class="preprocessor"></font><font class="preprocessor"># define uLongf z_uLongf</font> +00047 <font class="preprocessor"></font><font class="preprocessor"># define voidpf z_voidpf</font> +00048 <font class="preprocessor"></font><font class="preprocessor"># define voidp z_voidp</font> +00049 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00050 <font class="preprocessor"></font> +00051 <font class="preprocessor">#if (defined(_WIN32) || defined(__WIN32__)) && !defined(WIN32)</font> +00052 <font class="preprocessor"></font><font class="preprocessor"># define WIN32</font> +00053 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00054 <font class="preprocessor"></font><font class="preprocessor">#if defined(__GNUC__) || defined(WIN32) || defined(__386__) || defined(i386)</font> +00055 <font class="preprocessor"></font><font class="preprocessor"># ifndef __32BIT__</font> +00056 <font class="preprocessor"></font><font class="preprocessor"># define __32BIT__</font> +00057 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00058 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00059 <font class="preprocessor"></font><font class="preprocessor">#if defined(__MSDOS__) && !defined(MSDOS)</font> +00060 <font class="preprocessor"></font><font class="preprocessor"># define MSDOS</font> +00061 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00062 <font class="preprocessor"></font> +00063 <font class="comment">/*</font> +00064 <font class="comment"> * Compile with -DMAXSEG_64K if the alloc function cannot allocate more</font> +00065 <font class="comment"> * than 64k bytes at a time (needed on systems with 16-bit int).</font> +00066 <font class="comment"> */</font> +00067 <font class="preprocessor">#if defined(MSDOS) && !defined(__32BIT__)</font> +00068 <font class="preprocessor"></font><font class="preprocessor"># define MAXSEG_64K</font> +00069 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00070 <font class="preprocessor"></font><font class="preprocessor">#ifdef MSDOS</font> +00071 <font class="preprocessor"></font><font class="preprocessor"># define UNALIGNED_OK</font> +00072 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00073 <font class="preprocessor"></font> +00074 <font class="preprocessor">#if (defined(MSDOS) || defined(_WINDOWS) || defined(WIN32)) && !defined(STDC)</font> +00075 <font class="preprocessor"></font><font class="preprocessor"># define STDC</font> +00076 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00077 <font class="preprocessor"></font><font class="preprocessor">#if defined(__STDC__) || defined(__cplusplus) || defined(__OS2__)</font> +00078 <font class="preprocessor"></font><font class="preprocessor"># ifndef STDC</font> +00079 <font class="preprocessor"></font><font class="preprocessor"># define STDC</font> +00080 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00081 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00082 <font class="preprocessor"></font> +00083 <font class="preprocessor">#ifndef STDC</font> +00084 <font class="preprocessor"></font><font class="preprocessor"># ifndef const </font><font class="comment">/* cannot use !defined(STDC) && !defined(const) on Mac */</font> +00085 <font class="preprocessor"># define const</font> +00086 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00087 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00088 <font class="preprocessor"></font> +00089 <font class="comment">/* Some Mac compilers merge all .h files incorrectly: */</font> +00090 <font class="preprocessor">#if defined(__MWERKS__) || defined(applec) ||defined(THINK_C) ||defined(__SC__)</font> +00091 <font class="preprocessor"></font><font class="preprocessor"># define NO_DUMMY_DECL</font> +00092 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00093 <font class="preprocessor"></font> +00094 <font class="comment">/* Old Borland C incorrectly complains about missing returns: */</font> +00095 <font class="preprocessor">#if defined(__BORLANDC__) && (__BORLANDC__ < 0x500)</font> +00096 <font class="preprocessor"></font><font class="preprocessor"># define NEED_DUMMY_RETURN</font> +00097 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00098 <font class="preprocessor"></font> +00099 +00100 <font class="comment">/* Maximum value for memLevel in deflateInit2 */</font> +00101 <font class="preprocessor">#ifndef MAX_MEM_LEVEL</font> +00102 <font class="preprocessor"></font><font class="preprocessor"># ifdef MAXSEG_64K</font> +00103 <font class="preprocessor"></font><font class="preprocessor"># define MAX_MEM_LEVEL 8</font> +00104 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00105 <font class="preprocessor"></font><font class="preprocessor"># define MAX_MEM_LEVEL 9</font> +00106 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00107 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00108 <font class="preprocessor"></font> +00109 <font class="comment">/* Maximum value for windowBits in deflateInit2 and inflateInit2.</font> +00110 <font class="comment"> * WARNING: reducing MAX_WBITS makes minigzip unable to extract .gz files</font> +00111 <font class="comment"> * created by gzip. (Files created by minigzip can still be extracted by</font> +00112 <font class="comment"> * gzip.)</font> +00113 <font class="comment"> */</font> +00114 <font class="preprocessor">#ifndef MAX_WBITS</font> +00115 <font class="preprocessor"></font><font class="preprocessor"># define MAX_WBITS 15 </font><font class="comment">/* 32K LZ77 window */</font> +00116 <font class="preprocessor">#endif</font> +00117 <font class="preprocessor"></font> +00118 <font class="comment">/* The memory requirements for deflate are (in bytes):</font> +00119 <font class="comment"> (1 << (windowBits+2)) + (1 << (memLevel+9))</font> +00120 <font class="comment"> that is: 128K for windowBits=15 + 128K for memLevel = 8 (default values)</font> +00121 <font class="comment"> plus a few kilobytes for small objects. For example, if you want to reduce</font> +00122 <font class="comment"> the default memory requirements from 256K to 128K, compile with</font> +00123 <font class="comment"> make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7"</font> +00124 <font class="comment"> Of course this will generally degrade compression (there's no free lunch).</font> +00125 <font class="comment"></font> +00126 <font class="comment"> The memory requirements for inflate are (in bytes) 1 << windowBits</font> +00127 <font class="comment"> that is, 32K for windowBits=15 (default value) plus a few kilobytes</font> +00128 <font class="comment"> for small objects.</font> +00129 <font class="comment">*/</font> +00130 +00131 <font class="comment">/* Type declarations */</font> +00132 +00133 <font class="preprocessor">#ifndef OF </font><font class="comment">/* function prototypes */</font> +00134 <font class="preprocessor"># ifdef STDC</font> +00135 <font class="preprocessor"></font><font class="preprocessor"># define OF(args) args</font> +00136 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00137 <font class="preprocessor"></font><font class="preprocessor"># define OF(args) ()</font> +00138 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00139 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00140 <font class="preprocessor"></font> +00141 <font class="comment">/* The following definitions for FAR are needed only for MSDOS mixed</font> +00142 <font class="comment"> * model programming (small or medium model with some far allocations).</font> +00143 <font class="comment"> * This was tested only with MSC; for other MSDOS compilers you may have</font> +00144 <font class="comment"> * to define NO_MEMCPY in zutil.h. If you don't need the mixed model,</font> +00145 <font class="comment"> * just define FAR to be empty.</font> +00146 <font class="comment"> */</font> +00147 <font class="preprocessor">#if (defined(M_I86SM) || defined(M_I86MM)) && !defined(__32BIT__)</font> +00148 <font class="preprocessor"></font> <font class="comment">/* MSC small or medium model */</font> +00149 <font class="preprocessor"># define SMALL_MEDIUM</font> +00150 <font class="preprocessor"></font><font class="preprocessor"># ifdef _MSC_VER</font> +00151 <font class="preprocessor"></font><font class="preprocessor"># define FAR _far</font> +00152 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00153 <font class="preprocessor"></font><font class="preprocessor"># define FAR far</font> +00154 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00155 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00156 <font class="preprocessor"></font><font class="preprocessor">#if defined(__BORLANDC__) && (defined(__SMALL__) || defined(__MEDIUM__))</font> +00157 <font class="preprocessor"></font><font class="preprocessor"># ifndef __32BIT__</font> +00158 <font class="preprocessor"></font><font class="preprocessor"># define SMALL_MEDIUM</font> +00159 <font class="preprocessor"></font><font class="preprocessor"># define FAR _far</font> +00160 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00161 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00162 <font class="preprocessor"></font> +00163 <font class="comment">/* Compile with -DZLIB_DLL for Windows DLL support */</font> +00164 <font class="preprocessor">#if defined(ZLIB_DLL)</font> +00165 <font class="preprocessor"></font><font class="preprocessor"># if defined(_WINDOWS) || defined(WINDOWS)</font> +00166 <font class="preprocessor"></font><font class="preprocessor"># ifdef FAR</font> +00167 <font class="preprocessor"></font><font class="preprocessor"># undef FAR</font> +00168 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00169 <font class="preprocessor"></font><font class="preprocessor"># include <windows.h></font> +00170 <font class="preprocessor"># define ZEXPORT WINAPI</font> +00171 <font class="preprocessor"></font><font class="preprocessor"># ifdef WIN32</font> +00172 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA WINAPIV</font> +00173 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00174 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA FAR _cdecl _export</font> +00175 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00176 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00177 <font class="preprocessor"></font><font class="preprocessor"># if defined (__BORLANDC__)</font> +00178 <font class="preprocessor"></font><font class="preprocessor"># if (__BORLANDC__ >= 0x0500) && defined (WIN32)</font> +00179 <font class="preprocessor"></font><font class="preprocessor"># include <windows.h></font> +00180 <font class="preprocessor"># define ZEXPORT __declspec(dllexport) WINAPI</font> +00181 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTRVA __declspec(dllexport) WINAPIV</font> +00182 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00183 <font class="preprocessor"></font><font class="preprocessor"># if defined (_Windows) && defined (__DLL__)</font> +00184 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORT _export</font> +00185 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA _export</font> +00186 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00187 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00188 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00189 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00190 <font class="preprocessor"></font> +00191 <font class="preprocessor">#if defined (__BEOS__)</font> +00192 <font class="preprocessor"></font><font class="preprocessor"># if defined (ZLIB_DLL)</font> +00193 <font class="preprocessor"></font><font class="preprocessor"># define ZEXTERN extern __declspec(dllexport)</font> +00194 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00195 <font class="preprocessor"></font><font class="preprocessor"># define ZEXTERN extern __declspec(dllimport)</font> +00196 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00197 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00198 <font class="preprocessor"></font> +00199 <font class="preprocessor">#ifndef ZEXPORT</font> +00200 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORT</font> +00201 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00202 <font class="preprocessor"></font><font class="preprocessor">#ifndef ZEXPORTVA</font> +00203 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA</font> +00204 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00205 <font class="preprocessor"></font><font class="preprocessor">#ifndef ZEXTERN</font> +00206 <font class="preprocessor"></font><font class="preprocessor"># define ZEXTERN extern</font> +00207 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00208 <font class="preprocessor"></font> +00209 <font class="preprocessor">#ifndef FAR</font> +00210 <font class="preprocessor"></font><font class="preprocessor"># define FAR</font> +00211 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00212 <font class="preprocessor"></font> +00213 <font class="preprocessor">#if !defined(MACOS) && !defined(TARGET_OS_MAC) && !defined(VCL)</font> +00214 <font class="preprocessor"></font><font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Byte; <font class="comment">/* 8 bits */</font> +00215 <font class="preprocessor">#endif</font> +00216 <font class="preprocessor"></font><font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> uInt; <font class="comment">/* 16 bits or more */</font> +00217 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> uLong; <font class="comment">/* 32 bits or more */</font> +00218 +00219 <font class="preprocessor">#ifdef SMALL_MEDIUM</font> +00220 <font class="preprocessor"></font> <font class="comment">/* Borland C/C++ and some old MSC versions ignore FAR inside typedef */</font> +00221 <font class="preprocessor"># define Bytef Byte FAR</font> +00222 <font class="preprocessor"></font><font class="preprocessor">#else</font> +00223 <font class="preprocessor"></font> <font class="keyword">typedef</font> Byte FAR Bytef; +00224 <font class="preprocessor">#endif</font> +00225 <font class="preprocessor"></font><font class="keyword">typedef</font> <font class="keywordtype">char</font> FAR charf; +00226 <font class="keyword">typedef</font> <font class="keywordtype">int</font> FAR intf; +00227 <font class="keyword">typedef</font> uInt FAR uIntf; +00228 <font class="keyword">typedef</font> uLong FAR uLongf; +00229 +00230 <font class="preprocessor">#ifdef STDC</font> +00231 <font class="preprocessor"></font> <font class="keyword">typedef</font> <font class="keywordtype">void</font> FAR *voidpf; +00232 <font class="keyword">typedef</font> <font class="keywordtype">void</font> *voidp; +00233 <font class="preprocessor">#else</font> +00234 <font class="preprocessor"></font> <font class="keyword">typedef</font> Byte FAR *voidpf; +00235 <font class="keyword">typedef</font> Byte *voidp; +00236 <font class="preprocessor">#endif</font> +00237 <font class="preprocessor"></font> +00238 <font class="preprocessor">#ifdef HAVE_UNISTD_H</font> +00239 <font class="preprocessor"></font><font class="preprocessor"># include <sys/types.h></font> <font class="comment">/* for off_t */</font> +00240 <font class="preprocessor"># include <unistd.h></font> <font class="comment">/* for SEEK_* and off_t */</font> +00241 <font class="preprocessor"># define z_off_t off_t</font> +00242 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00243 <font class="preprocessor"></font><font class="preprocessor">#ifndef SEEK_SET</font> +00244 <font class="preprocessor"></font><font class="preprocessor"># define SEEK_SET 0 </font><font class="comment">/* Seek from beginning of file. */</font> +00245 <font class="preprocessor"># define SEEK_CUR 1 </font><font class="comment">/* Seek from current position. */</font> +00246 <font class="preprocessor"># define SEEK_END 2 </font><font class="comment">/* Set file pointer to EOF plus "offset" */</font> +00247 <font class="preprocessor">#endif</font> +00248 <font class="preprocessor"></font><font class="preprocessor">#ifndef z_off_t</font> +00249 <font class="preprocessor"></font><font class="preprocessor"># define z_off_t long</font> +00250 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00251 <font class="preprocessor"></font> +00252 <font class="comment">/* MVS linker does not support external names larger than 8 bytes */</font> +00253 <font class="preprocessor">#if defined(__MVS__)</font> +00254 <font class="preprocessor"></font><font class="preprocessor"># pragma map(deflateInit_,"DEIN")</font> +00255 <font class="preprocessor"></font><font class="preprocessor"># pragma map(deflateInit2_,"DEIN2")</font> +00256 <font class="preprocessor"></font><font class="preprocessor"># pragma map(deflateEnd,"DEEND")</font> +00257 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateInit_,"ININ")</font> +00258 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateInit2_,"ININ2")</font> +00259 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateEnd,"INEND")</font> +00260 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateSync,"INSY")</font> +00261 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateSetDictionary,"INSEDI")</font> +00262 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks,"INBL")</font> +00263 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks_new,"INBLNE")</font> +00264 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks_free,"INBLFR")</font> +00265 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks_reset,"INBLRE")</font> +00266 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_codes_free,"INCOFR")</font> +00267 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_codes,"INCO")</font> +00268 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_fast,"INFA")</font> +00269 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_flush,"INFLU")</font> +00270 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_mask,"INMA")</font> +00271 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_set_dictionary,"INSEDI2")</font> +00272 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_copyright,"INCOPY")</font> +00273 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_bits,"INTRBI")</font> +00274 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_dynamic,"INTRDY")</font> +00275 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_fixed,"INTRFI")</font> +00276 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_free,"INTRFR")</font> +00277 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00278 <font class="preprocessor"></font> +00279 <font class="preprocessor">#endif </font><font class="comment">/* _ZCONF_H */</font> +</pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zconf_h-source.html b/doc/api-documentation/html/zconf_h-source.html new file mode 100644 index 0000000..1019172 --- /dev/null +++ b/doc/api-documentation/html/zconf_h-source.html @@ -0,0 +1,295 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>zconf.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zconf.h</h1><div class="fragment"><pre>00001 <font class="comment">/* zconf.h -- configuration of the zlib compression library</font> +00002 <font class="comment"> * Copyright (C) 1995-1998 Jean-loup Gailly.</font> +00003 <font class="comment"> * For conditions of distribution and use, see copyright notice in zlib.h </font> +00004 <font class="comment"> */</font> +00005 +00006 <font class="comment">/* @(#) $Id: zconf_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $ */</font> +00007 +00008 <font class="preprocessor">#ifndef _ZCONF_H</font> +00009 <font class="preprocessor"></font><font class="preprocessor">#define _ZCONF_H</font> +00010 <font class="preprocessor"></font> +00011 <font class="comment">/*</font> +00012 <font class="comment"> * If you *really* need a unique prefix for all types and library functions,</font> +00013 <font class="comment"> * compile with -DZ_PREFIX. The "standard" zlib should be compiled without it.</font> +00014 <font class="comment"> */</font> +00015 <font class="preprocessor">#ifdef Z_PREFIX</font> +00016 <font class="preprocessor"></font><font class="preprocessor"># define deflateInit_ z_deflateInit_</font> +00017 <font class="preprocessor"></font><font class="preprocessor"># define deflate z_deflate</font> +00018 <font class="preprocessor"></font><font class="preprocessor"># define deflateEnd z_deflateEnd</font> +00019 <font class="preprocessor"></font><font class="preprocessor"># define inflateInit_ z_inflateInit_</font> +00020 <font class="preprocessor"></font><font class="preprocessor"># define inflate z_inflate</font> +00021 <font class="preprocessor"></font><font class="preprocessor"># define inflateEnd z_inflateEnd</font> +00022 <font class="preprocessor"></font><font class="preprocessor"># define deflateInit2_ z_deflateInit2_</font> +00023 <font class="preprocessor"></font><font class="preprocessor"># define deflateSetDictionary z_deflateSetDictionary</font> +00024 <font class="preprocessor"></font><font class="preprocessor"># define deflateCopy z_deflateCopy</font> +00025 <font class="preprocessor"></font><font class="preprocessor"># define deflateReset z_deflateReset</font> +00026 <font class="preprocessor"></font><font class="preprocessor"># define deflateParams z_deflateParams</font> +00027 <font class="preprocessor"></font><font class="preprocessor"># define inflateInit2_ z_inflateInit2_</font> +00028 <font class="preprocessor"></font><font class="preprocessor"># define inflateSetDictionary z_inflateSetDictionary</font> +00029 <font class="preprocessor"></font><font class="preprocessor"># define inflateSync z_inflateSync</font> +00030 <font class="preprocessor"></font><font class="preprocessor"># define inflateSyncPoint z_inflateSyncPoint</font> +00031 <font class="preprocessor"></font><font class="preprocessor"># define inflateReset z_inflateReset</font> +00032 <font class="preprocessor"></font><font class="preprocessor"># define compress z_compress</font> +00033 <font class="preprocessor"></font><font class="preprocessor"># define compress2 z_compress2</font> +00034 <font class="preprocessor"></font><font class="preprocessor"># define uncompress z_uncompress</font> +00035 <font class="preprocessor"></font><font class="preprocessor"># define adler32 z_adler32</font> +00036 <font class="preprocessor"></font><font class="preprocessor"># define crc32 z_crc32</font> +00037 <font class="preprocessor"></font><font class="preprocessor"># define get_crc_table z_get_crc_table</font> +00038 <font class="preprocessor"></font> +00039 <font class="preprocessor"># define Byte z_Byte</font> +00040 <font class="preprocessor"></font><font class="preprocessor"># define uInt z_uInt</font> +00041 <font class="preprocessor"></font><font class="preprocessor"># define uLong z_uLong</font> +00042 <font class="preprocessor"></font><font class="preprocessor"># define Bytef z_Bytef</font> +00043 <font class="preprocessor"></font><font class="preprocessor"># define charf z_charf</font> +00044 <font class="preprocessor"></font><font class="preprocessor"># define intf z_intf</font> +00045 <font class="preprocessor"></font><font class="preprocessor"># define uIntf z_uIntf</font> +00046 <font class="preprocessor"></font><font class="preprocessor"># define uLongf z_uLongf</font> +00047 <font class="preprocessor"></font><font class="preprocessor"># define voidpf z_voidpf</font> +00048 <font class="preprocessor"></font><font class="preprocessor"># define voidp z_voidp</font> +00049 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00050 <font class="preprocessor"></font> +00051 <font class="preprocessor">#if (defined(_WIN32) || defined(__WIN32__)) && !defined(WIN32)</font> +00052 <font class="preprocessor"></font><font class="preprocessor"># define WIN32</font> +00053 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00054 <font class="preprocessor"></font><font class="preprocessor">#if defined(__GNUC__) || defined(WIN32) || defined(__386__) || defined(i386)</font> +00055 <font class="preprocessor"></font><font class="preprocessor"># ifndef __32BIT__</font> +00056 <font class="preprocessor"></font><font class="preprocessor"># define __32BIT__</font> +00057 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00058 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00059 <font class="preprocessor"></font><font class="preprocessor">#if defined(__MSDOS__) && !defined(MSDOS)</font> +00060 <font class="preprocessor"></font><font class="preprocessor"># define MSDOS</font> +00061 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00062 <font class="preprocessor"></font> +00063 <font class="comment">/*</font> +00064 <font class="comment"> * Compile with -DMAXSEG_64K if the alloc function cannot allocate more</font> +00065 <font class="comment"> * than 64k bytes at a time (needed on systems with 16-bit int).</font> +00066 <font class="comment"> */</font> +00067 <font class="preprocessor">#if defined(MSDOS) && !defined(__32BIT__)</font> +00068 <font class="preprocessor"></font><font class="preprocessor"># define MAXSEG_64K</font> +00069 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00070 <font class="preprocessor"></font><font class="preprocessor">#ifdef MSDOS</font> +00071 <font class="preprocessor"></font><font class="preprocessor"># define UNALIGNED_OK</font> +00072 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00073 <font class="preprocessor"></font> +00074 <font class="preprocessor">#if (defined(MSDOS) || defined(_WINDOWS) || defined(WIN32)) && !defined(STDC)</font> +00075 <font class="preprocessor"></font><font class="preprocessor"># define STDC</font> +00076 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00077 <font class="preprocessor"></font><font class="preprocessor">#if defined(__STDC__) || defined(__cplusplus) || defined(__OS2__)</font> +00078 <font class="preprocessor"></font><font class="preprocessor"># ifndef STDC</font> +00079 <font class="preprocessor"></font><font class="preprocessor"># define STDC</font> +00080 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00081 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00082 <font class="preprocessor"></font> +00083 <font class="preprocessor">#ifndef STDC</font> +00084 <font class="preprocessor"></font><font class="preprocessor"># ifndef const </font><font class="comment">/* cannot use !defined(STDC) && !defined(const) on Mac */</font> +00085 <font class="preprocessor"># define const</font> +00086 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00087 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00088 <font class="preprocessor"></font> +00089 <font class="comment">/* Some Mac compilers merge all .h files incorrectly: */</font> +00090 <font class="preprocessor">#if defined(__MWERKS__) || defined(applec) ||defined(THINK_C) ||defined(__SC__)</font> +00091 <font class="preprocessor"></font><font class="preprocessor"># define NO_DUMMY_DECL</font> +00092 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00093 <font class="preprocessor"></font> +00094 <font class="comment">/* Old Borland C incorrectly complains about missing returns: */</font> +00095 <font class="preprocessor">#if defined(__BORLANDC__) && (__BORLANDC__ < 0x500)</font> +00096 <font class="preprocessor"></font><font class="preprocessor"># define NEED_DUMMY_RETURN</font> +00097 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00098 <font class="preprocessor"></font> +00099 +00100 <font class="comment">/* Maximum value for memLevel in deflateInit2 */</font> +00101 <font class="preprocessor">#ifndef MAX_MEM_LEVEL</font> +00102 <font class="preprocessor"></font><font class="preprocessor"># ifdef MAXSEG_64K</font> +00103 <font class="preprocessor"></font><font class="preprocessor"># define MAX_MEM_LEVEL 8</font> +00104 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00105 <font class="preprocessor"></font><font class="preprocessor"># define MAX_MEM_LEVEL 9</font> +00106 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00107 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00108 <font class="preprocessor"></font> +00109 <font class="comment">/* Maximum value for windowBits in deflateInit2 and inflateInit2.</font> +00110 <font class="comment"> * WARNING: reducing MAX_WBITS makes minigzip unable to extract .gz files</font> +00111 <font class="comment"> * created by gzip. (Files created by minigzip can still be extracted by</font> +00112 <font class="comment"> * gzip.)</font> +00113 <font class="comment"> */</font> +00114 <font class="preprocessor">#ifndef MAX_WBITS</font> +00115 <font class="preprocessor"></font><font class="preprocessor"># define MAX_WBITS 15 </font><font class="comment">/* 32K LZ77 window */</font> +00116 <font class="preprocessor">#endif</font> +00117 <font class="preprocessor"></font> +00118 <font class="comment">/* The memory requirements for deflate are (in bytes):</font> +00119 <font class="comment"> (1 << (windowBits+2)) + (1 << (memLevel+9))</font> +00120 <font class="comment"> that is: 128K for windowBits=15 + 128K for memLevel = 8 (default values)</font> +00121 <font class="comment"> plus a few kilobytes for small objects. For example, if you want to reduce</font> +00122 <font class="comment"> the default memory requirements from 256K to 128K, compile with</font> +00123 <font class="comment"> make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7"</font> +00124 <font class="comment"> Of course this will generally degrade compression (there's no free lunch).</font> +00125 <font class="comment"></font> +00126 <font class="comment"> The memory requirements for inflate are (in bytes) 1 << windowBits</font> +00127 <font class="comment"> that is, 32K for windowBits=15 (default value) plus a few kilobytes</font> +00128 <font class="comment"> for small objects.</font> +00129 <font class="comment">*/</font> +00130 +00131 <font class="comment">/* Type declarations */</font> +00132 +00133 <font class="preprocessor">#ifndef OF </font><font class="comment">/* function prototypes */</font> +00134 <font class="preprocessor"># ifdef STDC</font> +00135 <font class="preprocessor"></font><font class="preprocessor"># define OF(args) args</font> +00136 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00137 <font class="preprocessor"></font><font class="preprocessor"># define OF(args) ()</font> +00138 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00139 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00140 <font class="preprocessor"></font> +00141 <font class="comment">/* The following definitions for FAR are needed only for MSDOS mixed</font> +00142 <font class="comment"> * model programming (small or medium model with some far allocations).</font> +00143 <font class="comment"> * This was tested only with MSC; for other MSDOS compilers you may have</font> +00144 <font class="comment"> * to define NO_MEMCPY in zutil.h. If you don't need the mixed model,</font> +00145 <font class="comment"> * just define FAR to be empty.</font> +00146 <font class="comment"> */</font> +00147 <font class="preprocessor">#if (defined(M_I86SM) || defined(M_I86MM)) && !defined(__32BIT__)</font> +00148 <font class="preprocessor"></font> <font class="comment">/* MSC small or medium model */</font> +00149 <font class="preprocessor"># define SMALL_MEDIUM</font> +00150 <font class="preprocessor"></font><font class="preprocessor"># ifdef _MSC_VER</font> +00151 <font class="preprocessor"></font><font class="preprocessor"># define FAR _far</font> +00152 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00153 <font class="preprocessor"></font><font class="preprocessor"># define FAR far</font> +00154 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00155 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00156 <font class="preprocessor"></font><font class="preprocessor">#if defined(__BORLANDC__) && (defined(__SMALL__) || defined(__MEDIUM__))</font> +00157 <font class="preprocessor"></font><font class="preprocessor"># ifndef __32BIT__</font> +00158 <font class="preprocessor"></font><font class="preprocessor"># define SMALL_MEDIUM</font> +00159 <font class="preprocessor"></font><font class="preprocessor"># define FAR _far</font> +00160 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00161 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00162 <font class="preprocessor"></font> +00163 <font class="comment">/* Compile with -DZLIB_DLL for Windows DLL support */</font> +00164 <font class="preprocessor">#if defined(ZLIB_DLL)</font> +00165 <font class="preprocessor"></font><font class="preprocessor"># if defined(_WINDOWS) || defined(WINDOWS)</font> +00166 <font class="preprocessor"></font><font class="preprocessor"># ifdef FAR</font> +00167 <font class="preprocessor"></font><font class="preprocessor"># undef FAR</font> +00168 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00169 <font class="preprocessor"></font><font class="preprocessor"># include <windows.h></font> +00170 <font class="preprocessor"># define ZEXPORT WINAPI</font> +00171 <font class="preprocessor"></font><font class="preprocessor"># ifdef WIN32</font> +00172 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA WINAPIV</font> +00173 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00174 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA FAR _cdecl _export</font> +00175 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00176 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00177 <font class="preprocessor"></font><font class="preprocessor"># if defined (__BORLANDC__)</font> +00178 <font class="preprocessor"></font><font class="preprocessor"># if (__BORLANDC__ >= 0x0500) && defined (WIN32)</font> +00179 <font class="preprocessor"></font><font class="preprocessor"># include <windows.h></font> +00180 <font class="preprocessor"># define ZEXPORT __declspec(dllexport) WINAPI</font> +00181 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTRVA __declspec(dllexport) WINAPIV</font> +00182 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00183 <font class="preprocessor"></font><font class="preprocessor"># if defined (_Windows) && defined (__DLL__)</font> +00184 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORT _export</font> +00185 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA _export</font> +00186 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00187 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00188 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00189 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00190 <font class="preprocessor"></font> +00191 <font class="preprocessor">#if defined (__BEOS__)</font> +00192 <font class="preprocessor"></font><font class="preprocessor"># if defined (ZLIB_DLL)</font> +00193 <font class="preprocessor"></font><font class="preprocessor"># define ZEXTERN extern __declspec(dllexport)</font> +00194 <font class="preprocessor"></font><font class="preprocessor"># else</font> +00195 <font class="preprocessor"></font><font class="preprocessor"># define ZEXTERN extern __declspec(dllimport)</font> +00196 <font class="preprocessor"></font><font class="preprocessor"># endif</font> +00197 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00198 <font class="preprocessor"></font> +00199 <font class="preprocessor">#ifndef ZEXPORT</font> +00200 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORT</font> +00201 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00202 <font class="preprocessor"></font><font class="preprocessor">#ifndef ZEXPORTVA</font> +00203 <font class="preprocessor"></font><font class="preprocessor"># define ZEXPORTVA</font> +00204 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00205 <font class="preprocessor"></font><font class="preprocessor">#ifndef ZEXTERN</font> +00206 <font class="preprocessor"></font><font class="preprocessor"># define ZEXTERN extern</font> +00207 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00208 <font class="preprocessor"></font> +00209 <font class="preprocessor">#ifndef FAR</font> +00210 <font class="preprocessor"></font><font class="preprocessor"># define FAR</font> +00211 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00212 <font class="preprocessor"></font> +00213 <font class="preprocessor">#if !defined(MACOS) && !defined(TARGET_OS_MAC) && !defined(VCL)</font> +00214 <font class="preprocessor"></font><font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">char</font> Byte; <font class="comment">/* 8 bits */</font> +00215 <font class="preprocessor">#endif</font> +00216 <font class="preprocessor"></font><font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> uInt; <font class="comment">/* 16 bits or more */</font> +00217 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> uLong; <font class="comment">/* 32 bits or more */</font> +00218 +00219 <font class="preprocessor">#ifdef SMALL_MEDIUM</font> +00220 <font class="preprocessor"></font> <font class="comment">/* Borland C/C++ and some old MSC versions ignore FAR inside typedef */</font> +00221 <font class="preprocessor"># define Bytef Byte FAR</font> +00222 <font class="preprocessor"></font><font class="preprocessor">#else</font> +00223 <font class="preprocessor"></font> <font class="keyword">typedef</font> Byte FAR Bytef; +00224 <font class="preprocessor">#endif</font> +00225 <font class="preprocessor"></font><font class="keyword">typedef</font> <font class="keywordtype">char</font> FAR charf; +00226 <font class="keyword">typedef</font> <font class="keywordtype">int</font> FAR intf; +00227 <font class="keyword">typedef</font> uInt FAR uIntf; +00228 <font class="keyword">typedef</font> uLong FAR uLongf; +00229 +00230 <font class="preprocessor">#ifdef STDC</font> +00231 <font class="preprocessor"></font> <font class="keyword">typedef</font> <font class="keywordtype">void</font> FAR *voidpf; +00232 <font class="keyword">typedef</font> <font class="keywordtype">void</font> *voidp; +00233 <font class="preprocessor">#else</font> +00234 <font class="preprocessor"></font> <font class="keyword">typedef</font> Byte FAR *voidpf; +00235 <font class="keyword">typedef</font> Byte *voidp; +00236 <font class="preprocessor">#endif</font> +00237 <font class="preprocessor"></font> +00238 <font class="preprocessor">#ifdef HAVE_UNISTD_H</font> +00239 <font class="preprocessor"></font><font class="preprocessor"># include <sys/types.h></font> <font class="comment">/* for off_t */</font> +00240 <font class="preprocessor"># include <unistd.h></font> <font class="comment">/* for SEEK_* and off_t */</font> +00241 <font class="preprocessor"># define z_off_t off_t</font> +00242 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00243 <font class="preprocessor"></font><font class="preprocessor">#ifndef SEEK_SET</font> +00244 <font class="preprocessor"></font><font class="preprocessor"># define SEEK_SET 0 </font><font class="comment">/* Seek from beginning of file. */</font> +00245 <font class="preprocessor"># define SEEK_CUR 1 </font><font class="comment">/* Seek from current position. */</font> +00246 <font class="preprocessor"># define SEEK_END 2 </font><font class="comment">/* Set file pointer to EOF plus "offset" */</font> +00247 <font class="preprocessor">#endif</font> +00248 <font class="preprocessor"></font><font class="preprocessor">#ifndef z_off_t</font> +00249 <font class="preprocessor"></font><font class="preprocessor"># define z_off_t long</font> +00250 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00251 <font class="preprocessor"></font> +00252 <font class="comment">/* MVS linker does not support external names larger than 8 bytes */</font> +00253 <font class="preprocessor">#if defined(__MVS__)</font> +00254 <font class="preprocessor"></font><font class="preprocessor"># pragma map(deflateInit_,"DEIN")</font> +00255 <font class="preprocessor"></font><font class="preprocessor"># pragma map(deflateInit2_,"DEIN2")</font> +00256 <font class="preprocessor"></font><font class="preprocessor"># pragma map(deflateEnd,"DEEND")</font> +00257 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateInit_,"ININ")</font> +00258 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateInit2_,"ININ2")</font> +00259 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateEnd,"INEND")</font> +00260 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateSync,"INSY")</font> +00261 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflateSetDictionary,"INSEDI")</font> +00262 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks,"INBL")</font> +00263 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks_new,"INBLNE")</font> +00264 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks_free,"INBLFR")</font> +00265 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_blocks_reset,"INBLRE")</font> +00266 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_codes_free,"INCOFR")</font> +00267 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_codes,"INCO")</font> +00268 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_fast,"INFA")</font> +00269 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_flush,"INFLU")</font> +00270 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_mask,"INMA")</font> +00271 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_set_dictionary,"INSEDI2")</font> +00272 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_copyright,"INCOPY")</font> +00273 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_bits,"INTRBI")</font> +00274 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_dynamic,"INTRDY")</font> +00275 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_fixed,"INTRFI")</font> +00276 <font class="preprocessor"></font><font class="preprocessor"># pragma map(inflate_trees_free,"INTRFR")</font> +00277 <font class="preprocessor"></font><font class="preprocessor">#endif</font> +00278 <font class="preprocessor"></font> +00279 <font class="preprocessor">#endif </font><font class="comment">/* _ZCONF_H */</font> +</pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zipcomprs.h-source.html b/doc/api-documentation/html/zipcomprs.h-source.html new file mode 100644 index 0000000..6c9f137 --- /dev/null +++ b/doc/api-documentation/html/zipcomprs.h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>zipcomprs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zipcomprs.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * swcomprs.h - definition of Class SWCompress used for data compression +</font>00003 <font class="comment"> * +</font>00004 <font class="comment"> * $Id: zipcomprs.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00005 <font class="comment"> * +</font>00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00007 <font class="comment"> * CrossWire Bible Society +</font>00008 <font class="comment"> * P. O. Box 2528 +</font>00009 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00010 <font class="comment"> * +</font>00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00012 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00013 <font class="comment"> * Free Software Foundation version 2. +</font>00014 <font class="comment"> * +</font>00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00018 <font class="comment"> * General Public License for more details. +</font>00019 <font class="comment"> * +</font>00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef ZIPCOMPRS_H +</font>00023 <font class="preprocessor"></font><font class="preprocessor">#define ZIPCOMPRS_H +</font>00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swcomprs.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT ZipCompress:<font class="keyword">public</font> SWCompress +00030 { +00031 <font class="keyword">protected</font>: +00032 <font class="keyword">public</font>: +00033 ZipCompress (); +00034 <font class="keyword">virtual</font> ~ ZipCompress (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); +00036 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); +00037 }; +00038 +00039 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:26 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zipcomprs_8h-source.html b/doc/api-documentation/html/zipcomprs_8h-source.html new file mode 100644 index 0000000..8a46b3f --- /dev/null +++ b/doc/api-documentation/html/zipcomprs_8h-source.html @@ -0,0 +1,54 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>zipcomprs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zipcomprs.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swcomprs.h - definition of Class SWCompress used for data compression</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: zipcomprs_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef ZIPCOMPRS_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define ZIPCOMPRS_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swcomprs.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT ZipCompress:<font class="keyword">public</font> SWCompress +00030 { +00031 <font class="keyword">protected</font>: +00032 <font class="keyword">public</font>: +00033 ZipCompress (); +00034 <font class="keyword">virtual</font> ~ ZipCompress (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); +00036 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); +00037 }; +00038 +00039 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zipcomprs_h-source.html b/doc/api-documentation/html/zipcomprs_h-source.html new file mode 100644 index 0000000..68c4be6 --- /dev/null +++ b/doc/api-documentation/html/zipcomprs_h-source.html @@ -0,0 +1,55 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>zipcomprs.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zipcomprs.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * swcomprs.h - definition of Class SWCompress used for data compression</font> +00003 <font class="comment"> *</font> +00004 <font class="comment"> * $Id: zipcomprs_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00005 <font class="comment"> *</font> +00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00007 <font class="comment"> * CrossWire Bible Society</font> +00008 <font class="comment"> * P. O. Box 2528</font> +00009 <font class="comment"> * Tempe, AZ 85280-2528</font> +00010 <font class="comment"> *</font> +00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00013 <font class="comment"> * Free Software Foundation version 2.</font> +00014 <font class="comment"> *</font> +00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"> *</font> +00020 <font class="comment"> */</font> +00021 +00022 <font class="preprocessor">#ifndef ZIPCOMPRS_H</font> +00023 <font class="preprocessor"></font><font class="preprocessor">#define ZIPCOMPRS_H</font> +00024 <font class="preprocessor"></font> +00025 <font class="preprocessor">#include <swcomprs.h></font> +00026 +00027 <font class="preprocessor">#include <defs.h></font> +00028 +00029 <font class="keyword">class </font>SWDLLEXPORT ZipCompress:<font class="keyword">public</font> SWCompress +00030 { +00031 <font class="keyword">protected</font>: +00032 <font class="keyword">public</font>: +00033 ZipCompress (); +00034 <font class="keyword">virtual</font> ~ ZipCompress (); +00035 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Encode (<font class="keywordtype">void</font>); +00036 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Decode (<font class="keywordtype">void</font>); +00037 }; +00038 +00039 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zlib.h-source.html b/doc/api-documentation/html/zlib.h-source.html new file mode 100644 index 0000000..b436ad9 --- /dev/null +++ b/doc/api-documentation/html/zlib.h-source.html @@ -0,0 +1,908 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>zlib.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:26 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zlib.h</h1><div class="fragment"><pre>00001 <font class="comment">/* zlib.h -- interface of the 'zlib' general purpose compression library +</font>00002 <font class="comment"> version 1.1.3, July 9th, 1998 +</font>00003 <font class="comment"> +</font>00004 <font class="comment"> Copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler +</font>00005 <font class="comment"> +</font>00006 <font class="comment"> This software is provided 'as-is', without any express or implied +</font>00007 <font class="comment"> warranty. In no event will the authors be held liable for any damages +</font>00008 <font class="comment"> arising from the use of this software. +</font>00009 <font class="comment"> +</font>00010 <font class="comment"> Permission is granted to anyone to use this software for any purpose, +</font>00011 <font class="comment"> including commercial applications, and to alter it and redistribute it +</font>00012 <font class="comment"> freely, subject to the following restrictions: +</font>00013 <font class="comment"> +</font>00014 <font class="comment"> 1. The origin of this software must not be misrepresented; you must not +</font>00015 <font class="comment"> claim that you wrote the original software. If you use this software +</font>00016 <font class="comment"> in a product, an acknowledgment in the product documentation would be +</font>00017 <font class="comment"> appreciated but is not required. +</font>00018 <font class="comment"> 2. Altered source versions must be plainly marked as such, and must not be +</font>00019 <font class="comment"> misrepresented as being the original software. +</font>00020 <font class="comment"> 3. This notice may not be removed or altered from any source distribution. +</font>00021 <font class="comment"> +</font>00022 <font class="comment"> Jean-loup Gailly Mark Adler +</font>00023 <font class="comment"> jloup@gzip.org madler@alumni.caltech.edu +</font>00024 <font class="comment"> +</font>00025 <font class="comment"> +</font>00026 <font class="comment"> The data format used by the zlib library is described by RFCs (Request for +</font>00027 <font class="comment"> Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt +</font>00028 <font class="comment"> (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format). +</font>00029 <font class="comment">*/</font> +00030 +00031 <font class="preprocessor">#ifndef _ZLIB_H +</font>00032 <font class="preprocessor"></font><font class="preprocessor">#define _ZLIB_H +</font>00033 <font class="preprocessor"></font> +00034 <font class="preprocessor">#include "zconf.h"</font> +00035 +00036 <font class="preprocessor">#ifdef __cplusplus +</font>00037 <font class="preprocessor"></font><font class="keyword">extern</font> <font class="stringliteral">"C"</font> { +00038 <font class="preprocessor">#endif +</font>00039 <font class="preprocessor"></font> +00040 <font class="preprocessor">#define ZLIB_VERSION "1.1.3" +</font>00041 <font class="preprocessor"></font> +00042 <font class="comment">/* +</font>00043 <font class="comment"> The 'zlib' compression library provides in-memory compression and +</font>00044 <font class="comment"> decompression functions, including integrity checks of the uncompressed +</font>00045 <font class="comment"> data. This version of the library supports only one compression method +</font>00046 <font class="comment"> (deflation) but other algorithms will be added later and will have the same +</font>00047 <font class="comment"> stream interface. +</font>00048 <font class="comment"> +</font>00049 <font class="comment"> Compression can be done in a single step if the buffers are large +</font>00050 <font class="comment"> enough (for example if an input file is mmap'ed), or can be done by +</font>00051 <font class="comment"> repeated calls of the compression function. In the latter case, the +</font>00052 <font class="comment"> application must provide more input and/or consume the output +</font>00053 <font class="comment"> (providing more output space) before each call. +</font>00054 <font class="comment"> +</font>00055 <font class="comment"> The library also supports reading and writing files in gzip (.gz) format +</font>00056 <font class="comment"> with an interface similar to that of stdio. +</font>00057 <font class="comment"> +</font>00058 <font class="comment"> The library does not install any signal handler. The decoder checks +</font>00059 <font class="comment"> the consistency of the compressed data, so the library should never +</font>00060 <font class="comment"> crash even in case of corrupted input. +</font>00061 <font class="comment">*/</font> +00062 +00063 <font class="keyword">typedef</font> voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); +00064 <font class="keyword">typedef</font> void (*free_func) OF((voidpf opaque, voidpf address)); +00065 +00066 <font class="keyword">struct </font>internal_state; +00067 +00068 <font class="keyword">typedef</font> <font class="keyword">struct </font>z_stream_s { +00069 Bytef *next_in; <font class="comment">/* next input byte */</font> +00070 uInt avail_in; <font class="comment">/* number of bytes available at next_in */</font> +00071 uLong total_in; <font class="comment">/* total nb of input bytes read so far */</font> +00072 +00073 Bytef *next_out; <font class="comment">/* next output byte should be put there */</font> +00074 uInt avail_out; <font class="comment">/* remaining free space at next_out */</font> +00075 uLong total_out; <font class="comment">/* total nb of bytes output so far */</font> +00076 +00077 <font class="keywordtype">char</font> *msg; <font class="comment">/* last error message, NULL if no error */</font> +00078 <font class="keyword">struct </font>internal_state FAR *state; <font class="comment">/* not visible by applications */</font> +00079 +00080 alloc_func zalloc; <font class="comment">/* used to allocate the internal state */</font> +00081 free_func zfree; <font class="comment">/* used to free the internal state */</font> +00082 voidpf opaque; <font class="comment">/* private data object passed to zalloc and zfree */</font> +00083 +00084 <font class="keywordtype">int</font> data_type; <font class="comment">/* best guess about the data type: ascii or binary */</font> +00085 uLong adler; <font class="comment">/* adler32 value of the uncompressed data */</font> +00086 uLong reserved; <font class="comment">/* reserved for future use */</font> +00087 } z_stream; +00088 +00089 <font class="keyword">typedef</font> z_stream FAR *z_streamp; +00090 +00091 <font class="comment">/* +</font>00092 <font class="comment"> The application must update next_in and avail_in when avail_in has +</font>00093 <font class="comment"> dropped to zero. It must update next_out and avail_out when avail_out +</font>00094 <font class="comment"> has dropped to zero. The application must initialize zalloc, zfree and +</font>00095 <font class="comment"> opaque before calling the init function. All other fields are set by the +</font>00096 <font class="comment"> compression library and must not be updated by the application. +</font>00097 <font class="comment"> +</font>00098 <font class="comment"> The opaque value provided by the application will be passed as the first +</font>00099 <font class="comment"> parameter for calls of zalloc and zfree. This can be useful for custom +</font>00100 <font class="comment"> memory management. The compression library attaches no meaning to the +</font>00101 <font class="comment"> opaque value. +</font>00102 <font class="comment"> +</font>00103 <font class="comment"> zalloc must return Z_NULL if there is not enough memory for the object. +</font>00104 <font class="comment"> If zlib is used in a multi-threaded application, zalloc and zfree must be +</font>00105 <font class="comment"> thread safe. +</font>00106 <font class="comment"> +</font>00107 <font class="comment"> On 16-bit systems, the functions zalloc and zfree must be able to allocate +</font>00108 <font class="comment"> exactly 65536 bytes, but will not be required to allocate more than this +</font>00109 <font class="comment"> if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, +</font>00110 <font class="comment"> pointers returned by zalloc for objects of exactly 65536 bytes *must* +</font>00111 <font class="comment"> have their offset normalized to zero. The default allocation function +</font>00112 <font class="comment"> provided by this library ensures this (see zutil.c). To reduce memory +</font>00113 <font class="comment"> requirements and avoid any allocation of 64K objects, at the expense of +</font>00114 <font class="comment"> compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h). +</font>00115 <font class="comment"> +</font>00116 <font class="comment"> The fields total_in and total_out can be used for statistics or +</font>00117 <font class="comment"> progress reports. After compression, total_in holds the total size of +</font>00118 <font class="comment"> the uncompressed data and may be saved for use in the decompressor +</font>00119 <font class="comment"> (particularly if the decompressor wants to decompress everything in +</font>00120 <font class="comment"> a single step). +</font>00121 <font class="comment">*/</font> +00122 +00123 <font class="comment">/* constants */</font> +00124 +00125 <font class="preprocessor">#define Z_NO_FLUSH 0 +</font>00126 <font class="preprocessor"></font><font class="preprocessor">#define Z_PARTIAL_FLUSH 1 </font><font class="comment">/* will be removed, use Z_SYNC_FLUSH instead */</font> +00127 <font class="preprocessor">#define Z_SYNC_FLUSH 2 +</font>00128 <font class="preprocessor"></font><font class="preprocessor">#define Z_FULL_FLUSH 3 +</font>00129 <font class="preprocessor"></font><font class="preprocessor">#define Z_FINISH 4 +</font>00130 <font class="preprocessor"></font><font class="comment">/* Allowed flush values; see deflate() below for details */</font> +00131 +00132 <font class="preprocessor">#define Z_OK 0 +</font>00133 <font class="preprocessor"></font><font class="preprocessor">#define Z_STREAM_END 1 +</font>00134 <font class="preprocessor"></font><font class="preprocessor">#define Z_NEED_DICT 2 +</font>00135 <font class="preprocessor"></font><font class="preprocessor">#define Z_ERRNO (-1) +</font>00136 <font class="preprocessor"></font><font class="preprocessor">#define Z_STREAM_ERROR (-2) +</font>00137 <font class="preprocessor"></font><font class="preprocessor">#define Z_DATA_ERROR (-3) +</font>00138 <font class="preprocessor"></font><font class="preprocessor">#define Z_MEM_ERROR (-4) +</font>00139 <font class="preprocessor"></font><font class="preprocessor">#define Z_BUF_ERROR (-5) +</font>00140 <font class="preprocessor"></font><font class="preprocessor">#define Z_VERSION_ERROR (-6) +</font>00141 <font class="preprocessor"></font><font class="comment">/* Return codes for the compression/decompression functions. Negative +</font>00142 <font class="comment"> * values are errors, positive values are used for special but normal events. +</font>00143 <font class="comment"> */</font> +00144 +00145 <font class="preprocessor">#define Z_NO_COMPRESSION 0 +</font>00146 <font class="preprocessor"></font><font class="preprocessor">#define Z_BEST_SPEED 1 +</font>00147 <font class="preprocessor"></font><font class="preprocessor">#define Z_BEST_COMPRESSION 9 +</font>00148 <font class="preprocessor"></font><font class="preprocessor">#define Z_DEFAULT_COMPRESSION (-1) +</font>00149 <font class="preprocessor"></font><font class="comment">/* compression levels */</font> +00150 +00151 <font class="preprocessor">#define Z_FILTERED 1 +</font>00152 <font class="preprocessor"></font><font class="preprocessor">#define Z_HUFFMAN_ONLY 2 +</font>00153 <font class="preprocessor"></font><font class="preprocessor">#define Z_DEFAULT_STRATEGY 0 +</font>00154 <font class="preprocessor"></font><font class="comment">/* compression strategy; see deflateInit2() below for details */</font> +00155 +00156 <font class="preprocessor">#define Z_BINARY 0 +</font>00157 <font class="preprocessor"></font><font class="preprocessor">#define Z_ASCII 1 +</font>00158 <font class="preprocessor"></font><font class="preprocessor">#define Z_UNKNOWN 2 +</font>00159 <font class="preprocessor"></font><font class="comment">/* Possible values of the data_type field */</font> +00160 +00161 <font class="preprocessor">#define Z_DEFLATED 8 +</font>00162 <font class="preprocessor"></font><font class="comment">/* The deflate compression method (the only one supported in this version) */</font> +00163 +00164 <font class="preprocessor">#define Z_NULL 0 </font><font class="comment">/* for initializing zalloc, zfree, opaque */</font> +00165 +00166 <font class="preprocessor">#define zlib_version zlibVersion() +</font>00167 <font class="preprocessor"></font><font class="comment">/* for compatibility with versions < 1.0.2 */</font> +00168 +00169 <font class="comment">/* basic functions */</font> +00170 +00171 ZEXTERN <font class="keyword">const</font> <font class="keywordtype">char</font> * ZEXPORT zlibVersion OF((<font class="keywordtype">void</font>)); +00172 <font class="comment">/* The application can compare zlibVersion and ZLIB_VERSION for consistency. +</font>00173 <font class="comment"> If the first character differs, the library code actually used is +</font>00174 <font class="comment"> not compatible with the zlib.h header file used by the application. +</font>00175 <font class="comment"> This check is automatically made by deflateInit and inflateInit. +</font>00176 <font class="comment"> */</font> +00177 +00178 <font class="comment">/* +</font>00179 <font class="comment">ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level)); +</font>00180 <font class="comment"> +</font>00181 <font class="comment"> Initializes the internal stream state for compression. The fields +</font>00182 <font class="comment"> zalloc, zfree and opaque must be initialized before by the caller. +</font>00183 <font class="comment"> If zalloc and zfree are set to Z_NULL, deflateInit updates them to +</font>00184 <font class="comment"> use default allocation functions. +</font>00185 <font class="comment"> +</font>00186 <font class="comment"> The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9: +</font>00187 <font class="comment"> 1 gives best speed, 9 gives best compression, 0 gives no compression at +</font>00188 <font class="comment"> all (the input data is simply copied a block at a time). +</font>00189 <font class="comment"> Z_DEFAULT_COMPRESSION requests a default compromise between speed and +</font>00190 <font class="comment"> compression (currently equivalent to level 6). +</font>00191 <font class="comment"> +</font>00192 <font class="comment"> deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not +</font>00193 <font class="comment"> enough memory, Z_STREAM_ERROR if level is not a valid compression level, +</font>00194 <font class="comment"> Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible +</font>00195 <font class="comment"> with the version assumed by the caller (ZLIB_VERSION). +</font>00196 <font class="comment"> msg is set to null if there is no error message. deflateInit does not +</font>00197 <font class="comment"> perform any compression: this will be done by deflate(). +</font>00198 <font class="comment">*/</font> +00199 +00200 +00201 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflate OF((z_streamp strm, <font class="keywordtype">int</font> flush)); +00202 <font class="comment">/* +</font>00203 <font class="comment"> deflate compresses as much data as possible, and stops when the input +</font>00204 <font class="comment"> buffer becomes empty or the output buffer becomes full. It may introduce some +</font>00205 <font class="comment"> output latency (reading input without producing any output) except when +</font>00206 <font class="comment"> forced to flush. +</font>00207 <font class="comment"> +</font>00208 <font class="comment"> The detailed semantics are as follows. deflate performs one or both of the +</font>00209 <font class="comment"> following actions: +</font>00210 <font class="comment"> +</font>00211 <font class="comment"> - Compress more input starting at next_in and update next_in and avail_in +</font>00212 <font class="comment"> accordingly. If not all input can be processed (because there is not +</font>00213 <font class="comment"> enough room in the output buffer), next_in and avail_in are updated and +</font>00214 <font class="comment"> processing will resume at this point for the next call of deflate(). +</font>00215 <font class="comment"> +</font>00216 <font class="comment"> - Provide more output starting at next_out and update next_out and avail_out +</font>00217 <font class="comment"> accordingly. This action is forced if the parameter flush is non zero. +</font>00218 <font class="comment"> Forcing flush frequently degrades the compression ratio, so this parameter +</font>00219 <font class="comment"> should be set only when necessary (in interactive applications). +</font>00220 <font class="comment"> Some output may be provided even if flush is not set. +</font>00221 <font class="comment"> +</font>00222 <font class="comment"> Before the call of deflate(), the application should ensure that at least +</font>00223 <font class="comment"> one of the actions is possible, by providing more input and/or consuming +</font>00224 <font class="comment"> more output, and updating avail_in or avail_out accordingly; avail_out +</font>00225 <font class="comment"> should never be zero before the call. The application can consume the +</font>00226 <font class="comment"> compressed output when it wants, for example when the output buffer is full +</font>00227 <font class="comment"> (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK +</font>00228 <font class="comment"> and with zero avail_out, it must be called again after making room in the +</font>00229 <font class="comment"> output buffer because there might be more output pending. +</font>00230 <font class="comment"> +</font>00231 <font class="comment"> If the parameter flush is set to Z_SYNC_FLUSH, all pending output is +</font>00232 <font class="comment"> flushed to the output buffer and the output is aligned on a byte boundary, so +</font>00233 <font class="comment"> that the decompressor can get all input data available so far. (In particular +</font>00234 <font class="comment"> avail_in is zero after the call if enough output space has been provided +</font>00235 <font class="comment"> before the call.) Flushing may degrade compression for some compression +</font>00236 <font class="comment"> algorithms and so it should be used only when necessary. +</font>00237 <font class="comment"> +</font>00238 <font class="comment"> If flush is set to Z_FULL_FLUSH, all output is flushed as with +</font>00239 <font class="comment"> Z_SYNC_FLUSH, and the compression state is reset so that decompression can +</font>00240 <font class="comment"> restart from this point if previous compressed data has been damaged or if +</font>00241 <font class="comment"> random access is desired. Using Z_FULL_FLUSH too often can seriously degrade +</font>00242 <font class="comment"> the compression. +</font>00243 <font class="comment"> +</font>00244 <font class="comment"> If deflate returns with avail_out == 0, this function must be called again +</font>00245 <font class="comment"> with the same value of the flush parameter and more output space (updated +</font>00246 <font class="comment"> avail_out), until the flush is complete (deflate returns with non-zero +</font>00247 <font class="comment"> avail_out). +</font>00248 <font class="comment"> +</font>00249 <font class="comment"> If the parameter flush is set to Z_FINISH, pending input is processed, +</font>00250 <font class="comment"> pending output is flushed and deflate returns with Z_STREAM_END if there +</font>00251 <font class="comment"> was enough output space; if deflate returns with Z_OK, this function must be +</font>00252 <font class="comment"> called again with Z_FINISH and more output space (updated avail_out) but no +</font>00253 <font class="comment"> more input data, until it returns with Z_STREAM_END or an error. After +</font>00254 <font class="comment"> deflate has returned Z_STREAM_END, the only possible operations on the +</font>00255 <font class="comment"> stream are deflateReset or deflateEnd. +</font>00256 <font class="comment"> +</font>00257 <font class="comment"> Z_FINISH can be used immediately after deflateInit if all the compression +</font>00258 <font class="comment"> is to be done in a single step. In this case, avail_out must be at least +</font>00259 <font class="comment"> 0.1% larger than avail_in plus 12 bytes. If deflate does not return +</font>00260 <font class="comment"> Z_STREAM_END, then it must be called again as described above. +</font>00261 <font class="comment"> +</font>00262 <font class="comment"> deflate() sets strm->adler to the adler32 checksum of all input read +</font>00263 <font class="comment"> so far (that is, total_in bytes). +</font>00264 <font class="comment"> +</font>00265 <font class="comment"> deflate() may update data_type if it can make a good guess about +</font>00266 <font class="comment"> the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered +</font>00267 <font class="comment"> binary. This field is only for information purposes and does not affect +</font>00268 <font class="comment"> the compression algorithm in any manner. +</font>00269 <font class="comment"> +</font>00270 <font class="comment"> deflate() returns Z_OK if some progress has been made (more input +</font>00271 <font class="comment"> processed or more output produced), Z_STREAM_END if all input has been +</font>00272 <font class="comment"> consumed and all output has been produced (only when flush is set to +</font>00273 <font class="comment"> Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example +</font>00274 <font class="comment"> if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible +</font>00275 <font class="comment"> (for example avail_in or avail_out was zero). +</font>00276 <font class="comment">*/</font> +00277 +00278 +00279 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateEnd OF((z_streamp strm)); +00280 <font class="comment">/* +</font>00281 <font class="comment"> All dynamically allocated data structures for this stream are freed. +</font>00282 <font class="comment"> This function discards any unprocessed input and does not flush any +</font>00283 <font class="comment"> pending output. +</font>00284 <font class="comment"> +</font>00285 <font class="comment"> deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the +</font>00286 <font class="comment"> stream state was inconsistent, Z_DATA_ERROR if the stream was freed +</font>00287 <font class="comment"> prematurely (some input or output was discarded). In the error case, +</font>00288 <font class="comment"> msg may be set but then points to a static string (which must not be +</font>00289 <font class="comment"> deallocated). +</font>00290 <font class="comment">*/</font> +00291 +00292 +00293 <font class="comment">/* +</font>00294 <font class="comment">ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm)); +</font>00295 <font class="comment"> +</font>00296 <font class="comment"> Initializes the internal stream state for decompression. The fields +</font>00297 <font class="comment"> next_in, avail_in, zalloc, zfree and opaque must be initialized before by +</font>00298 <font class="comment"> the caller. If next_in is not Z_NULL and avail_in is large enough (the exact +</font>00299 <font class="comment"> value depends on the compression method), inflateInit determines the +</font>00300 <font class="comment"> compression method from the zlib header and allocates all data structures +</font>00301 <font class="comment"> accordingly; otherwise the allocation will be deferred to the first call of +</font>00302 <font class="comment"> inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to +</font>00303 <font class="comment"> use default allocation functions. +</font>00304 <font class="comment"> +</font>00305 <font class="comment"> inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough +</font>00306 <font class="comment"> memory, Z_VERSION_ERROR if the zlib library version is incompatible with the +</font>00307 <font class="comment"> version assumed by the caller. msg is set to null if there is no error +</font>00308 <font class="comment"> message. inflateInit does not perform any decompression apart from reading +</font>00309 <font class="comment"> the zlib header if present: this will be done by inflate(). (So next_in and +</font>00310 <font class="comment"> avail_in may be modified, but next_out and avail_out are unchanged.) +</font>00311 <font class="comment">*/</font> +00312 +00313 +00314 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflate OF((z_streamp strm, <font class="keywordtype">int</font> flush)); +00315 <font class="comment">/* +</font>00316 <font class="comment"> inflate decompresses as much data as possible, and stops when the input +</font>00317 <font class="comment"> buffer becomes empty or the output buffer becomes full. It may some +</font>00318 <font class="comment"> introduce some output latency (reading input without producing any output) +</font>00319 <font class="comment"> except when forced to flush. +</font>00320 <font class="comment"> +</font>00321 <font class="comment"> The detailed semantics are as follows. inflate performs one or both of the +</font>00322 <font class="comment"> following actions: +</font>00323 <font class="comment"> +</font>00324 <font class="comment"> - Decompress more input starting at next_in and update next_in and avail_in +</font>00325 <font class="comment"> accordingly. If not all input can be processed (because there is not +</font>00326 <font class="comment"> enough room in the output buffer), next_in is updated and processing +</font>00327 <font class="comment"> will resume at this point for the next call of inflate(). +</font>00328 <font class="comment"> +</font>00329 <font class="comment"> - Provide more output starting at next_out and update next_out and avail_out +</font>00330 <font class="comment"> accordingly. inflate() provides as much output as possible, until there +</font>00331 <font class="comment"> is no more input data or no more space in the output buffer (see below +</font>00332 <font class="comment"> about the flush parameter). +</font>00333 <font class="comment"> +</font>00334 <font class="comment"> Before the call of inflate(), the application should ensure that at least +</font>00335 <font class="comment"> one of the actions is possible, by providing more input and/or consuming +</font>00336 <font class="comment"> more output, and updating the next_* and avail_* values accordingly. +</font>00337 <font class="comment"> The application can consume the uncompressed output when it wants, for +</font>00338 <font class="comment"> example when the output buffer is full (avail_out == 0), or after each +</font>00339 <font class="comment"> call of inflate(). If inflate returns Z_OK and with zero avail_out, it +</font>00340 <font class="comment"> must be called again after making room in the output buffer because there +</font>00341 <font class="comment"> might be more output pending. +</font>00342 <font class="comment"> +</font>00343 <font class="comment"> If the parameter flush is set to Z_SYNC_FLUSH, inflate flushes as much +</font>00344 <font class="comment"> output as possible to the output buffer. The flushing behavior of inflate is +</font>00345 <font class="comment"> not specified for values of the flush parameter other than Z_SYNC_FLUSH +</font>00346 <font class="comment"> and Z_FINISH, but the current implementation actually flushes as much output +</font>00347 <font class="comment"> as possible anyway. +</font>00348 <font class="comment"> +</font>00349 <font class="comment"> inflate() should normally be called until it returns Z_STREAM_END or an +</font>00350 <font class="comment"> error. However if all decompression is to be performed in a single step +</font>00351 <font class="comment"> (a single call of inflate), the parameter flush should be set to +</font>00352 <font class="comment"> Z_FINISH. In this case all pending input is processed and all pending +</font>00353 <font class="comment"> output is flushed; avail_out must be large enough to hold all the +</font>00354 <font class="comment"> uncompressed data. (The size of the uncompressed data may have been saved +</font>00355 <font class="comment"> by the compressor for this purpose.) The next operation on this stream must +</font>00356 <font class="comment"> be inflateEnd to deallocate the decompression state. The use of Z_FINISH +</font>00357 <font class="comment"> is never required, but can be used to inform inflate that a faster routine +</font>00358 <font class="comment"> may be used for the single inflate() call. +</font>00359 <font class="comment"> +</font>00360 <font class="comment"> If a preset dictionary is needed at this point (see inflateSetDictionary +</font>00361 <font class="comment"> below), inflate sets strm-adler to the adler32 checksum of the +</font>00362 <font class="comment"> dictionary chosen by the compressor and returns Z_NEED_DICT; otherwise +</font>00363 <font class="comment"> it sets strm->adler to the adler32 checksum of all output produced +</font>00364 <font class="comment"> so far (that is, total_out bytes) and returns Z_OK, Z_STREAM_END or +</font>00365 <font class="comment"> an error code as described below. At the end of the stream, inflate() +</font>00366 <font class="comment"> checks that its computed adler32 checksum is equal to that saved by the +</font>00367 <font class="comment"> compressor and returns Z_STREAM_END only if the checksum is correct. +</font>00368 <font class="comment"> +</font>00369 <font class="comment"> inflate() returns Z_OK if some progress has been made (more input processed +</font>00370 <font class="comment"> or more output produced), Z_STREAM_END if the end of the compressed data has +</font>00371 <font class="comment"> been reached and all uncompressed output has been produced, Z_NEED_DICT if a +</font>00372 <font class="comment"> preset dictionary is needed at this point, Z_DATA_ERROR if the input data was +</font>00373 <font class="comment"> corrupted (input stream not conforming to the zlib format or incorrect +</font>00374 <font class="comment"> adler32 checksum), Z_STREAM_ERROR if the stream structure was inconsistent +</font>00375 <font class="comment"> (for example if next_in or next_out was NULL), Z_MEM_ERROR if there was not +</font>00376 <font class="comment"> enough memory, Z_BUF_ERROR if no progress is possible or if there was not +</font>00377 <font class="comment"> enough room in the output buffer when Z_FINISH is used. In the Z_DATA_ERROR +</font>00378 <font class="comment"> case, the application may then call inflateSync to look for a good +</font>00379 <font class="comment"> compression block. +</font>00380 <font class="comment">*/</font> +00381 +00382 +00383 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateEnd OF((z_streamp strm)); +00384 <font class="comment">/* +</font>00385 <font class="comment"> All dynamically allocated data structures for this stream are freed. +</font>00386 <font class="comment"> This function discards any unprocessed input and does not flush any +</font>00387 <font class="comment"> pending output. +</font>00388 <font class="comment"> +</font>00389 <font class="comment"> inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state +</font>00390 <font class="comment"> was inconsistent. In the error case, msg may be set but then points to a +</font>00391 <font class="comment"> static string (which must not be deallocated). +</font>00392 <font class="comment">*/</font> +00393 +00394 <font class="comment">/* Advanced functions */</font> +00395 +00396 <font class="comment">/* +</font>00397 <font class="comment"> The following functions are needed only in some special applications. +</font>00398 <font class="comment">*/</font> +00399 +00400 <font class="comment">/* +</font>00401 <font class="comment">ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm, +</font>00402 <font class="comment"> int level, +</font>00403 <font class="comment"> int method, +</font>00404 <font class="comment"> int windowBits, +</font>00405 <font class="comment"> int memLevel, +</font>00406 <font class="comment"> int strategy)); +</font>00407 <font class="comment"> +</font>00408 <font class="comment"> This is another version of deflateInit with more compression options. The +</font>00409 <font class="comment"> fields next_in, zalloc, zfree and opaque must be initialized before by +</font>00410 <font class="comment"> the caller. +</font>00411 <font class="comment"> +</font>00412 <font class="comment"> The method parameter is the compression method. It must be Z_DEFLATED in +</font>00413 <font class="comment"> this version of the library. +</font>00414 <font class="comment"> +</font>00415 <font class="comment"> The windowBits parameter is the base two logarithm of the window size +</font>00416 <font class="comment"> (the size of the history buffer). It should be in the range 8..15 for this +</font>00417 <font class="comment"> version of the library. Larger values of this parameter result in better +</font>00418 <font class="comment"> compression at the expense of memory usage. The default value is 15 if +</font>00419 <font class="comment"> deflateInit is used instead. +</font>00420 <font class="comment"> +</font>00421 <font class="comment"> The memLevel parameter specifies how much memory should be allocated +</font>00422 <font class="comment"> for the internal compression state. memLevel=1 uses minimum memory but +</font>00423 <font class="comment"> is slow and reduces compression ratio; memLevel=9 uses maximum memory +</font>00424 <font class="comment"> for optimal speed. The default value is 8. See zconf.h for total memory +</font>00425 <font class="comment"> usage as a function of windowBits and memLevel. +</font>00426 <font class="comment"> +</font>00427 <font class="comment"> The strategy parameter is used to tune the compression algorithm. Use the +</font>00428 <font class="comment"> value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a +</font>00429 <font class="comment"> filter (or predictor), or Z_HUFFMAN_ONLY to force Huffman encoding only (no +</font>00430 <font class="comment"> string match). Filtered data consists mostly of small values with a +</font>00431 <font class="comment"> somewhat random distribution. In this case, the compression algorithm is +</font>00432 <font class="comment"> tuned to compress them better. The effect of Z_FILTERED is to force more +</font>00433 <font class="comment"> Huffman coding and less string matching; it is somewhat intermediate +</font>00434 <font class="comment"> between Z_DEFAULT and Z_HUFFMAN_ONLY. The strategy parameter only affects +</font>00435 <font class="comment"> the compression ratio but not the correctness of the compressed output even +</font>00436 <font class="comment"> if it is not set appropriately. +</font>00437 <font class="comment"> +</font>00438 <font class="comment"> deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough +</font>00439 <font class="comment"> memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid +</font>00440 <font class="comment"> method). msg is set to null if there is no error message. deflateInit2 does +</font>00441 <font class="comment"> not perform any compression: this will be done by deflate(). +</font>00442 <font class="comment">*/</font> +00443 +00444 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateSetDictionary OF((z_streamp strm, +00445 <font class="keyword">const</font> Bytef *dictionary, +00446 uInt dictLength)); +00447 <font class="comment">/* +</font>00448 <font class="comment"> Initializes the compression dictionary from the given byte sequence +</font>00449 <font class="comment"> without producing any compressed output. This function must be called +</font>00450 <font class="comment"> immediately after deflateInit, deflateInit2 or deflateReset, before any +</font>00451 <font class="comment"> call of deflate. The compressor and decompressor must use exactly the same +</font>00452 <font class="comment"> dictionary (see inflateSetDictionary). +</font>00453 <font class="comment"> +</font>00454 <font class="comment"> The dictionary should consist of strings (byte sequences) that are likely +</font>00455 <font class="comment"> to be encountered later in the data to be compressed, with the most commonly +</font>00456 <font class="comment"> used strings preferably put towards the end of the dictionary. Using a +</font>00457 <font class="comment"> dictionary is most useful when the data to be compressed is short and can be +</font>00458 <font class="comment"> predicted with good accuracy; the data can then be compressed better than +</font>00459 <font class="comment"> with the default empty dictionary. +</font>00460 <font class="comment"> +</font>00461 <font class="comment"> Depending on the size of the compression data structures selected by +</font>00462 <font class="comment"> deflateInit or deflateInit2, a part of the dictionary may in effect be +</font>00463 <font class="comment"> discarded, for example if the dictionary is larger than the window size in +</font>00464 <font class="comment"> deflate or deflate2. Thus the strings most likely to be useful should be +</font>00465 <font class="comment"> put at the end of the dictionary, not at the front. +</font>00466 <font class="comment"> +</font>00467 <font class="comment"> Upon return of this function, strm->adler is set to the Adler32 value +</font>00468 <font class="comment"> of the dictionary; the decompressor may later use this value to determine +</font>00469 <font class="comment"> which dictionary has been used by the compressor. (The Adler32 value +</font>00470 <font class="comment"> applies to the whole dictionary even if only a subset of the dictionary is +</font>00471 <font class="comment"> actually used by the compressor.) +</font>00472 <font class="comment"> +</font>00473 <font class="comment"> deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a +</font>00474 <font class="comment"> parameter is invalid (such as NULL dictionary) or the stream state is +</font>00475 <font class="comment"> inconsistent (for example if deflate has already been called for this stream +</font>00476 <font class="comment"> or if the compression method is bsort). deflateSetDictionary does not +</font>00477 <font class="comment"> perform any compression: this will be done by deflate(). +</font>00478 <font class="comment">*/</font> +00479 +00480 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateCopy OF((z_streamp dest, +00481 z_streamp source)); +00482 <font class="comment">/* +</font>00483 <font class="comment"> Sets the destination stream as a complete copy of the source stream. +</font>00484 <font class="comment"> +</font>00485 <font class="comment"> This function can be useful when several compression strategies will be +</font>00486 <font class="comment"> tried, for example when there are several ways of pre-processing the input +</font>00487 <font class="comment"> data with a filter. The streams that will be discarded should then be freed +</font>00488 <font class="comment"> by calling deflateEnd. Note that deflateCopy duplicates the internal +</font>00489 <font class="comment"> compression state which can be quite large, so this strategy is slow and +</font>00490 <font class="comment"> can consume lots of memory. +</font>00491 <font class="comment"> +</font>00492 <font class="comment"> deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not +</font>00493 <font class="comment"> enough memory, Z_STREAM_ERROR if the source stream state was inconsistent +</font>00494 <font class="comment"> (such as zalloc being NULL). msg is left unchanged in both source and +</font>00495 <font class="comment"> destination. +</font>00496 <font class="comment">*/</font> +00497 +00498 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateReset OF((z_streamp strm)); +00499 <font class="comment">/* +</font>00500 <font class="comment"> This function is equivalent to deflateEnd followed by deflateInit, +</font>00501 <font class="comment"> but does not free and reallocate all the internal compression state. +</font>00502 <font class="comment"> The stream will keep the same compression level and any other attributes +</font>00503 <font class="comment"> that may have been set by deflateInit2. +</font>00504 <font class="comment"> +</font>00505 <font class="comment"> deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source +</font>00506 <font class="comment"> stream state was inconsistent (such as zalloc or state being NULL). +</font>00507 <font class="comment">*/</font> +00508 +00509 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateParams OF((z_streamp strm, +00510 <font class="keywordtype">int</font> level, +00511 <font class="keywordtype">int</font> strategy)); +00512 <font class="comment">/* +</font>00513 <font class="comment"> Dynamically update the compression level and compression strategy. The +</font>00514 <font class="comment"> interpretation of level and strategy is as in deflateInit2. This can be +</font>00515 <font class="comment"> used to switch between compression and straight copy of the input data, or +</font>00516 <font class="comment"> to switch to a different kind of input data requiring a different +</font>00517 <font class="comment"> strategy. If the compression level is changed, the input available so far +</font>00518 <font class="comment"> is compressed with the old level (and may be flushed); the new level will +</font>00519 <font class="comment"> take effect only at the next call of deflate(). +</font>00520 <font class="comment"> +</font>00521 <font class="comment"> Before the call of deflateParams, the stream state must be set as for +</font>00522 <font class="comment"> a call of deflate(), since the currently available input may have to +</font>00523 <font class="comment"> be compressed and flushed. In particular, strm->avail_out must be non-zero. +</font>00524 <font class="comment"> +</font>00525 <font class="comment"> deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source +</font>00526 <font class="comment"> stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR +</font>00527 <font class="comment"> if strm->avail_out was zero. +</font>00528 <font class="comment">*/</font> +00529 +00530 <font class="comment">/* +</font>00531 <font class="comment">ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm, +</font>00532 <font class="comment"> int windowBits)); +</font>00533 <font class="comment"> +</font>00534 <font class="comment"> This is another version of inflateInit with an extra parameter. The +</font>00535 <font class="comment"> fields next_in, avail_in, zalloc, zfree and opaque must be initialized +</font>00536 <font class="comment"> before by the caller. +</font>00537 <font class="comment"> +</font>00538 <font class="comment"> The windowBits parameter is the base two logarithm of the maximum window +</font>00539 <font class="comment"> size (the size of the history buffer). It should be in the range 8..15 for +</font>00540 <font class="comment"> this version of the library. The default value is 15 if inflateInit is used +</font>00541 <font class="comment"> instead. If a compressed stream with a larger window size is given as +</font>00542 <font class="comment"> input, inflate() will return with the error code Z_DATA_ERROR instead of +</font>00543 <font class="comment"> trying to allocate a larger window. +</font>00544 <font class="comment"> +</font>00545 <font class="comment"> inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough +</font>00546 <font class="comment"> memory, Z_STREAM_ERROR if a parameter is invalid (such as a negative +</font>00547 <font class="comment"> memLevel). msg is set to null if there is no error message. inflateInit2 +</font>00548 <font class="comment"> does not perform any decompression apart from reading the zlib header if +</font>00549 <font class="comment"> present: this will be done by inflate(). (So next_in and avail_in may be +</font>00550 <font class="comment"> modified, but next_out and avail_out are unchanged.) +</font>00551 <font class="comment">*/</font> +00552 +00553 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateSetDictionary OF((z_streamp strm, +00554 <font class="keyword">const</font> Bytef *dictionary, +00555 uInt dictLength)); +00556 <font class="comment">/* +</font>00557 <font class="comment"> Initializes the decompression dictionary from the given uncompressed byte +</font>00558 <font class="comment"> sequence. This function must be called immediately after a call of inflate +</font>00559 <font class="comment"> if this call returned Z_NEED_DICT. The dictionary chosen by the compressor +</font>00560 <font class="comment"> can be determined from the Adler32 value returned by this call of +</font>00561 <font class="comment"> inflate. The compressor and decompressor must use exactly the same +</font>00562 <font class="comment"> dictionary (see deflateSetDictionary). +</font>00563 <font class="comment"> +</font>00564 <font class="comment"> inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a +</font>00565 <font class="comment"> parameter is invalid (such as NULL dictionary) or the stream state is +</font>00566 <font class="comment"> inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the +</font>00567 <font class="comment"> expected one (incorrect Adler32 value). inflateSetDictionary does not +</font>00568 <font class="comment"> perform any decompression: this will be done by subsequent calls of +</font>00569 <font class="comment"> inflate(). +</font>00570 <font class="comment">*/</font> +00571 +00572 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateSync OF((z_streamp strm)); +00573 <font class="comment">/* +</font>00574 <font class="comment"> Skips invalid compressed data until a full flush point (see above the +</font>00575 <font class="comment"> description of deflate with Z_FULL_FLUSH) can be found, or until all +</font>00576 <font class="comment"> available input is skipped. No output is provided. +</font>00577 <font class="comment"> +</font>00578 <font class="comment"> inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR +</font>00579 <font class="comment"> if no more input was provided, Z_DATA_ERROR if no flush point has been found, +</font>00580 <font class="comment"> or Z_STREAM_ERROR if the stream structure was inconsistent. In the success +</font>00581 <font class="comment"> case, the application may save the current current value of total_in which +</font>00582 <font class="comment"> indicates where valid compressed data was found. In the error case, the +</font>00583 <font class="comment"> application may repeatedly call inflateSync, providing more input each time, +</font>00584 <font class="comment"> until success or end of the input data. +</font>00585 <font class="comment">*/</font> +00586 +00587 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateReset OF((z_streamp strm)); +00588 <font class="comment">/* +</font>00589 <font class="comment"> This function is equivalent to inflateEnd followed by inflateInit, +</font>00590 <font class="comment"> but does not free and reallocate all the internal decompression state. +</font>00591 <font class="comment"> The stream will keep attributes that may have been set by inflateInit2. +</font>00592 <font class="comment"> +</font>00593 <font class="comment"> inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source +</font>00594 <font class="comment"> stream state was inconsistent (such as zalloc or state being NULL). +</font>00595 <font class="comment">*/</font> +00596 +00597 +00598 <font class="comment">/* utility functions */</font> +00599 +00600 <font class="comment">/* +</font>00601 <font class="comment"> The following utility functions are implemented on top of the +</font>00602 <font class="comment"> basic stream-oriented functions. To simplify the interface, some +</font>00603 <font class="comment"> default options are assumed (compression level and memory usage, +</font>00604 <font class="comment"> standard memory allocation functions). The source code of these +</font>00605 <font class="comment"> utility functions can easily be modified if you need special options. +</font>00606 <font class="comment">*/</font> +00607 +00608 ZEXTERN <font class="keywordtype">int</font> ZEXPORT compress OF((Bytef *dest, uLongf *destLen, +00609 <font class="keyword">const</font> Bytef *source, uLong sourceLen)); +00610 <font class="comment">/* +</font>00611 <font class="comment"> Compresses the source buffer into the destination buffer. sourceLen is +</font>00612 <font class="comment"> the byte length of the source buffer. Upon entry, destLen is the total +</font>00613 <font class="comment"> size of the destination buffer, which must be at least 0.1% larger than +</font>00614 <font class="comment"> sourceLen plus 12 bytes. Upon exit, destLen is the actual size of the +</font>00615 <font class="comment"> compressed buffer. +</font>00616 <font class="comment"> This function can be used to compress a whole file at once if the +</font>00617 <font class="comment"> input file is mmap'ed. +</font>00618 <font class="comment"> compress returns Z_OK if success, Z_MEM_ERROR if there was not +</font>00619 <font class="comment"> enough memory, Z_BUF_ERROR if there was not enough room in the output +</font>00620 <font class="comment"> buffer. +</font>00621 <font class="comment">*/</font> +00622 +00623 ZEXTERN <font class="keywordtype">int</font> ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen, +00624 <font class="keyword">const</font> Bytef *source, uLong sourceLen, +00625 <font class="keywordtype">int</font> level)); +00626 <font class="comment">/* +</font>00627 <font class="comment"> Compresses the source buffer into the destination buffer. The level +</font>00628 <font class="comment"> parameter has the same meaning as in deflateInit. sourceLen is the byte +</font>00629 <font class="comment"> length of the source buffer. Upon entry, destLen is the total size of the +</font>00630 <font class="comment"> destination buffer, which must be at least 0.1% larger than sourceLen plus +</font>00631 <font class="comment"> 12 bytes. Upon exit, destLen is the actual size of the compressed buffer. +</font>00632 <font class="comment"> +</font>00633 <font class="comment"> compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough +</font>00634 <font class="comment"> memory, Z_BUF_ERROR if there was not enough room in the output buffer, +</font>00635 <font class="comment"> Z_STREAM_ERROR if the level parameter is invalid. +</font>00636 <font class="comment">*/</font> +00637 +00638 ZEXTERN <font class="keywordtype">int</font> ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen, +00639 <font class="keyword">const</font> Bytef *source, uLong sourceLen)); +00640 <font class="comment">/* +</font>00641 <font class="comment"> Decompresses the source buffer into the destination buffer. sourceLen is +</font>00642 <font class="comment"> the byte length of the source buffer. Upon entry, destLen is the total +</font>00643 <font class="comment"> size of the destination buffer, which must be large enough to hold the +</font>00644 <font class="comment"> entire uncompressed data. (The size of the uncompressed data must have +</font>00645 <font class="comment"> been saved previously by the compressor and transmitted to the decompressor +</font>00646 <font class="comment"> by some mechanism outside the scope of this compression library.) +</font>00647 <font class="comment"> Upon exit, destLen is the actual size of the compressed buffer. +</font>00648 <font class="comment"> This function can be used to decompress a whole file at once if the +</font>00649 <font class="comment"> input file is mmap'ed. +</font>00650 <font class="comment"> +</font>00651 <font class="comment"> uncompress returns Z_OK if success, Z_MEM_ERROR if there was not +</font>00652 <font class="comment"> enough memory, Z_BUF_ERROR if there was not enough room in the output +</font>00653 <font class="comment"> buffer, or Z_DATA_ERROR if the input data was corrupted. +</font>00654 <font class="comment">*/</font> +00655 +00656 +00657 <font class="keyword">typedef</font> voidp gzFile; +00658 +00659 ZEXTERN gzFile ZEXPORT gzopen OF((<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keyword">const</font> <font class="keywordtype">char</font> *mode)); +00660 <font class="comment">/* +</font>00661 <font class="comment"> Opens a gzip (.gz) file for reading or writing. The mode parameter +</font>00662 <font class="comment"> is as in fopen ("rb" or "wb") but can also include a compression level +</font>00663 <font class="comment"> ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for +</font>00664 <font class="comment"> Huffman only compression as in "wb1h". (See the description +</font>00665 <font class="comment"> of deflateInit2 for more information about the strategy parameter.) +</font>00666 <font class="comment"> +</font>00667 <font class="comment"> gzopen can be used to read a file which is not in gzip format; in this +</font>00668 <font class="comment"> case gzread will directly read from the file without decompression. +</font>00669 <font class="comment"> +</font>00670 <font class="comment"> gzopen returns NULL if the file could not be opened or if there was +</font>00671 <font class="comment"> insufficient memory to allocate the (de)compression state; errno +</font>00672 <font class="comment"> can be checked to distinguish the two cases (if errno is zero, the +</font>00673 <font class="comment"> zlib error is Z_MEM_ERROR). */</font> +00674 +00675 ZEXTERN gzFile ZEXPORT gzdopen OF((<font class="keywordtype">int</font> fd, <font class="keyword">const</font> <font class="keywordtype">char</font> *mode)); +00676 <font class="comment">/* +</font>00677 <font class="comment"> gzdopen() associates a gzFile with the file descriptor fd. File +</font>00678 <font class="comment"> descriptors are obtained from calls like open, dup, creat, pipe or +</font>00679 <font class="comment"> fileno (in the file has been previously opened with fopen). +</font>00680 <font class="comment"> The mode parameter is as in gzopen. +</font>00681 <font class="comment"> The next call of gzclose on the returned gzFile will also close the +</font>00682 <font class="comment"> file descriptor fd, just like fclose(fdopen(fd), mode) closes the file +</font>00683 <font class="comment"> descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode). +</font>00684 <font class="comment"> gzdopen returns NULL if there was insufficient memory to allocate +</font>00685 <font class="comment"> the (de)compression state. +</font>00686 <font class="comment">*/</font> +00687 +00688 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzsetparams OF((gzFile file, <font class="keywordtype">int</font> level, <font class="keywordtype">int</font> strategy)); +00689 <font class="comment">/* +</font>00690 <font class="comment"> Dynamically update the compression level or strategy. See the description +</font>00691 <font class="comment"> of deflateInit2 for the meaning of these parameters. +</font>00692 <font class="comment"> gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not +</font>00693 <font class="comment"> opened for writing. +</font>00694 <font class="comment">*/</font> +00695 +00696 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzread OF((gzFile file, voidp buf, <font class="keywordtype">unsigned</font> len)); +00697 <font class="comment">/* +</font>00698 <font class="comment"> Reads the given number of uncompressed bytes from the compressed file. +</font>00699 <font class="comment"> If the input file was not in gzip format, gzread copies the given number +</font>00700 <font class="comment"> of bytes into the buffer. +</font>00701 <font class="comment"> gzread returns the number of uncompressed bytes actually read (0 for +</font>00702 <font class="comment"> end of file, -1 for error). */</font> +00703 +00704 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzwrite OF((gzFile file, +00705 <font class="keyword">const</font> voidp buf, <font class="keywordtype">unsigned</font> len)); +00706 <font class="comment">/* +</font>00707 <font class="comment"> Writes the given number of uncompressed bytes into the compressed file. +</font>00708 <font class="comment"> gzwrite returns the number of uncompressed bytes actually written +</font>00709 <font class="comment"> (0 in case of error). +</font>00710 <font class="comment">*/</font> +00711 +00712 ZEXTERN <font class="keywordtype">int</font> ZEXPORTVA gzprintf OF((gzFile file, <font class="keyword">const</font> <font class="keywordtype">char</font> *format, ...)); +00713 <font class="comment">/* +</font>00714 <font class="comment"> Converts, formats, and writes the args to the compressed file under +</font>00715 <font class="comment"> control of the format string, as in fprintf. gzprintf returns the number of +</font>00716 <font class="comment"> uncompressed bytes actually written (0 in case of error). +</font>00717 <font class="comment">*/</font> +00718 +00719 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzputs OF((gzFile file, <font class="keyword">const</font> <font class="keywordtype">char</font> *s)); +00720 <font class="comment">/* +</font>00721 <font class="comment"> Writes the given null-terminated string to the compressed file, excluding +</font>00722 <font class="comment"> the terminating null character. +</font>00723 <font class="comment"> gzputs returns the number of characters written, or -1 in case of error. +</font>00724 <font class="comment">*/</font> +00725 +00726 ZEXTERN <font class="keywordtype">char</font> * ZEXPORT gzgets OF((gzFile file, <font class="keywordtype">char</font> *buf, <font class="keywordtype">int</font> len)); +00727 <font class="comment">/* +</font>00728 <font class="comment"> Reads bytes from the compressed file until len-1 characters are read, or +</font>00729 <font class="comment"> a newline character is read and transferred to buf, or an end-of-file +</font>00730 <font class="comment"> condition is encountered. The string is then terminated with a null +</font>00731 <font class="comment"> character. +</font>00732 <font class="comment"> gzgets returns buf, or Z_NULL in case of error. +</font>00733 <font class="comment">*/</font> +00734 +00735 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzputc OF((gzFile file, <font class="keywordtype">int</font> c)); +00736 <font class="comment">/* +</font>00737 <font class="comment"> Writes c, converted to an unsigned char, into the compressed file. +</font>00738 <font class="comment"> gzputc returns the value that was written, or -1 in case of error. +</font>00739 <font class="comment">*/</font> +00740 +00741 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzgetc OF((gzFile file)); +00742 <font class="comment">/* +</font>00743 <font class="comment"> Reads one byte from the compressed file. gzgetc returns this byte +</font>00744 <font class="comment"> or -1 in case of end of file or error. +</font>00745 <font class="comment">*/</font> +00746 +00747 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzflush OF((gzFile file, <font class="keywordtype">int</font> flush)); +00748 <font class="comment">/* +</font>00749 <font class="comment"> Flushes all pending output into the compressed file. The parameter +</font>00750 <font class="comment"> flush is as in the deflate() function. The return value is the zlib +</font>00751 <font class="comment"> error number (see function gzerror below). gzflush returns Z_OK if +</font>00752 <font class="comment"> the flush parameter is Z_FINISH and all output could be flushed. +</font>00753 <font class="comment"> gzflush should be called only when strictly necessary because it can +</font>00754 <font class="comment"> degrade compression. +</font>00755 <font class="comment">*/</font> +00756 +00757 ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file, +00758 z_off_t offset, <font class="keywordtype">int</font> whence)); +00759 <font class="comment">/* +</font>00760 <font class="comment"> Sets the starting position for the next gzread or gzwrite on the +</font>00761 <font class="comment"> given compressed file. The offset represents a number of bytes in the +</font>00762 <font class="comment"> uncompressed data stream. The whence parameter is defined as in lseek(2); +</font>00763 <font class="comment"> the value SEEK_END is not supported. +</font>00764 <font class="comment"> If the file is opened for reading, this function is emulated but can be +</font>00765 <font class="comment"> extremely slow. If the file is opened for writing, only forward seeks are +</font>00766 <font class="comment"> supported; gzseek then compresses a sequence of zeroes up to the new +</font>00767 <font class="comment"> starting position. +</font>00768 <font class="comment"> +</font>00769 <font class="comment"> gzseek returns the resulting offset location as measured in bytes from +</font>00770 <font class="comment"> the beginning of the uncompressed stream, or -1 in case of error, in +</font>00771 <font class="comment"> particular if the file is opened for writing and the new starting position +</font>00772 <font class="comment"> would be before the current position. +</font>00773 <font class="comment">*/</font> +00774 +00775 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzrewind OF((gzFile file)); +00776 <font class="comment">/* +</font>00777 <font class="comment"> Rewinds the given file. This function is supported only for reading. +</font>00778 <font class="comment"> +</font>00779 <font class="comment"> gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET) +</font>00780 <font class="comment">*/</font> +00781 +00782 ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file)); +00783 <font class="comment">/* +</font>00784 <font class="comment"> Returns the starting position for the next gzread or gzwrite on the +</font>00785 <font class="comment"> given compressed file. This position represents a number of bytes in the +</font>00786 <font class="comment"> uncompressed data stream. +</font>00787 <font class="comment"> +</font>00788 <font class="comment"> gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR) +</font>00789 <font class="comment">*/</font> +00790 +00791 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzeof OF((gzFile file)); +00792 <font class="comment">/* +</font>00793 <font class="comment"> Returns 1 when EOF has previously been detected reading the given +</font>00794 <font class="comment"> input stream, otherwise zero. +</font>00795 <font class="comment">*/</font> +00796 +00797 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzclose OF((gzFile file)); +00798 <font class="comment">/* +</font>00799 <font class="comment"> Flushes all pending output if necessary, closes the compressed file +</font>00800 <font class="comment"> and deallocates all the (de)compression state. The return value is the zlib +</font>00801 <font class="comment"> error number (see function gzerror below). +</font>00802 <font class="comment">*/</font> +00803 +00804 ZEXTERN <font class="keyword">const</font> <font class="keywordtype">char</font> * ZEXPORT gzerror OF((gzFile file, <font class="keywordtype">int</font> *errnum)); +00805 <font class="comment">/* +</font>00806 <font class="comment"> Returns the error message for the last error which occurred on the +</font>00807 <font class="comment"> given compressed file. errnum is set to zlib error number. If an +</font>00808 <font class="comment"> error occurred in the file system and not in the compression library, +</font>00809 <font class="comment"> errnum is set to Z_ERRNO and the application may consult errno +</font>00810 <font class="comment"> to get the exact error code. +</font>00811 <font class="comment">*/</font> +00812 +00813 <font class="comment">/* checksum functions */</font> +00814 +00815 <font class="comment">/* +</font>00816 <font class="comment"> These functions are not related to compression but are exported +</font>00817 <font class="comment"> anyway because they might be useful in applications using the +</font>00818 <font class="comment"> compression library. +</font>00819 <font class="comment">*/</font> +00820 +00821 ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, <font class="keyword">const</font> Bytef *buf, uInt len)); +00822 +00823 <font class="comment">/* +</font>00824 <font class="comment"> Update a running Adler-32 checksum with the bytes buf[0..len-1] and +</font>00825 <font class="comment"> return the updated checksum. If buf is NULL, this function returns +</font>00826 <font class="comment"> the required initial value for the checksum. +</font>00827 <font class="comment"> An Adler-32 checksum is almost as reliable as a CRC32 but can be computed +</font>00828 <font class="comment"> much faster. Usage example: +</font>00829 <font class="comment"> +</font>00830 <font class="comment"> uLong adler = adler32(0L, Z_NULL, 0); +</font>00831 <font class="comment"> +</font>00832 <font class="comment"> while (read_buffer(buffer, length) != EOF) { +</font>00833 <font class="comment"> adler = adler32(adler, buffer, length); +</font>00834 <font class="comment"> } +</font>00835 <font class="comment"> if (adler != original_adler) error(); +</font>00836 <font class="comment">*/</font> +00837 +00838 ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, <font class="keyword">const</font> Bytef *buf, uInt len)); +00839 <font class="comment">/* +</font>00840 <font class="comment"> Update a running crc with the bytes buf[0..len-1] and return the updated +</font>00841 <font class="comment"> crc. If buf is NULL, this function returns the required initial value +</font>00842 <font class="comment"> for the crc. Pre- and post-conditioning (one's complement) is performed +</font>00843 <font class="comment"> within this function so it shouldn't be done by the application. +</font>00844 <font class="comment"> Usage example: +</font>00845 <font class="comment"> +</font>00846 <font class="comment"> uLong crc = crc32(0L, Z_NULL, 0); +</font>00847 <font class="comment"> +</font>00848 <font class="comment"> while (read_buffer(buffer, length) != EOF) { +</font>00849 <font class="comment"> crc = crc32(crc, buffer, length); +</font>00850 <font class="comment"> } +</font>00851 <font class="comment"> if (crc != original_crc) error(); +</font>00852 <font class="comment">*/</font> +00853 +00854 +00855 <font class="comment">/* various hacks, don't look :) */</font> +00856 +00857 <font class="comment">/* deflateInit and inflateInit are macros to allow checking the zlib version +</font>00858 <font class="comment"> * and the compiler's view of z_stream: +</font>00859 <font class="comment"> */</font> +00860 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateInit_ OF((z_streamp strm, <font class="keywordtype">int</font> level, +00861 <font class="keyword">const</font> <font class="keywordtype">char</font> *version, <font class="keywordtype">int</font> stream_size)); +00862 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateInit_ OF((z_streamp strm, +00863 <font class="keyword">const</font> <font class="keywordtype">char</font> *version, <font class="keywordtype">int</font> stream_size)); +00864 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateInit2_ OF((z_streamp strm, <font class="keywordtype">int</font> level, <font class="keywordtype">int</font> method, +00865 <font class="keywordtype">int</font> windowBits, <font class="keywordtype">int</font> memLevel, +00866 <font class="keywordtype">int</font> strategy, <font class="keyword">const</font> <font class="keywordtype">char</font> *version, +00867 <font class="keywordtype">int</font> stream_size)); +00868 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateInit2_ OF((z_streamp strm, <font class="keywordtype">int</font> windowBits, +00869 <font class="keyword">const</font> <font class="keywordtype">char</font> *version, <font class="keywordtype">int</font> stream_size)); +00870 <font class="preprocessor">#define deflateInit(strm, level) \ +</font>00871 <font class="preprocessor"> deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream)) +</font>00872 <font class="preprocessor"></font><font class="preprocessor">#define inflateInit(strm) \ +</font>00873 <font class="preprocessor"> inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream)) +</font>00874 <font class="preprocessor"></font><font class="preprocessor">#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \ +</font>00875 <font class="preprocessor"> deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\ +</font>00876 <font class="preprocessor"> (strategy), ZLIB_VERSION, sizeof(z_stream)) +</font>00877 <font class="preprocessor"></font><font class="preprocessor">#define inflateInit2(strm, windowBits) \ +</font>00878 <font class="preprocessor"> inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream)) +</font>00879 <font class="preprocessor"></font> +00880 +00881 <font class="preprocessor">#if !defined(_Z_UTIL_H) && !defined(NO_DUMMY_DECL) +</font>00882 <font class="preprocessor"></font> <font class="keyword">struct </font>internal_state {<font class="keywordtype">int</font> dummy;}; <font class="comment">/* hack for buggy compilers */</font> +00883 <font class="preprocessor">#endif +</font>00884 <font class="preprocessor"></font> +00885 ZEXTERN <font class="keyword">const</font> <font class="keywordtype">char</font> * ZEXPORT zError OF((<font class="keywordtype">int</font> err)); +00886 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateSyncPoint OF((z_streamp z)); +00887 ZEXTERN <font class="keyword">const</font> uLongf * ZEXPORT get_crc_table OF((<font class="keywordtype">void</font>)); +00888 +00889 <font class="preprocessor">#ifdef __cplusplus +</font>00890 <font class="preprocessor"></font>} +00891 <font class="preprocessor">#endif +</font>00892 <font class="preprocessor"></font> +00893 <font class="preprocessor">#endif </font><font class="comment">/* _ZLIB_H */</font> +</div></pre><hr><address><small>Generated at Thu May 24 19:50:27 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zlib_8h-source.html b/doc/api-documentation/html/zlib_8h-source.html new file mode 100644 index 0000000..09eef76 --- /dev/null +++ b/doc/api-documentation/html/zlib_8h-source.html @@ -0,0 +1,908 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>zlib.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zlib.h</h1><div class="fragment"><pre>00001 <font class="comment">/* zlib.h -- interface of the 'zlib' general purpose compression library</font> +00002 <font class="comment"> version 1.1.3, July 9th, 1998</font> +00003 <font class="comment"></font> +00004 <font class="comment"> Copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler</font> +00005 <font class="comment"></font> +00006 <font class="comment"> This software is provided 'as-is', without any express or implied</font> +00007 <font class="comment"> warranty. In no event will the authors be held liable for any damages</font> +00008 <font class="comment"> arising from the use of this software.</font> +00009 <font class="comment"></font> +00010 <font class="comment"> Permission is granted to anyone to use this software for any purpose,</font> +00011 <font class="comment"> including commercial applications, and to alter it and redistribute it</font> +00012 <font class="comment"> freely, subject to the following restrictions:</font> +00013 <font class="comment"></font> +00014 <font class="comment"> 1. The origin of this software must not be misrepresented; you must not</font> +00015 <font class="comment"> claim that you wrote the original software. If you use this software</font> +00016 <font class="comment"> in a product, an acknowledgment in the product documentation would be</font> +00017 <font class="comment"> appreciated but is not required.</font> +00018 <font class="comment"> 2. Altered source versions must be plainly marked as such, and must not be</font> +00019 <font class="comment"> misrepresented as being the original software.</font> +00020 <font class="comment"> 3. This notice may not be removed or altered from any source distribution.</font> +00021 <font class="comment"></font> +00022 <font class="comment"> Jean-loup Gailly Mark Adler</font> +00023 <font class="comment"> jloup@gzip.org madler@alumni.caltech.edu</font> +00024 <font class="comment"></font> +00025 <font class="comment"></font> +00026 <font class="comment"> The data format used by the zlib library is described by RFCs (Request for</font> +00027 <font class="comment"> Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt</font> +00028 <font class="comment"> (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).</font> +00029 <font class="comment">*/</font> +00030 +00031 <font class="preprocessor">#ifndef _ZLIB_H</font> +00032 <font class="preprocessor"></font><font class="preprocessor">#define _ZLIB_H</font> +00033 <font class="preprocessor"></font> +00034 <font class="preprocessor">#include "zconf.h"</font> +00035 +00036 <font class="preprocessor">#ifdef __cplusplus</font> +00037 <font class="preprocessor"></font><font class="keyword">extern</font> <font class="stringliteral">"C"</font> { +00038 <font class="preprocessor">#endif</font> +00039 <font class="preprocessor"></font> +00040 <font class="preprocessor">#define ZLIB_VERSION "1.1.3"</font> +00041 <font class="preprocessor"></font> +00042 <font class="comment">/* </font> +00043 <font class="comment"> The 'zlib' compression library provides in-memory compression and</font> +00044 <font class="comment"> decompression functions, including integrity checks of the uncompressed</font> +00045 <font class="comment"> data. This version of the library supports only one compression method</font> +00046 <font class="comment"> (deflation) but other algorithms will be added later and will have the same</font> +00047 <font class="comment"> stream interface.</font> +00048 <font class="comment"></font> +00049 <font class="comment"> Compression can be done in a single step if the buffers are large</font> +00050 <font class="comment"> enough (for example if an input file is mmap'ed), or can be done by</font> +00051 <font class="comment"> repeated calls of the compression function. In the latter case, the</font> +00052 <font class="comment"> application must provide more input and/or consume the output</font> +00053 <font class="comment"> (providing more output space) before each call.</font> +00054 <font class="comment"></font> +00055 <font class="comment"> The library also supports reading and writing files in gzip (.gz) format</font> +00056 <font class="comment"> with an interface similar to that of stdio.</font> +00057 <font class="comment"></font> +00058 <font class="comment"> The library does not install any signal handler. The decoder checks</font> +00059 <font class="comment"> the consistency of the compressed data, so the library should never</font> +00060 <font class="comment"> crash even in case of corrupted input.</font> +00061 <font class="comment">*/</font> +00062 +00063 <font class="keyword">typedef</font> voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); +00064 <font class="keyword">typedef</font> void (*free_func) OF((voidpf opaque, voidpf address)); +00065 +00066 <font class="keyword">struct </font>internal_state; +00067 +00068 <font class="keyword">typedef</font> <font class="keyword">struct </font>z_stream_s { +00069 Bytef *next_in; <font class="comment">/* next input byte */</font> +00070 uInt avail_in; <font class="comment">/* number of bytes available at next_in */</font> +00071 uLong total_in; <font class="comment">/* total nb of input bytes read so far */</font> +00072 +00073 Bytef *next_out; <font class="comment">/* next output byte should be put there */</font> +00074 uInt avail_out; <font class="comment">/* remaining free space at next_out */</font> +00075 uLong total_out; <font class="comment">/* total nb of bytes output so far */</font> +00076 +00077 <font class="keywordtype">char</font> *msg; <font class="comment">/* last error message, NULL if no error */</font> +00078 <font class="keyword">struct </font>internal_state FAR *state; <font class="comment">/* not visible by applications */</font> +00079 +00080 alloc_func zalloc; <font class="comment">/* used to allocate the internal state */</font> +00081 free_func zfree; <font class="comment">/* used to free the internal state */</font> +00082 voidpf opaque; <font class="comment">/* private data object passed to zalloc and zfree */</font> +00083 +00084 <font class="keywordtype">int</font> data_type; <font class="comment">/* best guess about the data type: ascii or binary */</font> +00085 uLong adler; <font class="comment">/* adler32 value of the uncompressed data */</font> +00086 uLong reserved; <font class="comment">/* reserved for future use */</font> +00087 } z_stream; +00088 +00089 <font class="keyword">typedef</font> z_stream FAR *z_streamp; +00090 +00091 <font class="comment">/*</font> +00092 <font class="comment"> The application must update next_in and avail_in when avail_in has</font> +00093 <font class="comment"> dropped to zero. It must update next_out and avail_out when avail_out</font> +00094 <font class="comment"> has dropped to zero. The application must initialize zalloc, zfree and</font> +00095 <font class="comment"> opaque before calling the init function. All other fields are set by the</font> +00096 <font class="comment"> compression library and must not be updated by the application.</font> +00097 <font class="comment"></font> +00098 <font class="comment"> The opaque value provided by the application will be passed as the first</font> +00099 <font class="comment"> parameter for calls of zalloc and zfree. This can be useful for custom</font> +00100 <font class="comment"> memory management. The compression library attaches no meaning to the</font> +00101 <font class="comment"> opaque value.</font> +00102 <font class="comment"></font> +00103 <font class="comment"> zalloc must return Z_NULL if there is not enough memory for the object.</font> +00104 <font class="comment"> If zlib is used in a multi-threaded application, zalloc and zfree must be</font> +00105 <font class="comment"> thread safe.</font> +00106 <font class="comment"></font> +00107 <font class="comment"> On 16-bit systems, the functions zalloc and zfree must be able to allocate</font> +00108 <font class="comment"> exactly 65536 bytes, but will not be required to allocate more than this</font> +00109 <font class="comment"> if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,</font> +00110 <font class="comment"> pointers returned by zalloc for objects of exactly 65536 bytes *must*</font> +00111 <font class="comment"> have their offset normalized to zero. The default allocation function</font> +00112 <font class="comment"> provided by this library ensures this (see zutil.c). To reduce memory</font> +00113 <font class="comment"> requirements and avoid any allocation of 64K objects, at the expense of</font> +00114 <font class="comment"> compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).</font> +00115 <font class="comment"></font> +00116 <font class="comment"> The fields total_in and total_out can be used for statistics or</font> +00117 <font class="comment"> progress reports. After compression, total_in holds the total size of</font> +00118 <font class="comment"> the uncompressed data and may be saved for use in the decompressor</font> +00119 <font class="comment"> (particularly if the decompressor wants to decompress everything in</font> +00120 <font class="comment"> a single step).</font> +00121 <font class="comment">*/</font> +00122 +00123 <font class="comment">/* constants */</font> +00124 +00125 <font class="preprocessor">#define Z_NO_FLUSH 0</font> +00126 <font class="preprocessor"></font><font class="preprocessor">#define Z_PARTIAL_FLUSH 1 </font><font class="comment">/* will be removed, use Z_SYNC_FLUSH instead */</font> +00127 <font class="preprocessor">#define Z_SYNC_FLUSH 2</font> +00128 <font class="preprocessor"></font><font class="preprocessor">#define Z_FULL_FLUSH 3</font> +00129 <font class="preprocessor"></font><font class="preprocessor">#define Z_FINISH 4</font> +00130 <font class="preprocessor"></font><font class="comment">/* Allowed flush values; see deflate() below for details */</font> +00131 +00132 <font class="preprocessor">#define Z_OK 0</font> +00133 <font class="preprocessor"></font><font class="preprocessor">#define Z_STREAM_END 1</font> +00134 <font class="preprocessor"></font><font class="preprocessor">#define Z_NEED_DICT 2</font> +00135 <font class="preprocessor"></font><font class="preprocessor">#define Z_ERRNO (-1)</font> +00136 <font class="preprocessor"></font><font class="preprocessor">#define Z_STREAM_ERROR (-2)</font> +00137 <font class="preprocessor"></font><font class="preprocessor">#define Z_DATA_ERROR (-3)</font> +00138 <font class="preprocessor"></font><font class="preprocessor">#define Z_MEM_ERROR (-4)</font> +00139 <font class="preprocessor"></font><font class="preprocessor">#define Z_BUF_ERROR (-5)</font> +00140 <font class="preprocessor"></font><font class="preprocessor">#define Z_VERSION_ERROR (-6)</font> +00141 <font class="preprocessor"></font><font class="comment">/* Return codes for the compression/decompression functions. Negative</font> +00142 <font class="comment"> * values are errors, positive values are used for special but normal events.</font> +00143 <font class="comment"> */</font> +00144 +00145 <font class="preprocessor">#define Z_NO_COMPRESSION 0</font> +00146 <font class="preprocessor"></font><font class="preprocessor">#define Z_BEST_SPEED 1</font> +00147 <font class="preprocessor"></font><font class="preprocessor">#define Z_BEST_COMPRESSION 9</font> +00148 <font class="preprocessor"></font><font class="preprocessor">#define Z_DEFAULT_COMPRESSION (-1)</font> +00149 <font class="preprocessor"></font><font class="comment">/* compression levels */</font> +00150 +00151 <font class="preprocessor">#define Z_FILTERED 1</font> +00152 <font class="preprocessor"></font><font class="preprocessor">#define Z_HUFFMAN_ONLY 2</font> +00153 <font class="preprocessor"></font><font class="preprocessor">#define Z_DEFAULT_STRATEGY 0</font> +00154 <font class="preprocessor"></font><font class="comment">/* compression strategy; see deflateInit2() below for details */</font> +00155 +00156 <font class="preprocessor">#define Z_BINARY 0</font> +00157 <font class="preprocessor"></font><font class="preprocessor">#define Z_ASCII 1</font> +00158 <font class="preprocessor"></font><font class="preprocessor">#define Z_UNKNOWN 2</font> +00159 <font class="preprocessor"></font><font class="comment">/* Possible values of the data_type field */</font> +00160 +00161 <font class="preprocessor">#define Z_DEFLATED 8</font> +00162 <font class="preprocessor"></font><font class="comment">/* The deflate compression method (the only one supported in this version) */</font> +00163 +00164 <font class="preprocessor">#define Z_NULL 0 </font><font class="comment">/* for initializing zalloc, zfree, opaque */</font> +00165 +00166 <font class="preprocessor">#define zlib_version zlibVersion()</font> +00167 <font class="preprocessor"></font><font class="comment">/* for compatibility with versions < 1.0.2 */</font> +00168 +00169 <font class="comment">/* basic functions */</font> +00170 +00171 ZEXTERN <font class="keyword">const</font> <font class="keywordtype">char</font> * ZEXPORT zlibVersion OF((<font class="keywordtype">void</font>)); +00172 <font class="comment">/* The application can compare zlibVersion and ZLIB_VERSION for consistency.</font> +00173 <font class="comment"> If the first character differs, the library code actually used is</font> +00174 <font class="comment"> not compatible with the zlib.h header file used by the application.</font> +00175 <font class="comment"> This check is automatically made by deflateInit and inflateInit.</font> +00176 <font class="comment"> */</font> +00177 +00178 <font class="comment">/* </font> +00179 <font class="comment">ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));</font> +00180 <font class="comment"></font> +00181 <font class="comment"> Initializes the internal stream state for compression. The fields</font> +00182 <font class="comment"> zalloc, zfree and opaque must be initialized before by the caller.</font> +00183 <font class="comment"> If zalloc and zfree are set to Z_NULL, deflateInit updates them to</font> +00184 <font class="comment"> use default allocation functions.</font> +00185 <font class="comment"></font> +00186 <font class="comment"> The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:</font> +00187 <font class="comment"> 1 gives best speed, 9 gives best compression, 0 gives no compression at</font> +00188 <font class="comment"> all (the input data is simply copied a block at a time).</font> +00189 <font class="comment"> Z_DEFAULT_COMPRESSION requests a default compromise between speed and</font> +00190 <font class="comment"> compression (currently equivalent to level 6).</font> +00191 <font class="comment"></font> +00192 <font class="comment"> deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not</font> +00193 <font class="comment"> enough memory, Z_STREAM_ERROR if level is not a valid compression level,</font> +00194 <font class="comment"> Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible</font> +00195 <font class="comment"> with the version assumed by the caller (ZLIB_VERSION).</font> +00196 <font class="comment"> msg is set to null if there is no error message. deflateInit does not</font> +00197 <font class="comment"> perform any compression: this will be done by deflate().</font> +00198 <font class="comment">*/</font> +00199 +00200 +00201 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflate OF((z_streamp strm, <font class="keywordtype">int</font> flush)); +00202 <font class="comment">/*</font> +00203 <font class="comment"> deflate compresses as much data as possible, and stops when the input</font> +00204 <font class="comment"> buffer becomes empty or the output buffer becomes full. It may introduce some</font> +00205 <font class="comment"> output latency (reading input without producing any output) except when</font> +00206 <font class="comment"> forced to flush.</font> +00207 <font class="comment"></font> +00208 <font class="comment"> The detailed semantics are as follows. deflate performs one or both of the</font> +00209 <font class="comment"> following actions:</font> +00210 <font class="comment"></font> +00211 <font class="comment"> - Compress more input starting at next_in and update next_in and avail_in</font> +00212 <font class="comment"> accordingly. If not all input can be processed (because there is not</font> +00213 <font class="comment"> enough room in the output buffer), next_in and avail_in are updated and</font> +00214 <font class="comment"> processing will resume at this point for the next call of deflate().</font> +00215 <font class="comment"></font> +00216 <font class="comment"> - Provide more output starting at next_out and update next_out and avail_out</font> +00217 <font class="comment"> accordingly. This action is forced if the parameter flush is non zero.</font> +00218 <font class="comment"> Forcing flush frequently degrades the compression ratio, so this parameter</font> +00219 <font class="comment"> should be set only when necessary (in interactive applications).</font> +00220 <font class="comment"> Some output may be provided even if flush is not set.</font> +00221 <font class="comment"></font> +00222 <font class="comment"> Before the call of deflate(), the application should ensure that at least</font> +00223 <font class="comment"> one of the actions is possible, by providing more input and/or consuming</font> +00224 <font class="comment"> more output, and updating avail_in or avail_out accordingly; avail_out</font> +00225 <font class="comment"> should never be zero before the call. The application can consume the</font> +00226 <font class="comment"> compressed output when it wants, for example when the output buffer is full</font> +00227 <font class="comment"> (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK</font> +00228 <font class="comment"> and with zero avail_out, it must be called again after making room in the</font> +00229 <font class="comment"> output buffer because there might be more output pending.</font> +00230 <font class="comment"></font> +00231 <font class="comment"> If the parameter flush is set to Z_SYNC_FLUSH, all pending output is</font> +00232 <font class="comment"> flushed to the output buffer and the output is aligned on a byte boundary, so</font> +00233 <font class="comment"> that the decompressor can get all input data available so far. (In particular</font> +00234 <font class="comment"> avail_in is zero after the call if enough output space has been provided</font> +00235 <font class="comment"> before the call.) Flushing may degrade compression for some compression</font> +00236 <font class="comment"> algorithms and so it should be used only when necessary.</font> +00237 <font class="comment"></font> +00238 <font class="comment"> If flush is set to Z_FULL_FLUSH, all output is flushed as with</font> +00239 <font class="comment"> Z_SYNC_FLUSH, and the compression state is reset so that decompression can</font> +00240 <font class="comment"> restart from this point if previous compressed data has been damaged or if</font> +00241 <font class="comment"> random access is desired. Using Z_FULL_FLUSH too often can seriously degrade</font> +00242 <font class="comment"> the compression.</font> +00243 <font class="comment"></font> +00244 <font class="comment"> If deflate returns with avail_out == 0, this function must be called again</font> +00245 <font class="comment"> with the same value of the flush parameter and more output space (updated</font> +00246 <font class="comment"> avail_out), until the flush is complete (deflate returns with non-zero</font> +00247 <font class="comment"> avail_out).</font> +00248 <font class="comment"></font> +00249 <font class="comment"> If the parameter flush is set to Z_FINISH, pending input is processed,</font> +00250 <font class="comment"> pending output is flushed and deflate returns with Z_STREAM_END if there</font> +00251 <font class="comment"> was enough output space; if deflate returns with Z_OK, this function must be</font> +00252 <font class="comment"> called again with Z_FINISH and more output space (updated avail_out) but no</font> +00253 <font class="comment"> more input data, until it returns with Z_STREAM_END or an error. After</font> +00254 <font class="comment"> deflate has returned Z_STREAM_END, the only possible operations on the</font> +00255 <font class="comment"> stream are deflateReset or deflateEnd.</font> +00256 <font class="comment"> </font> +00257 <font class="comment"> Z_FINISH can be used immediately after deflateInit if all the compression</font> +00258 <font class="comment"> is to be done in a single step. In this case, avail_out must be at least</font> +00259 <font class="comment"> 0.1% larger than avail_in plus 12 bytes. If deflate does not return</font> +00260 <font class="comment"> Z_STREAM_END, then it must be called again as described above.</font> +00261 <font class="comment"></font> +00262 <font class="comment"> deflate() sets strm->adler to the adler32 checksum of all input read</font> +00263 <font class="comment"> so far (that is, total_in bytes).</font> +00264 <font class="comment"></font> +00265 <font class="comment"> deflate() may update data_type if it can make a good guess about</font> +00266 <font class="comment"> the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered</font> +00267 <font class="comment"> binary. This field is only for information purposes and does not affect</font> +00268 <font class="comment"> the compression algorithm in any manner.</font> +00269 <font class="comment"></font> +00270 <font class="comment"> deflate() returns Z_OK if some progress has been made (more input</font> +00271 <font class="comment"> processed or more output produced), Z_STREAM_END if all input has been</font> +00272 <font class="comment"> consumed and all output has been produced (only when flush is set to</font> +00273 <font class="comment"> Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example</font> +00274 <font class="comment"> if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible</font> +00275 <font class="comment"> (for example avail_in or avail_out was zero).</font> +00276 <font class="comment">*/</font> +00277 +00278 +00279 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateEnd OF((z_streamp strm)); +00280 <font class="comment">/*</font> +00281 <font class="comment"> All dynamically allocated data structures for this stream are freed.</font> +00282 <font class="comment"> This function discards any unprocessed input and does not flush any</font> +00283 <font class="comment"> pending output.</font> +00284 <font class="comment"></font> +00285 <font class="comment"> deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the</font> +00286 <font class="comment"> stream state was inconsistent, Z_DATA_ERROR if the stream was freed</font> +00287 <font class="comment"> prematurely (some input or output was discarded). In the error case,</font> +00288 <font class="comment"> msg may be set but then points to a static string (which must not be</font> +00289 <font class="comment"> deallocated).</font> +00290 <font class="comment">*/</font> +00291 +00292 +00293 <font class="comment">/* </font> +00294 <font class="comment">ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));</font> +00295 <font class="comment"></font> +00296 <font class="comment"> Initializes the internal stream state for decompression. The fields</font> +00297 <font class="comment"> next_in, avail_in, zalloc, zfree and opaque must be initialized before by</font> +00298 <font class="comment"> the caller. If next_in is not Z_NULL and avail_in is large enough (the exact</font> +00299 <font class="comment"> value depends on the compression method), inflateInit determines the</font> +00300 <font class="comment"> compression method from the zlib header and allocates all data structures</font> +00301 <font class="comment"> accordingly; otherwise the allocation will be deferred to the first call of</font> +00302 <font class="comment"> inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to</font> +00303 <font class="comment"> use default allocation functions.</font> +00304 <font class="comment"></font> +00305 <font class="comment"> inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough</font> +00306 <font class="comment"> memory, Z_VERSION_ERROR if the zlib library version is incompatible with the</font> +00307 <font class="comment"> version assumed by the caller. msg is set to null if there is no error</font> +00308 <font class="comment"> message. inflateInit does not perform any decompression apart from reading</font> +00309 <font class="comment"> the zlib header if present: this will be done by inflate(). (So next_in and</font> +00310 <font class="comment"> avail_in may be modified, but next_out and avail_out are unchanged.)</font> +00311 <font class="comment">*/</font> +00312 +00313 +00314 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflate OF((z_streamp strm, <font class="keywordtype">int</font> flush)); +00315 <font class="comment">/*</font> +00316 <font class="comment"> inflate decompresses as much data as possible, and stops when the input</font> +00317 <font class="comment"> buffer becomes empty or the output buffer becomes full. It may some</font> +00318 <font class="comment"> introduce some output latency (reading input without producing any output)</font> +00319 <font class="comment"> except when forced to flush.</font> +00320 <font class="comment"></font> +00321 <font class="comment"> The detailed semantics are as follows. inflate performs one or both of the</font> +00322 <font class="comment"> following actions:</font> +00323 <font class="comment"></font> +00324 <font class="comment"> - Decompress more input starting at next_in and update next_in and avail_in</font> +00325 <font class="comment"> accordingly. If not all input can be processed (because there is not</font> +00326 <font class="comment"> enough room in the output buffer), next_in is updated and processing</font> +00327 <font class="comment"> will resume at this point for the next call of inflate().</font> +00328 <font class="comment"></font> +00329 <font class="comment"> - Provide more output starting at next_out and update next_out and avail_out</font> +00330 <font class="comment"> accordingly. inflate() provides as much output as possible, until there</font> +00331 <font class="comment"> is no more input data or no more space in the output buffer (see below</font> +00332 <font class="comment"> about the flush parameter).</font> +00333 <font class="comment"></font> +00334 <font class="comment"> Before the call of inflate(), the application should ensure that at least</font> +00335 <font class="comment"> one of the actions is possible, by providing more input and/or consuming</font> +00336 <font class="comment"> more output, and updating the next_* and avail_* values accordingly.</font> +00337 <font class="comment"> The application can consume the uncompressed output when it wants, for</font> +00338 <font class="comment"> example when the output buffer is full (avail_out == 0), or after each</font> +00339 <font class="comment"> call of inflate(). If inflate returns Z_OK and with zero avail_out, it</font> +00340 <font class="comment"> must be called again after making room in the output buffer because there</font> +00341 <font class="comment"> might be more output pending.</font> +00342 <font class="comment"></font> +00343 <font class="comment"> If the parameter flush is set to Z_SYNC_FLUSH, inflate flushes as much</font> +00344 <font class="comment"> output as possible to the output buffer. The flushing behavior of inflate is</font> +00345 <font class="comment"> not specified for values of the flush parameter other than Z_SYNC_FLUSH</font> +00346 <font class="comment"> and Z_FINISH, but the current implementation actually flushes as much output</font> +00347 <font class="comment"> as possible anyway.</font> +00348 <font class="comment"></font> +00349 <font class="comment"> inflate() should normally be called until it returns Z_STREAM_END or an</font> +00350 <font class="comment"> error. However if all decompression is to be performed in a single step</font> +00351 <font class="comment"> (a single call of inflate), the parameter flush should be set to</font> +00352 <font class="comment"> Z_FINISH. In this case all pending input is processed and all pending</font> +00353 <font class="comment"> output is flushed; avail_out must be large enough to hold all the</font> +00354 <font class="comment"> uncompressed data. (The size of the uncompressed data may have been saved</font> +00355 <font class="comment"> by the compressor for this purpose.) The next operation on this stream must</font> +00356 <font class="comment"> be inflateEnd to deallocate the decompression state. The use of Z_FINISH</font> +00357 <font class="comment"> is never required, but can be used to inform inflate that a faster routine</font> +00358 <font class="comment"> may be used for the single inflate() call.</font> +00359 <font class="comment"></font> +00360 <font class="comment"> If a preset dictionary is needed at this point (see inflateSetDictionary</font> +00361 <font class="comment"> below), inflate sets strm-adler to the adler32 checksum of the</font> +00362 <font class="comment"> dictionary chosen by the compressor and returns Z_NEED_DICT; otherwise </font> +00363 <font class="comment"> it sets strm->adler to the adler32 checksum of all output produced</font> +00364 <font class="comment"> so far (that is, total_out bytes) and returns Z_OK, Z_STREAM_END or</font> +00365 <font class="comment"> an error code as described below. At the end of the stream, inflate()</font> +00366 <font class="comment"> checks that its computed adler32 checksum is equal to that saved by the</font> +00367 <font class="comment"> compressor and returns Z_STREAM_END only if the checksum is correct.</font> +00368 <font class="comment"></font> +00369 <font class="comment"> inflate() returns Z_OK if some progress has been made (more input processed</font> +00370 <font class="comment"> or more output produced), Z_STREAM_END if the end of the compressed data has</font> +00371 <font class="comment"> been reached and all uncompressed output has been produced, Z_NEED_DICT if a</font> +00372 <font class="comment"> preset dictionary is needed at this point, Z_DATA_ERROR if the input data was</font> +00373 <font class="comment"> corrupted (input stream not conforming to the zlib format or incorrect</font> +00374 <font class="comment"> adler32 checksum), Z_STREAM_ERROR if the stream structure was inconsistent</font> +00375 <font class="comment"> (for example if next_in or next_out was NULL), Z_MEM_ERROR if there was not</font> +00376 <font class="comment"> enough memory, Z_BUF_ERROR if no progress is possible or if there was not</font> +00377 <font class="comment"> enough room in the output buffer when Z_FINISH is used. In the Z_DATA_ERROR</font> +00378 <font class="comment"> case, the application may then call inflateSync to look for a good</font> +00379 <font class="comment"> compression block.</font> +00380 <font class="comment">*/</font> +00381 +00382 +00383 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateEnd OF((z_streamp strm)); +00384 <font class="comment">/*</font> +00385 <font class="comment"> All dynamically allocated data structures for this stream are freed.</font> +00386 <font class="comment"> This function discards any unprocessed input and does not flush any</font> +00387 <font class="comment"> pending output.</font> +00388 <font class="comment"></font> +00389 <font class="comment"> inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state</font> +00390 <font class="comment"> was inconsistent. In the error case, msg may be set but then points to a</font> +00391 <font class="comment"> static string (which must not be deallocated).</font> +00392 <font class="comment">*/</font> +00393 +00394 <font class="comment">/* Advanced functions */</font> +00395 +00396 <font class="comment">/*</font> +00397 <font class="comment"> The following functions are needed only in some special applications.</font> +00398 <font class="comment">*/</font> +00399 +00400 <font class="comment">/* </font> +00401 <font class="comment">ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,</font> +00402 <font class="comment"> int level,</font> +00403 <font class="comment"> int method,</font> +00404 <font class="comment"> int windowBits,</font> +00405 <font class="comment"> int memLevel,</font> +00406 <font class="comment"> int strategy));</font> +00407 <font class="comment"></font> +00408 <font class="comment"> This is another version of deflateInit with more compression options. The</font> +00409 <font class="comment"> fields next_in, zalloc, zfree and opaque must be initialized before by</font> +00410 <font class="comment"> the caller.</font> +00411 <font class="comment"></font> +00412 <font class="comment"> The method parameter is the compression method. It must be Z_DEFLATED in</font> +00413 <font class="comment"> this version of the library.</font> +00414 <font class="comment"></font> +00415 <font class="comment"> The windowBits parameter is the base two logarithm of the window size</font> +00416 <font class="comment"> (the size of the history buffer). It should be in the range 8..15 for this</font> +00417 <font class="comment"> version of the library. Larger values of this parameter result in better</font> +00418 <font class="comment"> compression at the expense of memory usage. The default value is 15 if</font> +00419 <font class="comment"> deflateInit is used instead.</font> +00420 <font class="comment"></font> +00421 <font class="comment"> The memLevel parameter specifies how much memory should be allocated</font> +00422 <font class="comment"> for the internal compression state. memLevel=1 uses minimum memory but</font> +00423 <font class="comment"> is slow and reduces compression ratio; memLevel=9 uses maximum memory</font> +00424 <font class="comment"> for optimal speed. The default value is 8. See zconf.h for total memory</font> +00425 <font class="comment"> usage as a function of windowBits and memLevel.</font> +00426 <font class="comment"></font> +00427 <font class="comment"> The strategy parameter is used to tune the compression algorithm. Use the</font> +00428 <font class="comment"> value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a</font> +00429 <font class="comment"> filter (or predictor), or Z_HUFFMAN_ONLY to force Huffman encoding only (no</font> +00430 <font class="comment"> string match). Filtered data consists mostly of small values with a</font> +00431 <font class="comment"> somewhat random distribution. In this case, the compression algorithm is</font> +00432 <font class="comment"> tuned to compress them better. The effect of Z_FILTERED is to force more</font> +00433 <font class="comment"> Huffman coding and less string matching; it is somewhat intermediate</font> +00434 <font class="comment"> between Z_DEFAULT and Z_HUFFMAN_ONLY. The strategy parameter only affects</font> +00435 <font class="comment"> the compression ratio but not the correctness of the compressed output even</font> +00436 <font class="comment"> if it is not set appropriately.</font> +00437 <font class="comment"></font> +00438 <font class="comment"> deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough</font> +00439 <font class="comment"> memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid</font> +00440 <font class="comment"> method). msg is set to null if there is no error message. deflateInit2 does</font> +00441 <font class="comment"> not perform any compression: this will be done by deflate().</font> +00442 <font class="comment">*/</font> +00443 +00444 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateSetDictionary OF((z_streamp strm, +00445 <font class="keyword">const</font> Bytef *dictionary, +00446 uInt dictLength)); +00447 <font class="comment">/*</font> +00448 <font class="comment"> Initializes the compression dictionary from the given byte sequence</font> +00449 <font class="comment"> without producing any compressed output. This function must be called</font> +00450 <font class="comment"> immediately after deflateInit, deflateInit2 or deflateReset, before any</font> +00451 <font class="comment"> call of deflate. The compressor and decompressor must use exactly the same</font> +00452 <font class="comment"> dictionary (see inflateSetDictionary).</font> +00453 <font class="comment"></font> +00454 <font class="comment"> The dictionary should consist of strings (byte sequences) that are likely</font> +00455 <font class="comment"> to be encountered later in the data to be compressed, with the most commonly</font> +00456 <font class="comment"> used strings preferably put towards the end of the dictionary. Using a</font> +00457 <font class="comment"> dictionary is most useful when the data to be compressed is short and can be</font> +00458 <font class="comment"> predicted with good accuracy; the data can then be compressed better than</font> +00459 <font class="comment"> with the default empty dictionary.</font> +00460 <font class="comment"></font> +00461 <font class="comment"> Depending on the size of the compression data structures selected by</font> +00462 <font class="comment"> deflateInit or deflateInit2, a part of the dictionary may in effect be</font> +00463 <font class="comment"> discarded, for example if the dictionary is larger than the window size in</font> +00464 <font class="comment"> deflate or deflate2. Thus the strings most likely to be useful should be</font> +00465 <font class="comment"> put at the end of the dictionary, not at the front.</font> +00466 <font class="comment"></font> +00467 <font class="comment"> Upon return of this function, strm->adler is set to the Adler32 value</font> +00468 <font class="comment"> of the dictionary; the decompressor may later use this value to determine</font> +00469 <font class="comment"> which dictionary has been used by the compressor. (The Adler32 value</font> +00470 <font class="comment"> applies to the whole dictionary even if only a subset of the dictionary is</font> +00471 <font class="comment"> actually used by the compressor.)</font> +00472 <font class="comment"></font> +00473 <font class="comment"> deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a</font> +00474 <font class="comment"> parameter is invalid (such as NULL dictionary) or the stream state is</font> +00475 <font class="comment"> inconsistent (for example if deflate has already been called for this stream</font> +00476 <font class="comment"> or if the compression method is bsort). deflateSetDictionary does not</font> +00477 <font class="comment"> perform any compression: this will be done by deflate().</font> +00478 <font class="comment">*/</font> +00479 +00480 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateCopy OF((z_streamp dest, +00481 z_streamp source)); +00482 <font class="comment">/*</font> +00483 <font class="comment"> Sets the destination stream as a complete copy of the source stream.</font> +00484 <font class="comment"></font> +00485 <font class="comment"> This function can be useful when several compression strategies will be</font> +00486 <font class="comment"> tried, for example when there are several ways of pre-processing the input</font> +00487 <font class="comment"> data with a filter. The streams that will be discarded should then be freed</font> +00488 <font class="comment"> by calling deflateEnd. Note that deflateCopy duplicates the internal</font> +00489 <font class="comment"> compression state which can be quite large, so this strategy is slow and</font> +00490 <font class="comment"> can consume lots of memory.</font> +00491 <font class="comment"></font> +00492 <font class="comment"> deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not</font> +00493 <font class="comment"> enough memory, Z_STREAM_ERROR if the source stream state was inconsistent</font> +00494 <font class="comment"> (such as zalloc being NULL). msg is left unchanged in both source and</font> +00495 <font class="comment"> destination.</font> +00496 <font class="comment">*/</font> +00497 +00498 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateReset OF((z_streamp strm)); +00499 <font class="comment">/*</font> +00500 <font class="comment"> This function is equivalent to deflateEnd followed by deflateInit,</font> +00501 <font class="comment"> but does not free and reallocate all the internal compression state.</font> +00502 <font class="comment"> The stream will keep the same compression level and any other attributes</font> +00503 <font class="comment"> that may have been set by deflateInit2.</font> +00504 <font class="comment"></font> +00505 <font class="comment"> deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source</font> +00506 <font class="comment"> stream state was inconsistent (such as zalloc or state being NULL).</font> +00507 <font class="comment">*/</font> +00508 +00509 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateParams OF((z_streamp strm, +00510 <font class="keywordtype">int</font> level, +00511 <font class="keywordtype">int</font> strategy)); +00512 <font class="comment">/*</font> +00513 <font class="comment"> Dynamically update the compression level and compression strategy. The</font> +00514 <font class="comment"> interpretation of level and strategy is as in deflateInit2. This can be</font> +00515 <font class="comment"> used to switch between compression and straight copy of the input data, or</font> +00516 <font class="comment"> to switch to a different kind of input data requiring a different</font> +00517 <font class="comment"> strategy. If the compression level is changed, the input available so far</font> +00518 <font class="comment"> is compressed with the old level (and may be flushed); the new level will</font> +00519 <font class="comment"> take effect only at the next call of deflate().</font> +00520 <font class="comment"></font> +00521 <font class="comment"> Before the call of deflateParams, the stream state must be set as for</font> +00522 <font class="comment"> a call of deflate(), since the currently available input may have to</font> +00523 <font class="comment"> be compressed and flushed. In particular, strm->avail_out must be non-zero.</font> +00524 <font class="comment"></font> +00525 <font class="comment"> deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source</font> +00526 <font class="comment"> stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR</font> +00527 <font class="comment"> if strm->avail_out was zero.</font> +00528 <font class="comment">*/</font> +00529 +00530 <font class="comment">/* </font> +00531 <font class="comment">ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,</font> +00532 <font class="comment"> int windowBits));</font> +00533 <font class="comment"></font> +00534 <font class="comment"> This is another version of inflateInit with an extra parameter. The</font> +00535 <font class="comment"> fields next_in, avail_in, zalloc, zfree and opaque must be initialized</font> +00536 <font class="comment"> before by the caller.</font> +00537 <font class="comment"></font> +00538 <font class="comment"> The windowBits parameter is the base two logarithm of the maximum window</font> +00539 <font class="comment"> size (the size of the history buffer). It should be in the range 8..15 for</font> +00540 <font class="comment"> this version of the library. The default value is 15 if inflateInit is used</font> +00541 <font class="comment"> instead. If a compressed stream with a larger window size is given as</font> +00542 <font class="comment"> input, inflate() will return with the error code Z_DATA_ERROR instead of</font> +00543 <font class="comment"> trying to allocate a larger window.</font> +00544 <font class="comment"></font> +00545 <font class="comment"> inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough</font> +00546 <font class="comment"> memory, Z_STREAM_ERROR if a parameter is invalid (such as a negative</font> +00547 <font class="comment"> memLevel). msg is set to null if there is no error message. inflateInit2</font> +00548 <font class="comment"> does not perform any decompression apart from reading the zlib header if</font> +00549 <font class="comment"> present: this will be done by inflate(). (So next_in and avail_in may be</font> +00550 <font class="comment"> modified, but next_out and avail_out are unchanged.)</font> +00551 <font class="comment">*/</font> +00552 +00553 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateSetDictionary OF((z_streamp strm, +00554 <font class="keyword">const</font> Bytef *dictionary, +00555 uInt dictLength)); +00556 <font class="comment">/*</font> +00557 <font class="comment"> Initializes the decompression dictionary from the given uncompressed byte</font> +00558 <font class="comment"> sequence. This function must be called immediately after a call of inflate</font> +00559 <font class="comment"> if this call returned Z_NEED_DICT. The dictionary chosen by the compressor</font> +00560 <font class="comment"> can be determined from the Adler32 value returned by this call of</font> +00561 <font class="comment"> inflate. The compressor and decompressor must use exactly the same</font> +00562 <font class="comment"> dictionary (see deflateSetDictionary).</font> +00563 <font class="comment"></font> +00564 <font class="comment"> inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a</font> +00565 <font class="comment"> parameter is invalid (such as NULL dictionary) or the stream state is</font> +00566 <font class="comment"> inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the</font> +00567 <font class="comment"> expected one (incorrect Adler32 value). inflateSetDictionary does not</font> +00568 <font class="comment"> perform any decompression: this will be done by subsequent calls of</font> +00569 <font class="comment"> inflate().</font> +00570 <font class="comment">*/</font> +00571 +00572 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateSync OF((z_streamp strm)); +00573 <font class="comment">/* </font> +00574 <font class="comment"> Skips invalid compressed data until a full flush point (see above the</font> +00575 <font class="comment"> description of deflate with Z_FULL_FLUSH) can be found, or until all</font> +00576 <font class="comment"> available input is skipped. No output is provided.</font> +00577 <font class="comment"></font> +00578 <font class="comment"> inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR</font> +00579 <font class="comment"> if no more input was provided, Z_DATA_ERROR if no flush point has been found,</font> +00580 <font class="comment"> or Z_STREAM_ERROR if the stream structure was inconsistent. In the success</font> +00581 <font class="comment"> case, the application may save the current current value of total_in which</font> +00582 <font class="comment"> indicates where valid compressed data was found. In the error case, the</font> +00583 <font class="comment"> application may repeatedly call inflateSync, providing more input each time,</font> +00584 <font class="comment"> until success or end of the input data.</font> +00585 <font class="comment">*/</font> +00586 +00587 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateReset OF((z_streamp strm)); +00588 <font class="comment">/*</font> +00589 <font class="comment"> This function is equivalent to inflateEnd followed by inflateInit,</font> +00590 <font class="comment"> but does not free and reallocate all the internal decompression state.</font> +00591 <font class="comment"> The stream will keep attributes that may have been set by inflateInit2.</font> +00592 <font class="comment"></font> +00593 <font class="comment"> inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source</font> +00594 <font class="comment"> stream state was inconsistent (such as zalloc or state being NULL).</font> +00595 <font class="comment">*/</font> +00596 +00597 +00598 <font class="comment">/* utility functions */</font> +00599 +00600 <font class="comment">/*</font> +00601 <font class="comment"> The following utility functions are implemented on top of the</font> +00602 <font class="comment"> basic stream-oriented functions. To simplify the interface, some</font> +00603 <font class="comment"> default options are assumed (compression level and memory usage,</font> +00604 <font class="comment"> standard memory allocation functions). The source code of these</font> +00605 <font class="comment"> utility functions can easily be modified if you need special options.</font> +00606 <font class="comment">*/</font> +00607 +00608 ZEXTERN <font class="keywordtype">int</font> ZEXPORT compress OF((Bytef *dest, uLongf *destLen, +00609 <font class="keyword">const</font> Bytef *source, uLong sourceLen)); +00610 <font class="comment">/*</font> +00611 <font class="comment"> Compresses the source buffer into the destination buffer. sourceLen is</font> +00612 <font class="comment"> the byte length of the source buffer. Upon entry, destLen is the total</font> +00613 <font class="comment"> size of the destination buffer, which must be at least 0.1% larger than</font> +00614 <font class="comment"> sourceLen plus 12 bytes. Upon exit, destLen is the actual size of the</font> +00615 <font class="comment"> compressed buffer.</font> +00616 <font class="comment"> This function can be used to compress a whole file at once if the</font> +00617 <font class="comment"> input file is mmap'ed.</font> +00618 <font class="comment"> compress returns Z_OK if success, Z_MEM_ERROR if there was not</font> +00619 <font class="comment"> enough memory, Z_BUF_ERROR if there was not enough room in the output</font> +00620 <font class="comment"> buffer.</font> +00621 <font class="comment">*/</font> +00622 +00623 ZEXTERN <font class="keywordtype">int</font> ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen, +00624 <font class="keyword">const</font> Bytef *source, uLong sourceLen, +00625 <font class="keywordtype">int</font> level)); +00626 <font class="comment">/*</font> +00627 <font class="comment"> Compresses the source buffer into the destination buffer. The level</font> +00628 <font class="comment"> parameter has the same meaning as in deflateInit. sourceLen is the byte</font> +00629 <font class="comment"> length of the source buffer. Upon entry, destLen is the total size of the</font> +00630 <font class="comment"> destination buffer, which must be at least 0.1% larger than sourceLen plus</font> +00631 <font class="comment"> 12 bytes. Upon exit, destLen is the actual size of the compressed buffer.</font> +00632 <font class="comment"></font> +00633 <font class="comment"> compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough</font> +00634 <font class="comment"> memory, Z_BUF_ERROR if there was not enough room in the output buffer,</font> +00635 <font class="comment"> Z_STREAM_ERROR if the level parameter is invalid.</font> +00636 <font class="comment">*/</font> +00637 +00638 ZEXTERN <font class="keywordtype">int</font> ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen, +00639 <font class="keyword">const</font> Bytef *source, uLong sourceLen)); +00640 <font class="comment">/*</font> +00641 <font class="comment"> Decompresses the source buffer into the destination buffer. sourceLen is</font> +00642 <font class="comment"> the byte length of the source buffer. Upon entry, destLen is the total</font> +00643 <font class="comment"> size of the destination buffer, which must be large enough to hold the</font> +00644 <font class="comment"> entire uncompressed data. (The size of the uncompressed data must have</font> +00645 <font class="comment"> been saved previously by the compressor and transmitted to the decompressor</font> +00646 <font class="comment"> by some mechanism outside the scope of this compression library.)</font> +00647 <font class="comment"> Upon exit, destLen is the actual size of the compressed buffer.</font> +00648 <font class="comment"> This function can be used to decompress a whole file at once if the</font> +00649 <font class="comment"> input file is mmap'ed.</font> +00650 <font class="comment"></font> +00651 <font class="comment"> uncompress returns Z_OK if success, Z_MEM_ERROR if there was not</font> +00652 <font class="comment"> enough memory, Z_BUF_ERROR if there was not enough room in the output</font> +00653 <font class="comment"> buffer, or Z_DATA_ERROR if the input data was corrupted.</font> +00654 <font class="comment">*/</font> +00655 +00656 +00657 <font class="keyword">typedef</font> voidp gzFile; +00658 +00659 ZEXTERN gzFile ZEXPORT gzopen OF((<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keyword">const</font> <font class="keywordtype">char</font> *mode)); +00660 <font class="comment">/*</font> +00661 <font class="comment"> Opens a gzip (.gz) file for reading or writing. The mode parameter</font> +00662 <font class="comment"> is as in fopen ("rb" or "wb") but can also include a compression level</font> +00663 <font class="comment"> ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for</font> +00664 <font class="comment"> Huffman only compression as in "wb1h". (See the description</font> +00665 <font class="comment"> of deflateInit2 for more information about the strategy parameter.)</font> +00666 <font class="comment"></font> +00667 <font class="comment"> gzopen can be used to read a file which is not in gzip format; in this</font> +00668 <font class="comment"> case gzread will directly read from the file without decompression.</font> +00669 <font class="comment"></font> +00670 <font class="comment"> gzopen returns NULL if the file could not be opened or if there was</font> +00671 <font class="comment"> insufficient memory to allocate the (de)compression state; errno</font> +00672 <font class="comment"> can be checked to distinguish the two cases (if errno is zero, the</font> +00673 <font class="comment"> zlib error is Z_MEM_ERROR). */</font> +00674 +00675 ZEXTERN gzFile ZEXPORT gzdopen OF((<font class="keywordtype">int</font> fd, <font class="keyword">const</font> <font class="keywordtype">char</font> *mode)); +00676 <font class="comment">/*</font> +00677 <font class="comment"> gzdopen() associates a gzFile with the file descriptor fd. File</font> +00678 <font class="comment"> descriptors are obtained from calls like open, dup, creat, pipe or</font> +00679 <font class="comment"> fileno (in the file has been previously opened with fopen).</font> +00680 <font class="comment"> The mode parameter is as in gzopen.</font> +00681 <font class="comment"> The next call of gzclose on the returned gzFile will also close the</font> +00682 <font class="comment"> file descriptor fd, just like fclose(fdopen(fd), mode) closes the file</font> +00683 <font class="comment"> descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode).</font> +00684 <font class="comment"> gzdopen returns NULL if there was insufficient memory to allocate</font> +00685 <font class="comment"> the (de)compression state.</font> +00686 <font class="comment">*/</font> +00687 +00688 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzsetparams OF((gzFile file, <font class="keywordtype">int</font> level, <font class="keywordtype">int</font> strategy)); +00689 <font class="comment">/*</font> +00690 <font class="comment"> Dynamically update the compression level or strategy. See the description</font> +00691 <font class="comment"> of deflateInit2 for the meaning of these parameters.</font> +00692 <font class="comment"> gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not</font> +00693 <font class="comment"> opened for writing.</font> +00694 <font class="comment">*/</font> +00695 +00696 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzread OF((gzFile file, voidp buf, <font class="keywordtype">unsigned</font> len)); +00697 <font class="comment">/*</font> +00698 <font class="comment"> Reads the given number of uncompressed bytes from the compressed file.</font> +00699 <font class="comment"> If the input file was not in gzip format, gzread copies the given number</font> +00700 <font class="comment"> of bytes into the buffer.</font> +00701 <font class="comment"> gzread returns the number of uncompressed bytes actually read (0 for</font> +00702 <font class="comment"> end of file, -1 for error). */</font> +00703 +00704 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzwrite OF((gzFile file, +00705 <font class="keyword">const</font> voidp buf, <font class="keywordtype">unsigned</font> len)); +00706 <font class="comment">/*</font> +00707 <font class="comment"> Writes the given number of uncompressed bytes into the compressed file.</font> +00708 <font class="comment"> gzwrite returns the number of uncompressed bytes actually written</font> +00709 <font class="comment"> (0 in case of error).</font> +00710 <font class="comment">*/</font> +00711 +00712 ZEXTERN <font class="keywordtype">int</font> ZEXPORTVA gzprintf OF((gzFile file, <font class="keyword">const</font> <font class="keywordtype">char</font> *format, ...)); +00713 <font class="comment">/*</font> +00714 <font class="comment"> Converts, formats, and writes the args to the compressed file under</font> +00715 <font class="comment"> control of the format string, as in fprintf. gzprintf returns the number of</font> +00716 <font class="comment"> uncompressed bytes actually written (0 in case of error).</font> +00717 <font class="comment">*/</font> +00718 +00719 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzputs OF((gzFile file, <font class="keyword">const</font> <font class="keywordtype">char</font> *s)); +00720 <font class="comment">/*</font> +00721 <font class="comment"> Writes the given null-terminated string to the compressed file, excluding</font> +00722 <font class="comment"> the terminating null character.</font> +00723 <font class="comment"> gzputs returns the number of characters written, or -1 in case of error.</font> +00724 <font class="comment">*/</font> +00725 +00726 ZEXTERN <font class="keywordtype">char</font> * ZEXPORT gzgets OF((gzFile file, <font class="keywordtype">char</font> *buf, <font class="keywordtype">int</font> len)); +00727 <font class="comment">/*</font> +00728 <font class="comment"> Reads bytes from the compressed file until len-1 characters are read, or</font> +00729 <font class="comment"> a newline character is read and transferred to buf, or an end-of-file</font> +00730 <font class="comment"> condition is encountered. The string is then terminated with a null</font> +00731 <font class="comment"> character.</font> +00732 <font class="comment"> gzgets returns buf, or Z_NULL in case of error.</font> +00733 <font class="comment">*/</font> +00734 +00735 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzputc OF((gzFile file, <font class="keywordtype">int</font> c)); +00736 <font class="comment">/*</font> +00737 <font class="comment"> Writes c, converted to an unsigned char, into the compressed file.</font> +00738 <font class="comment"> gzputc returns the value that was written, or -1 in case of error.</font> +00739 <font class="comment">*/</font> +00740 +00741 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzgetc OF((gzFile file)); +00742 <font class="comment">/*</font> +00743 <font class="comment"> Reads one byte from the compressed file. gzgetc returns this byte</font> +00744 <font class="comment"> or -1 in case of end of file or error.</font> +00745 <font class="comment">*/</font> +00746 +00747 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzflush OF((gzFile file, <font class="keywordtype">int</font> flush)); +00748 <font class="comment">/*</font> +00749 <font class="comment"> Flushes all pending output into the compressed file. The parameter</font> +00750 <font class="comment"> flush is as in the deflate() function. The return value is the zlib</font> +00751 <font class="comment"> error number (see function gzerror below). gzflush returns Z_OK if</font> +00752 <font class="comment"> the flush parameter is Z_FINISH and all output could be flushed.</font> +00753 <font class="comment"> gzflush should be called only when strictly necessary because it can</font> +00754 <font class="comment"> degrade compression.</font> +00755 <font class="comment">*/</font> +00756 +00757 ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file, +00758 z_off_t offset, <font class="keywordtype">int</font> whence)); +00759 <font class="comment">/* </font> +00760 <font class="comment"> Sets the starting position for the next gzread or gzwrite on the</font> +00761 <font class="comment"> given compressed file. The offset represents a number of bytes in the</font> +00762 <font class="comment"> uncompressed data stream. The whence parameter is defined as in lseek(2);</font> +00763 <font class="comment"> the value SEEK_END is not supported.</font> +00764 <font class="comment"> If the file is opened for reading, this function is emulated but can be</font> +00765 <font class="comment"> extremely slow. If the file is opened for writing, only forward seeks are</font> +00766 <font class="comment"> supported; gzseek then compresses a sequence of zeroes up to the new</font> +00767 <font class="comment"> starting position.</font> +00768 <font class="comment"></font> +00769 <font class="comment"> gzseek returns the resulting offset location as measured in bytes from</font> +00770 <font class="comment"> the beginning of the uncompressed stream, or -1 in case of error, in</font> +00771 <font class="comment"> particular if the file is opened for writing and the new starting position</font> +00772 <font class="comment"> would be before the current position.</font> +00773 <font class="comment">*/</font> +00774 +00775 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzrewind OF((gzFile file)); +00776 <font class="comment">/*</font> +00777 <font class="comment"> Rewinds the given file. This function is supported only for reading.</font> +00778 <font class="comment"></font> +00779 <font class="comment"> gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)</font> +00780 <font class="comment">*/</font> +00781 +00782 ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file)); +00783 <font class="comment">/*</font> +00784 <font class="comment"> Returns the starting position for the next gzread or gzwrite on the</font> +00785 <font class="comment"> given compressed file. This position represents a number of bytes in the</font> +00786 <font class="comment"> uncompressed data stream.</font> +00787 <font class="comment"></font> +00788 <font class="comment"> gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)</font> +00789 <font class="comment">*/</font> +00790 +00791 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzeof OF((gzFile file)); +00792 <font class="comment">/*</font> +00793 <font class="comment"> Returns 1 when EOF has previously been detected reading the given</font> +00794 <font class="comment"> input stream, otherwise zero.</font> +00795 <font class="comment">*/</font> +00796 +00797 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzclose OF((gzFile file)); +00798 <font class="comment">/*</font> +00799 <font class="comment"> Flushes all pending output if necessary, closes the compressed file</font> +00800 <font class="comment"> and deallocates all the (de)compression state. The return value is the zlib</font> +00801 <font class="comment"> error number (see function gzerror below).</font> +00802 <font class="comment">*/</font> +00803 +00804 ZEXTERN <font class="keyword">const</font> <font class="keywordtype">char</font> * ZEXPORT gzerror OF((gzFile file, <font class="keywordtype">int</font> *errnum)); +00805 <font class="comment">/*</font> +00806 <font class="comment"> Returns the error message for the last error which occurred on the</font> +00807 <font class="comment"> given compressed file. errnum is set to zlib error number. If an</font> +00808 <font class="comment"> error occurred in the file system and not in the compression library,</font> +00809 <font class="comment"> errnum is set to Z_ERRNO and the application may consult errno</font> +00810 <font class="comment"> to get the exact error code.</font> +00811 <font class="comment">*/</font> +00812 +00813 <font class="comment">/* checksum functions */</font> +00814 +00815 <font class="comment">/*</font> +00816 <font class="comment"> These functions are not related to compression but are exported</font> +00817 <font class="comment"> anyway because they might be useful in applications using the</font> +00818 <font class="comment"> compression library.</font> +00819 <font class="comment">*/</font> +00820 +00821 ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, <font class="keyword">const</font> Bytef *buf, uInt len)); +00822 +00823 <font class="comment">/*</font> +00824 <font class="comment"> Update a running Adler-32 checksum with the bytes buf[0..len-1] and</font> +00825 <font class="comment"> return the updated checksum. If buf is NULL, this function returns</font> +00826 <font class="comment"> the required initial value for the checksum.</font> +00827 <font class="comment"> An Adler-32 checksum is almost as reliable as a CRC32 but can be computed</font> +00828 <font class="comment"> much faster. Usage example:</font> +00829 <font class="comment"></font> +00830 <font class="comment"> uLong adler = adler32(0L, Z_NULL, 0);</font> +00831 <font class="comment"></font> +00832 <font class="comment"> while (read_buffer(buffer, length) != EOF) {</font> +00833 <font class="comment"> adler = adler32(adler, buffer, length);</font> +00834 <font class="comment"> }</font> +00835 <font class="comment"> if (adler != original_adler) error();</font> +00836 <font class="comment">*/</font> +00837 +00838 ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, <font class="keyword">const</font> Bytef *buf, uInt len)); +00839 <font class="comment">/*</font> +00840 <font class="comment"> Update a running crc with the bytes buf[0..len-1] and return the updated</font> +00841 <font class="comment"> crc. If buf is NULL, this function returns the required initial value</font> +00842 <font class="comment"> for the crc. Pre- and post-conditioning (one's complement) is performed</font> +00843 <font class="comment"> within this function so it shouldn't be done by the application.</font> +00844 <font class="comment"> Usage example:</font> +00845 <font class="comment"></font> +00846 <font class="comment"> uLong crc = crc32(0L, Z_NULL, 0);</font> +00847 <font class="comment"></font> +00848 <font class="comment"> while (read_buffer(buffer, length) != EOF) {</font> +00849 <font class="comment"> crc = crc32(crc, buffer, length);</font> +00850 <font class="comment"> }</font> +00851 <font class="comment"> if (crc != original_crc) error();</font> +00852 <font class="comment">*/</font> +00853 +00854 +00855 <font class="comment">/* various hacks, don't look :) */</font> +00856 +00857 <font class="comment">/* deflateInit and inflateInit are macros to allow checking the zlib version</font> +00858 <font class="comment"> * and the compiler's view of z_stream:</font> +00859 <font class="comment"> */</font> +00860 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateInit_ OF((z_streamp strm, <font class="keywordtype">int</font> level, +00861 <font class="keyword">const</font> <font class="keywordtype">char</font> *version, <font class="keywordtype">int</font> stream_size)); +00862 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateInit_ OF((z_streamp strm, +00863 <font class="keyword">const</font> <font class="keywordtype">char</font> *version, <font class="keywordtype">int</font> stream_size)); +00864 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateInit2_ OF((z_streamp strm, <font class="keywordtype">int</font> level, <font class="keywordtype">int</font> method, +00865 <font class="keywordtype">int</font> windowBits, <font class="keywordtype">int</font> memLevel, +00866 <font class="keywordtype">int</font> strategy, <font class="keyword">const</font> <font class="keywordtype">char</font> *version, +00867 <font class="keywordtype">int</font> stream_size)); +00868 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateInit2_ OF((z_streamp strm, <font class="keywordtype">int</font> windowBits, +00869 <font class="keyword">const</font> <font class="keywordtype">char</font> *version, <font class="keywordtype">int</font> stream_size)); +00870 <font class="preprocessor">#define deflateInit(strm, level) \</font> +00871 <font class="preprocessor"> deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))</font> +00872 <font class="preprocessor"></font><font class="preprocessor">#define inflateInit(strm) \</font> +00873 <font class="preprocessor"> inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream))</font> +00874 <font class="preprocessor"></font><font class="preprocessor">#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \</font> +00875 <font class="preprocessor"> deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\</font> +00876 <font class="preprocessor"> (strategy), ZLIB_VERSION, sizeof(z_stream))</font> +00877 <font class="preprocessor"></font><font class="preprocessor">#define inflateInit2(strm, windowBits) \</font> +00878 <font class="preprocessor"> inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))</font> +00879 <font class="preprocessor"></font> +00880 +00881 <font class="preprocessor">#if !defined(_Z_UTIL_H) && !defined(NO_DUMMY_DECL)</font> +00882 <font class="preprocessor"></font> <font class="keyword">struct </font>internal_state {<font class="keywordtype">int</font> dummy;}; <font class="comment">/* hack for buggy compilers */</font> +00883 <font class="preprocessor">#endif</font> +00884 <font class="preprocessor"></font> +00885 ZEXTERN <font class="keyword">const</font> <font class="keywordtype">char</font> * ZEXPORT zError OF((<font class="keywordtype">int</font> err)); +00886 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateSyncPoint OF((z_streamp z)); +00887 ZEXTERN <font class="keyword">const</font> uLongf * ZEXPORT get_crc_table OF((<font class="keywordtype">void</font>)); +00888 +00889 <font class="preprocessor">#ifdef __cplusplus</font> +00890 <font class="preprocessor"></font>} +00891 <font class="preprocessor">#endif</font> +00892 <font class="preprocessor"></font> +00893 <font class="preprocessor">#endif </font><font class="comment">/* _ZLIB_H */</font> +</pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zlib_h-source.html b/doc/api-documentation/html/zlib_h-source.html new file mode 100644 index 0000000..c23d24e --- /dev/null +++ b/doc/api-documentation/html/zlib_h-source.html @@ -0,0 +1,909 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>zlib.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zlib.h</h1><div class="fragment"><pre>00001 <font class="comment">/* zlib.h -- interface of the 'zlib' general purpose compression library</font> +00002 <font class="comment"> version 1.1.3, July 9th, 1998</font> +00003 <font class="comment"></font> +00004 <font class="comment"> Copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler</font> +00005 <font class="comment"></font> +00006 <font class="comment"> This software is provided 'as-is', without any express or implied</font> +00007 <font class="comment"> warranty. In no event will the authors be held liable for any damages</font> +00008 <font class="comment"> arising from the use of this software.</font> +00009 <font class="comment"></font> +00010 <font class="comment"> Permission is granted to anyone to use this software for any purpose,</font> +00011 <font class="comment"> including commercial applications, and to alter it and redistribute it</font> +00012 <font class="comment"> freely, subject to the following restrictions:</font> +00013 <font class="comment"></font> +00014 <font class="comment"> 1. The origin of this software must not be misrepresented; you must not</font> +00015 <font class="comment"> claim that you wrote the original software. If you use this software</font> +00016 <font class="comment"> in a product, an acknowledgment in the product documentation would be</font> +00017 <font class="comment"> appreciated but is not required.</font> +00018 <font class="comment"> 2. Altered source versions must be plainly marked as such, and must not be</font> +00019 <font class="comment"> misrepresented as being the original software.</font> +00020 <font class="comment"> 3. This notice may not be removed or altered from any source distribution.</font> +00021 <font class="comment"></font> +00022 <font class="comment"> Jean-loup Gailly Mark Adler</font> +00023 <font class="comment"> jloup@gzip.org madler@alumni.caltech.edu</font> +00024 <font class="comment"></font> +00025 <font class="comment"></font> +00026 <font class="comment"> The data format used by the zlib library is described by RFCs (Request for</font> +00027 <font class="comment"> Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt</font> +00028 <font class="comment"> (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).</font> +00029 <font class="comment">*/</font> +00030 +00031 <font class="preprocessor">#ifndef _ZLIB_H</font> +00032 <font class="preprocessor"></font><font class="preprocessor">#define _ZLIB_H</font> +00033 <font class="preprocessor"></font> +00034 <font class="preprocessor">#include "zconf.h"</font> +00035 +00036 <font class="preprocessor">#ifdef __cplusplus</font> +00037 <font class="preprocessor"></font><font class="keyword">extern</font> <font class="stringliteral">"C"</font> { +00038 <font class="preprocessor">#endif</font> +00039 <font class="preprocessor"></font> +00040 <font class="preprocessor">#define ZLIB_VERSION "1.1.3"</font> +00041 <font class="preprocessor"></font> +00042 <font class="comment">/* </font> +00043 <font class="comment"> The 'zlib' compression library provides in-memory compression and</font> +00044 <font class="comment"> decompression functions, including integrity checks of the uncompressed</font> +00045 <font class="comment"> data. This version of the library supports only one compression method</font> +00046 <font class="comment"> (deflation) but other algorithms will be added later and will have the same</font> +00047 <font class="comment"> stream interface.</font> +00048 <font class="comment"></font> +00049 <font class="comment"> Compression can be done in a single step if the buffers are large</font> +00050 <font class="comment"> enough (for example if an input file is mmap'ed), or can be done by</font> +00051 <font class="comment"> repeated calls of the compression function. In the latter case, the</font> +00052 <font class="comment"> application must provide more input and/or consume the output</font> +00053 <font class="comment"> (providing more output space) before each call.</font> +00054 <font class="comment"></font> +00055 <font class="comment"> The library also supports reading and writing files in gzip (.gz) format</font> +00056 <font class="comment"> with an interface similar to that of stdio.</font> +00057 <font class="comment"></font> +00058 <font class="comment"> The library does not install any signal handler. The decoder checks</font> +00059 <font class="comment"> the consistency of the compressed data, so the library should never</font> +00060 <font class="comment"> crash even in case of corrupted input.</font> +00061 <font class="comment">*/</font> +00062 +00063 <font class="keyword">typedef</font> voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); +00064 <font class="keyword">typedef</font> void (*free_func) OF((voidpf opaque, voidpf address)); +00065 +00066 <font class="keyword">struct </font>internal_state; +00067 +00068 <font class="keyword">typedef</font> <font class="keyword">struct </font>z_stream_s { +00069 Bytef *next_in; <font class="comment">/* next input byte */</font> +00070 uInt avail_in; <font class="comment">/* number of bytes available at next_in */</font> +00071 uLong total_in; <font class="comment">/* total nb of input bytes read so far */</font> +00072 +00073 Bytef *next_out; <font class="comment">/* next output byte should be put there */</font> +00074 uInt avail_out; <font class="comment">/* remaining free space at next_out */</font> +00075 uLong total_out; <font class="comment">/* total nb of bytes output so far */</font> +00076 +00077 <font class="keywordtype">char</font> *msg; <font class="comment">/* last error message, NULL if no error */</font> +00078 <font class="keyword">struct </font>internal_state FAR *state; <font class="comment">/* not visible by applications */</font> +00079 +00080 alloc_func zalloc; <font class="comment">/* used to allocate the internal state */</font> +00081 free_func zfree; <font class="comment">/* used to free the internal state */</font> +00082 voidpf opaque; <font class="comment">/* private data object passed to zalloc and zfree */</font> +00083 +00084 <font class="keywordtype">int</font> data_type; <font class="comment">/* best guess about the data type: ascii or binary */</font> +00085 uLong adler; <font class="comment">/* adler32 value of the uncompressed data */</font> +00086 uLong reserved; <font class="comment">/* reserved for future use */</font> +00087 } z_stream; +00088 +00089 <font class="keyword">typedef</font> z_stream FAR *z_streamp; +00090 +00091 <font class="comment">/*</font> +00092 <font class="comment"> The application must update next_in and avail_in when avail_in has</font> +00093 <font class="comment"> dropped to zero. It must update next_out and avail_out when avail_out</font> +00094 <font class="comment"> has dropped to zero. The application must initialize zalloc, zfree and</font> +00095 <font class="comment"> opaque before calling the init function. All other fields are set by the</font> +00096 <font class="comment"> compression library and must not be updated by the application.</font> +00097 <font class="comment"></font> +00098 <font class="comment"> The opaque value provided by the application will be passed as the first</font> +00099 <font class="comment"> parameter for calls of zalloc and zfree. This can be useful for custom</font> +00100 <font class="comment"> memory management. The compression library attaches no meaning to the</font> +00101 <font class="comment"> opaque value.</font> +00102 <font class="comment"></font> +00103 <font class="comment"> zalloc must return Z_NULL if there is not enough memory for the object.</font> +00104 <font class="comment"> If zlib is used in a multi-threaded application, zalloc and zfree must be</font> +00105 <font class="comment"> thread safe.</font> +00106 <font class="comment"></font> +00107 <font class="comment"> On 16-bit systems, the functions zalloc and zfree must be able to allocate</font> +00108 <font class="comment"> exactly 65536 bytes, but will not be required to allocate more than this</font> +00109 <font class="comment"> if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,</font> +00110 <font class="comment"> pointers returned by zalloc for objects of exactly 65536 bytes *must*</font> +00111 <font class="comment"> have their offset normalized to zero. The default allocation function</font> +00112 <font class="comment"> provided by this library ensures this (see zutil.c). To reduce memory</font> +00113 <font class="comment"> requirements and avoid any allocation of 64K objects, at the expense of</font> +00114 <font class="comment"> compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).</font> +00115 <font class="comment"></font> +00116 <font class="comment"> The fields total_in and total_out can be used for statistics or</font> +00117 <font class="comment"> progress reports. After compression, total_in holds the total size of</font> +00118 <font class="comment"> the uncompressed data and may be saved for use in the decompressor</font> +00119 <font class="comment"> (particularly if the decompressor wants to decompress everything in</font> +00120 <font class="comment"> a single step).</font> +00121 <font class="comment">*/</font> +00122 +00123 <font class="comment">/* constants */</font> +00124 +00125 <font class="preprocessor">#define Z_NO_FLUSH 0</font> +00126 <font class="preprocessor"></font><font class="preprocessor">#define Z_PARTIAL_FLUSH 1 </font><font class="comment">/* will be removed, use Z_SYNC_FLUSH instead */</font> +00127 <font class="preprocessor">#define Z_SYNC_FLUSH 2</font> +00128 <font class="preprocessor"></font><font class="preprocessor">#define Z_FULL_FLUSH 3</font> +00129 <font class="preprocessor"></font><font class="preprocessor">#define Z_FINISH 4</font> +00130 <font class="preprocessor"></font><font class="comment">/* Allowed flush values; see deflate() below for details */</font> +00131 +00132 <font class="preprocessor">#define Z_OK 0</font> +00133 <font class="preprocessor"></font><font class="preprocessor">#define Z_STREAM_END 1</font> +00134 <font class="preprocessor"></font><font class="preprocessor">#define Z_NEED_DICT 2</font> +00135 <font class="preprocessor"></font><font class="preprocessor">#define Z_ERRNO (-1)</font> +00136 <font class="preprocessor"></font><font class="preprocessor">#define Z_STREAM_ERROR (-2)</font> +00137 <font class="preprocessor"></font><font class="preprocessor">#define Z_DATA_ERROR (-3)</font> +00138 <font class="preprocessor"></font><font class="preprocessor">#define Z_MEM_ERROR (-4)</font> +00139 <font class="preprocessor"></font><font class="preprocessor">#define Z_BUF_ERROR (-5)</font> +00140 <font class="preprocessor"></font><font class="preprocessor">#define Z_VERSION_ERROR (-6)</font> +00141 <font class="preprocessor"></font><font class="comment">/* Return codes for the compression/decompression functions. Negative</font> +00142 <font class="comment"> * values are errors, positive values are used for special but normal events.</font> +00143 <font class="comment"> */</font> +00144 +00145 <font class="preprocessor">#define Z_NO_COMPRESSION 0</font> +00146 <font class="preprocessor"></font><font class="preprocessor">#define Z_BEST_SPEED 1</font> +00147 <font class="preprocessor"></font><font class="preprocessor">#define Z_BEST_COMPRESSION 9</font> +00148 <font class="preprocessor"></font><font class="preprocessor">#define Z_DEFAULT_COMPRESSION (-1)</font> +00149 <font class="preprocessor"></font><font class="comment">/* compression levels */</font> +00150 +00151 <font class="preprocessor">#define Z_FILTERED 1</font> +00152 <font class="preprocessor"></font><font class="preprocessor">#define Z_HUFFMAN_ONLY 2</font> +00153 <font class="preprocessor"></font><font class="preprocessor">#define Z_DEFAULT_STRATEGY 0</font> +00154 <font class="preprocessor"></font><font class="comment">/* compression strategy; see deflateInit2() below for details */</font> +00155 +00156 <font class="preprocessor">#define Z_BINARY 0</font> +00157 <font class="preprocessor"></font><font class="preprocessor">#define Z_ASCII 1</font> +00158 <font class="preprocessor"></font><font class="preprocessor">#define Z_UNKNOWN 2</font> +00159 <font class="preprocessor"></font><font class="comment">/* Possible values of the data_type field */</font> +00160 +00161 <font class="preprocessor">#define Z_DEFLATED 8</font> +00162 <font class="preprocessor"></font><font class="comment">/* The deflate compression method (the only one supported in this version) */</font> +00163 +00164 <font class="preprocessor">#define Z_NULL 0 </font><font class="comment">/* for initializing zalloc, zfree, opaque */</font> +00165 +00166 <font class="preprocessor">#define zlib_version zlibVersion()</font> +00167 <font class="preprocessor"></font><font class="comment">/* for compatibility with versions < 1.0.2 */</font> +00168 +00169 <font class="comment">/* basic functions */</font> +00170 +00171 ZEXTERN <font class="keyword">const</font> <font class="keywordtype">char</font> * ZEXPORT zlibVersion OF((<font class="keywordtype">void</font>)); +00172 <font class="comment">/* The application can compare zlibVersion and ZLIB_VERSION for consistency.</font> +00173 <font class="comment"> If the first character differs, the library code actually used is</font> +00174 <font class="comment"> not compatible with the zlib.h header file used by the application.</font> +00175 <font class="comment"> This check is automatically made by deflateInit and inflateInit.</font> +00176 <font class="comment"> */</font> +00177 +00178 <font class="comment">/* </font> +00179 <font class="comment">ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));</font> +00180 <font class="comment"></font> +00181 <font class="comment"> Initializes the internal stream state for compression. The fields</font> +00182 <font class="comment"> zalloc, zfree and opaque must be initialized before by the caller.</font> +00183 <font class="comment"> If zalloc and zfree are set to Z_NULL, deflateInit updates them to</font> +00184 <font class="comment"> use default allocation functions.</font> +00185 <font class="comment"></font> +00186 <font class="comment"> The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:</font> +00187 <font class="comment"> 1 gives best speed, 9 gives best compression, 0 gives no compression at</font> +00188 <font class="comment"> all (the input data is simply copied a block at a time).</font> +00189 <font class="comment"> Z_DEFAULT_COMPRESSION requests a default compromise between speed and</font> +00190 <font class="comment"> compression (currently equivalent to level 6).</font> +00191 <font class="comment"></font> +00192 <font class="comment"> deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not</font> +00193 <font class="comment"> enough memory, Z_STREAM_ERROR if level is not a valid compression level,</font> +00194 <font class="comment"> Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible</font> +00195 <font class="comment"> with the version assumed by the caller (ZLIB_VERSION).</font> +00196 <font class="comment"> msg is set to null if there is no error message. deflateInit does not</font> +00197 <font class="comment"> perform any compression: this will be done by deflate().</font> +00198 <font class="comment">*/</font> +00199 +00200 +00201 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflate OF((z_streamp strm, <font class="keywordtype">int</font> flush)); +00202 <font class="comment">/*</font> +00203 <font class="comment"> deflate compresses as much data as possible, and stops when the input</font> +00204 <font class="comment"> buffer becomes empty or the output buffer becomes full. It may introduce some</font> +00205 <font class="comment"> output latency (reading input without producing any output) except when</font> +00206 <font class="comment"> forced to flush.</font> +00207 <font class="comment"></font> +00208 <font class="comment"> The detailed semantics are as follows. deflate performs one or both of the</font> +00209 <font class="comment"> following actions:</font> +00210 <font class="comment"></font> +00211 <font class="comment"> - Compress more input starting at next_in and update next_in and avail_in</font> +00212 <font class="comment"> accordingly. If not all input can be processed (because there is not</font> +00213 <font class="comment"> enough room in the output buffer), next_in and avail_in are updated and</font> +00214 <font class="comment"> processing will resume at this point for the next call of deflate().</font> +00215 <font class="comment"></font> +00216 <font class="comment"> - Provide more output starting at next_out and update next_out and avail_out</font> +00217 <font class="comment"> accordingly. This action is forced if the parameter flush is non zero.</font> +00218 <font class="comment"> Forcing flush frequently degrades the compression ratio, so this parameter</font> +00219 <font class="comment"> should be set only when necessary (in interactive applications).</font> +00220 <font class="comment"> Some output may be provided even if flush is not set.</font> +00221 <font class="comment"></font> +00222 <font class="comment"> Before the call of deflate(), the application should ensure that at least</font> +00223 <font class="comment"> one of the actions is possible, by providing more input and/or consuming</font> +00224 <font class="comment"> more output, and updating avail_in or avail_out accordingly; avail_out</font> +00225 <font class="comment"> should never be zero before the call. The application can consume the</font> +00226 <font class="comment"> compressed output when it wants, for example when the output buffer is full</font> +00227 <font class="comment"> (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK</font> +00228 <font class="comment"> and with zero avail_out, it must be called again after making room in the</font> +00229 <font class="comment"> output buffer because there might be more output pending.</font> +00230 <font class="comment"></font> +00231 <font class="comment"> If the parameter flush is set to Z_SYNC_FLUSH, all pending output is</font> +00232 <font class="comment"> flushed to the output buffer and the output is aligned on a byte boundary, so</font> +00233 <font class="comment"> that the decompressor can get all input data available so far. (In particular</font> +00234 <font class="comment"> avail_in is zero after the call if enough output space has been provided</font> +00235 <font class="comment"> before the call.) Flushing may degrade compression for some compression</font> +00236 <font class="comment"> algorithms and so it should be used only when necessary.</font> +00237 <font class="comment"></font> +00238 <font class="comment"> If flush is set to Z_FULL_FLUSH, all output is flushed as with</font> +00239 <font class="comment"> Z_SYNC_FLUSH, and the compression state is reset so that decompression can</font> +00240 <font class="comment"> restart from this point if previous compressed data has been damaged or if</font> +00241 <font class="comment"> random access is desired. Using Z_FULL_FLUSH too often can seriously degrade</font> +00242 <font class="comment"> the compression.</font> +00243 <font class="comment"></font> +00244 <font class="comment"> If deflate returns with avail_out == 0, this function must be called again</font> +00245 <font class="comment"> with the same value of the flush parameter and more output space (updated</font> +00246 <font class="comment"> avail_out), until the flush is complete (deflate returns with non-zero</font> +00247 <font class="comment"> avail_out).</font> +00248 <font class="comment"></font> +00249 <font class="comment"> If the parameter flush is set to Z_FINISH, pending input is processed,</font> +00250 <font class="comment"> pending output is flushed and deflate returns with Z_STREAM_END if there</font> +00251 <font class="comment"> was enough output space; if deflate returns with Z_OK, this function must be</font> +00252 <font class="comment"> called again with Z_FINISH and more output space (updated avail_out) but no</font> +00253 <font class="comment"> more input data, until it returns with Z_STREAM_END or an error. After</font> +00254 <font class="comment"> deflate has returned Z_STREAM_END, the only possible operations on the</font> +00255 <font class="comment"> stream are deflateReset or deflateEnd.</font> +00256 <font class="comment"> </font> +00257 <font class="comment"> Z_FINISH can be used immediately after deflateInit if all the compression</font> +00258 <font class="comment"> is to be done in a single step. In this case, avail_out must be at least</font> +00259 <font class="comment"> 0.1% larger than avail_in plus 12 bytes. If deflate does not return</font> +00260 <font class="comment"> Z_STREAM_END, then it must be called again as described above.</font> +00261 <font class="comment"></font> +00262 <font class="comment"> deflate() sets strm->adler to the adler32 checksum of all input read</font> +00263 <font class="comment"> so far (that is, total_in bytes).</font> +00264 <font class="comment"></font> +00265 <font class="comment"> deflate() may update data_type if it can make a good guess about</font> +00266 <font class="comment"> the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered</font> +00267 <font class="comment"> binary. This field is only for information purposes and does not affect</font> +00268 <font class="comment"> the compression algorithm in any manner.</font> +00269 <font class="comment"></font> +00270 <font class="comment"> deflate() returns Z_OK if some progress has been made (more input</font> +00271 <font class="comment"> processed or more output produced), Z_STREAM_END if all input has been</font> +00272 <font class="comment"> consumed and all output has been produced (only when flush is set to</font> +00273 <font class="comment"> Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example</font> +00274 <font class="comment"> if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible</font> +00275 <font class="comment"> (for example avail_in or avail_out was zero).</font> +00276 <font class="comment">*/</font> +00277 +00278 +00279 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateEnd OF((z_streamp strm)); +00280 <font class="comment">/*</font> +00281 <font class="comment"> All dynamically allocated data structures for this stream are freed.</font> +00282 <font class="comment"> This function discards any unprocessed input and does not flush any</font> +00283 <font class="comment"> pending output.</font> +00284 <font class="comment"></font> +00285 <font class="comment"> deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the</font> +00286 <font class="comment"> stream state was inconsistent, Z_DATA_ERROR if the stream was freed</font> +00287 <font class="comment"> prematurely (some input or output was discarded). In the error case,</font> +00288 <font class="comment"> msg may be set but then points to a static string (which must not be</font> +00289 <font class="comment"> deallocated).</font> +00290 <font class="comment">*/</font> +00291 +00292 +00293 <font class="comment">/* </font> +00294 <font class="comment">ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));</font> +00295 <font class="comment"></font> +00296 <font class="comment"> Initializes the internal stream state for decompression. The fields</font> +00297 <font class="comment"> next_in, avail_in, zalloc, zfree and opaque must be initialized before by</font> +00298 <font class="comment"> the caller. If next_in is not Z_NULL and avail_in is large enough (the exact</font> +00299 <font class="comment"> value depends on the compression method), inflateInit determines the</font> +00300 <font class="comment"> compression method from the zlib header and allocates all data structures</font> +00301 <font class="comment"> accordingly; otherwise the allocation will be deferred to the first call of</font> +00302 <font class="comment"> inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to</font> +00303 <font class="comment"> use default allocation functions.</font> +00304 <font class="comment"></font> +00305 <font class="comment"> inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough</font> +00306 <font class="comment"> memory, Z_VERSION_ERROR if the zlib library version is incompatible with the</font> +00307 <font class="comment"> version assumed by the caller. msg is set to null if there is no error</font> +00308 <font class="comment"> message. inflateInit does not perform any decompression apart from reading</font> +00309 <font class="comment"> the zlib header if present: this will be done by inflate(). (So next_in and</font> +00310 <font class="comment"> avail_in may be modified, but next_out and avail_out are unchanged.)</font> +00311 <font class="comment">*/</font> +00312 +00313 +00314 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflate OF((z_streamp strm, <font class="keywordtype">int</font> flush)); +00315 <font class="comment">/*</font> +00316 <font class="comment"> inflate decompresses as much data as possible, and stops when the input</font> +00317 <font class="comment"> buffer becomes empty or the output buffer becomes full. It may some</font> +00318 <font class="comment"> introduce some output latency (reading input without producing any output)</font> +00319 <font class="comment"> except when forced to flush.</font> +00320 <font class="comment"></font> +00321 <font class="comment"> The detailed semantics are as follows. inflate performs one or both of the</font> +00322 <font class="comment"> following actions:</font> +00323 <font class="comment"></font> +00324 <font class="comment"> - Decompress more input starting at next_in and update next_in and avail_in</font> +00325 <font class="comment"> accordingly. If not all input can be processed (because there is not</font> +00326 <font class="comment"> enough room in the output buffer), next_in is updated and processing</font> +00327 <font class="comment"> will resume at this point for the next call of inflate().</font> +00328 <font class="comment"></font> +00329 <font class="comment"> - Provide more output starting at next_out and update next_out and avail_out</font> +00330 <font class="comment"> accordingly. inflate() provides as much output as possible, until there</font> +00331 <font class="comment"> is no more input data or no more space in the output buffer (see below</font> +00332 <font class="comment"> about the flush parameter).</font> +00333 <font class="comment"></font> +00334 <font class="comment"> Before the call of inflate(), the application should ensure that at least</font> +00335 <font class="comment"> one of the actions is possible, by providing more input and/or consuming</font> +00336 <font class="comment"> more output, and updating the next_* and avail_* values accordingly.</font> +00337 <font class="comment"> The application can consume the uncompressed output when it wants, for</font> +00338 <font class="comment"> example when the output buffer is full (avail_out == 0), or after each</font> +00339 <font class="comment"> call of inflate(). If inflate returns Z_OK and with zero avail_out, it</font> +00340 <font class="comment"> must be called again after making room in the output buffer because there</font> +00341 <font class="comment"> might be more output pending.</font> +00342 <font class="comment"></font> +00343 <font class="comment"> If the parameter flush is set to Z_SYNC_FLUSH, inflate flushes as much</font> +00344 <font class="comment"> output as possible to the output buffer. The flushing behavior of inflate is</font> +00345 <font class="comment"> not specified for values of the flush parameter other than Z_SYNC_FLUSH</font> +00346 <font class="comment"> and Z_FINISH, but the current implementation actually flushes as much output</font> +00347 <font class="comment"> as possible anyway.</font> +00348 <font class="comment"></font> +00349 <font class="comment"> inflate() should normally be called until it returns Z_STREAM_END or an</font> +00350 <font class="comment"> error. However if all decompression is to be performed in a single step</font> +00351 <font class="comment"> (a single call of inflate), the parameter flush should be set to</font> +00352 <font class="comment"> Z_FINISH. In this case all pending input is processed and all pending</font> +00353 <font class="comment"> output is flushed; avail_out must be large enough to hold all the</font> +00354 <font class="comment"> uncompressed data. (The size of the uncompressed data may have been saved</font> +00355 <font class="comment"> by the compressor for this purpose.) The next operation on this stream must</font> +00356 <font class="comment"> be inflateEnd to deallocate the decompression state. The use of Z_FINISH</font> +00357 <font class="comment"> is never required, but can be used to inform inflate that a faster routine</font> +00358 <font class="comment"> may be used for the single inflate() call.</font> +00359 <font class="comment"></font> +00360 <font class="comment"> If a preset dictionary is needed at this point (see inflateSetDictionary</font> +00361 <font class="comment"> below), inflate sets strm-adler to the adler32 checksum of the</font> +00362 <font class="comment"> dictionary chosen by the compressor and returns Z_NEED_DICT; otherwise </font> +00363 <font class="comment"> it sets strm->adler to the adler32 checksum of all output produced</font> +00364 <font class="comment"> so far (that is, total_out bytes) and returns Z_OK, Z_STREAM_END or</font> +00365 <font class="comment"> an error code as described below. At the end of the stream, inflate()</font> +00366 <font class="comment"> checks that its computed adler32 checksum is equal to that saved by the</font> +00367 <font class="comment"> compressor and returns Z_STREAM_END only if the checksum is correct.</font> +00368 <font class="comment"></font> +00369 <font class="comment"> inflate() returns Z_OK if some progress has been made (more input processed</font> +00370 <font class="comment"> or more output produced), Z_STREAM_END if the end of the compressed data has</font> +00371 <font class="comment"> been reached and all uncompressed output has been produced, Z_NEED_DICT if a</font> +00372 <font class="comment"> preset dictionary is needed at this point, Z_DATA_ERROR if the input data was</font> +00373 <font class="comment"> corrupted (input stream not conforming to the zlib format or incorrect</font> +00374 <font class="comment"> adler32 checksum), Z_STREAM_ERROR if the stream structure was inconsistent</font> +00375 <font class="comment"> (for example if next_in or next_out was NULL), Z_MEM_ERROR if there was not</font> +00376 <font class="comment"> enough memory, Z_BUF_ERROR if no progress is possible or if there was not</font> +00377 <font class="comment"> enough room in the output buffer when Z_FINISH is used. In the Z_DATA_ERROR</font> +00378 <font class="comment"> case, the application may then call inflateSync to look for a good</font> +00379 <font class="comment"> compression block.</font> +00380 <font class="comment">*/</font> +00381 +00382 +00383 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateEnd OF((z_streamp strm)); +00384 <font class="comment">/*</font> +00385 <font class="comment"> All dynamically allocated data structures for this stream are freed.</font> +00386 <font class="comment"> This function discards any unprocessed input and does not flush any</font> +00387 <font class="comment"> pending output.</font> +00388 <font class="comment"></font> +00389 <font class="comment"> inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state</font> +00390 <font class="comment"> was inconsistent. In the error case, msg may be set but then points to a</font> +00391 <font class="comment"> static string (which must not be deallocated).</font> +00392 <font class="comment">*/</font> +00393 +00394 <font class="comment">/* Advanced functions */</font> +00395 +00396 <font class="comment">/*</font> +00397 <font class="comment"> The following functions are needed only in some special applications.</font> +00398 <font class="comment">*/</font> +00399 +00400 <font class="comment">/* </font> +00401 <font class="comment">ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,</font> +00402 <font class="comment"> int level,</font> +00403 <font class="comment"> int method,</font> +00404 <font class="comment"> int windowBits,</font> +00405 <font class="comment"> int memLevel,</font> +00406 <font class="comment"> int strategy));</font> +00407 <font class="comment"></font> +00408 <font class="comment"> This is another version of deflateInit with more compression options. The</font> +00409 <font class="comment"> fields next_in, zalloc, zfree and opaque must be initialized before by</font> +00410 <font class="comment"> the caller.</font> +00411 <font class="comment"></font> +00412 <font class="comment"> The method parameter is the compression method. It must be Z_DEFLATED in</font> +00413 <font class="comment"> this version of the library.</font> +00414 <font class="comment"></font> +00415 <font class="comment"> The windowBits parameter is the base two logarithm of the window size</font> +00416 <font class="comment"> (the size of the history buffer). It should be in the range 8..15 for this</font> +00417 <font class="comment"> version of the library. Larger values of this parameter result in better</font> +00418 <font class="comment"> compression at the expense of memory usage. The default value is 15 if</font> +00419 <font class="comment"> deflateInit is used instead.</font> +00420 <font class="comment"></font> +00421 <font class="comment"> The memLevel parameter specifies how much memory should be allocated</font> +00422 <font class="comment"> for the internal compression state. memLevel=1 uses minimum memory but</font> +00423 <font class="comment"> is slow and reduces compression ratio; memLevel=9 uses maximum memory</font> +00424 <font class="comment"> for optimal speed. The default value is 8. See zconf.h for total memory</font> +00425 <font class="comment"> usage as a function of windowBits and memLevel.</font> +00426 <font class="comment"></font> +00427 <font class="comment"> The strategy parameter is used to tune the compression algorithm. Use the</font> +00428 <font class="comment"> value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a</font> +00429 <font class="comment"> filter (or predictor), or Z_HUFFMAN_ONLY to force Huffman encoding only (no</font> +00430 <font class="comment"> string match). Filtered data consists mostly of small values with a</font> +00431 <font class="comment"> somewhat random distribution. In this case, the compression algorithm is</font> +00432 <font class="comment"> tuned to compress them better. The effect of Z_FILTERED is to force more</font> +00433 <font class="comment"> Huffman coding and less string matching; it is somewhat intermediate</font> +00434 <font class="comment"> between Z_DEFAULT and Z_HUFFMAN_ONLY. The strategy parameter only affects</font> +00435 <font class="comment"> the compression ratio but not the correctness of the compressed output even</font> +00436 <font class="comment"> if it is not set appropriately.</font> +00437 <font class="comment"></font> +00438 <font class="comment"> deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough</font> +00439 <font class="comment"> memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid</font> +00440 <font class="comment"> method). msg is set to null if there is no error message. deflateInit2 does</font> +00441 <font class="comment"> not perform any compression: this will be done by deflate().</font> +00442 <font class="comment">*/</font> +00443 +00444 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateSetDictionary OF((z_streamp strm, +00445 <font class="keyword">const</font> Bytef *dictionary, +00446 uInt dictLength)); +00447 <font class="comment">/*</font> +00448 <font class="comment"> Initializes the compression dictionary from the given byte sequence</font> +00449 <font class="comment"> without producing any compressed output. This function must be called</font> +00450 <font class="comment"> immediately after deflateInit, deflateInit2 or deflateReset, before any</font> +00451 <font class="comment"> call of deflate. The compressor and decompressor must use exactly the same</font> +00452 <font class="comment"> dictionary (see inflateSetDictionary).</font> +00453 <font class="comment"></font> +00454 <font class="comment"> The dictionary should consist of strings (byte sequences) that are likely</font> +00455 <font class="comment"> to be encountered later in the data to be compressed, with the most commonly</font> +00456 <font class="comment"> used strings preferably put towards the end of the dictionary. Using a</font> +00457 <font class="comment"> dictionary is most useful when the data to be compressed is short and can be</font> +00458 <font class="comment"> predicted with good accuracy; the data can then be compressed better than</font> +00459 <font class="comment"> with the default empty dictionary.</font> +00460 <font class="comment"></font> +00461 <font class="comment"> Depending on the size of the compression data structures selected by</font> +00462 <font class="comment"> deflateInit or deflateInit2, a part of the dictionary may in effect be</font> +00463 <font class="comment"> discarded, for example if the dictionary is larger than the window size in</font> +00464 <font class="comment"> deflate or deflate2. Thus the strings most likely to be useful should be</font> +00465 <font class="comment"> put at the end of the dictionary, not at the front.</font> +00466 <font class="comment"></font> +00467 <font class="comment"> Upon return of this function, strm->adler is set to the Adler32 value</font> +00468 <font class="comment"> of the dictionary; the decompressor may later use this value to determine</font> +00469 <font class="comment"> which dictionary has been used by the compressor. (The Adler32 value</font> +00470 <font class="comment"> applies to the whole dictionary even if only a subset of the dictionary is</font> +00471 <font class="comment"> actually used by the compressor.)</font> +00472 <font class="comment"></font> +00473 <font class="comment"> deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a</font> +00474 <font class="comment"> parameter is invalid (such as NULL dictionary) or the stream state is</font> +00475 <font class="comment"> inconsistent (for example if deflate has already been called for this stream</font> +00476 <font class="comment"> or if the compression method is bsort). deflateSetDictionary does not</font> +00477 <font class="comment"> perform any compression: this will be done by deflate().</font> +00478 <font class="comment">*/</font> +00479 +00480 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateCopy OF((z_streamp dest, +00481 z_streamp source)); +00482 <font class="comment">/*</font> +00483 <font class="comment"> Sets the destination stream as a complete copy of the source stream.</font> +00484 <font class="comment"></font> +00485 <font class="comment"> This function can be useful when several compression strategies will be</font> +00486 <font class="comment"> tried, for example when there are several ways of pre-processing the input</font> +00487 <font class="comment"> data with a filter. The streams that will be discarded should then be freed</font> +00488 <font class="comment"> by calling deflateEnd. Note that deflateCopy duplicates the internal</font> +00489 <font class="comment"> compression state which can be quite large, so this strategy is slow and</font> +00490 <font class="comment"> can consume lots of memory.</font> +00491 <font class="comment"></font> +00492 <font class="comment"> deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not</font> +00493 <font class="comment"> enough memory, Z_STREAM_ERROR if the source stream state was inconsistent</font> +00494 <font class="comment"> (such as zalloc being NULL). msg is left unchanged in both source and</font> +00495 <font class="comment"> destination.</font> +00496 <font class="comment">*/</font> +00497 +00498 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateReset OF((z_streamp strm)); +00499 <font class="comment">/*</font> +00500 <font class="comment"> This function is equivalent to deflateEnd followed by deflateInit,</font> +00501 <font class="comment"> but does not free and reallocate all the internal compression state.</font> +00502 <font class="comment"> The stream will keep the same compression level and any other attributes</font> +00503 <font class="comment"> that may have been set by deflateInit2.</font> +00504 <font class="comment"></font> +00505 <font class="comment"> deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source</font> +00506 <font class="comment"> stream state was inconsistent (such as zalloc or state being NULL).</font> +00507 <font class="comment">*/</font> +00508 +00509 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateParams OF((z_streamp strm, +00510 <font class="keywordtype">int</font> level, +00511 <font class="keywordtype">int</font> strategy)); +00512 <font class="comment">/*</font> +00513 <font class="comment"> Dynamically update the compression level and compression strategy. The</font> +00514 <font class="comment"> interpretation of level and strategy is as in deflateInit2. This can be</font> +00515 <font class="comment"> used to switch between compression and straight copy of the input data, or</font> +00516 <font class="comment"> to switch to a different kind of input data requiring a different</font> +00517 <font class="comment"> strategy. If the compression level is changed, the input available so far</font> +00518 <font class="comment"> is compressed with the old level (and may be flushed); the new level will</font> +00519 <font class="comment"> take effect only at the next call of deflate().</font> +00520 <font class="comment"></font> +00521 <font class="comment"> Before the call of deflateParams, the stream state must be set as for</font> +00522 <font class="comment"> a call of deflate(), since the currently available input may have to</font> +00523 <font class="comment"> be compressed and flushed. In particular, strm->avail_out must be non-zero.</font> +00524 <font class="comment"></font> +00525 <font class="comment"> deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source</font> +00526 <font class="comment"> stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR</font> +00527 <font class="comment"> if strm->avail_out was zero.</font> +00528 <font class="comment">*/</font> +00529 +00530 <font class="comment">/* </font> +00531 <font class="comment">ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,</font> +00532 <font class="comment"> int windowBits));</font> +00533 <font class="comment"></font> +00534 <font class="comment"> This is another version of inflateInit with an extra parameter. The</font> +00535 <font class="comment"> fields next_in, avail_in, zalloc, zfree and opaque must be initialized</font> +00536 <font class="comment"> before by the caller.</font> +00537 <font class="comment"></font> +00538 <font class="comment"> The windowBits parameter is the base two logarithm of the maximum window</font> +00539 <font class="comment"> size (the size of the history buffer). It should be in the range 8..15 for</font> +00540 <font class="comment"> this version of the library. The default value is 15 if inflateInit is used</font> +00541 <font class="comment"> instead. If a compressed stream with a larger window size is given as</font> +00542 <font class="comment"> input, inflate() will return with the error code Z_DATA_ERROR instead of</font> +00543 <font class="comment"> trying to allocate a larger window.</font> +00544 <font class="comment"></font> +00545 <font class="comment"> inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough</font> +00546 <font class="comment"> memory, Z_STREAM_ERROR if a parameter is invalid (such as a negative</font> +00547 <font class="comment"> memLevel). msg is set to null if there is no error message. inflateInit2</font> +00548 <font class="comment"> does not perform any decompression apart from reading the zlib header if</font> +00549 <font class="comment"> present: this will be done by inflate(). (So next_in and avail_in may be</font> +00550 <font class="comment"> modified, but next_out and avail_out are unchanged.)</font> +00551 <font class="comment">*/</font> +00552 +00553 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateSetDictionary OF((z_streamp strm, +00554 <font class="keyword">const</font> Bytef *dictionary, +00555 uInt dictLength)); +00556 <font class="comment">/*</font> +00557 <font class="comment"> Initializes the decompression dictionary from the given uncompressed byte</font> +00558 <font class="comment"> sequence. This function must be called immediately after a call of inflate</font> +00559 <font class="comment"> if this call returned Z_NEED_DICT. The dictionary chosen by the compressor</font> +00560 <font class="comment"> can be determined from the Adler32 value returned by this call of</font> +00561 <font class="comment"> inflate. The compressor and decompressor must use exactly the same</font> +00562 <font class="comment"> dictionary (see deflateSetDictionary).</font> +00563 <font class="comment"></font> +00564 <font class="comment"> inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a</font> +00565 <font class="comment"> parameter is invalid (such as NULL dictionary) or the stream state is</font> +00566 <font class="comment"> inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the</font> +00567 <font class="comment"> expected one (incorrect Adler32 value). inflateSetDictionary does not</font> +00568 <font class="comment"> perform any decompression: this will be done by subsequent calls of</font> +00569 <font class="comment"> inflate().</font> +00570 <font class="comment">*/</font> +00571 +00572 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateSync OF((z_streamp strm)); +00573 <font class="comment">/* </font> +00574 <font class="comment"> Skips invalid compressed data until a full flush point (see above the</font> +00575 <font class="comment"> description of deflate with Z_FULL_FLUSH) can be found, or until all</font> +00576 <font class="comment"> available input is skipped. No output is provided.</font> +00577 <font class="comment"></font> +00578 <font class="comment"> inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR</font> +00579 <font class="comment"> if no more input was provided, Z_DATA_ERROR if no flush point has been found,</font> +00580 <font class="comment"> or Z_STREAM_ERROR if the stream structure was inconsistent. In the success</font> +00581 <font class="comment"> case, the application may save the current current value of total_in which</font> +00582 <font class="comment"> indicates where valid compressed data was found. In the error case, the</font> +00583 <font class="comment"> application may repeatedly call inflateSync, providing more input each time,</font> +00584 <font class="comment"> until success or end of the input data.</font> +00585 <font class="comment">*/</font> +00586 +00587 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateReset OF((z_streamp strm)); +00588 <font class="comment">/*</font> +00589 <font class="comment"> This function is equivalent to inflateEnd followed by inflateInit,</font> +00590 <font class="comment"> but does not free and reallocate all the internal decompression state.</font> +00591 <font class="comment"> The stream will keep attributes that may have been set by inflateInit2.</font> +00592 <font class="comment"></font> +00593 <font class="comment"> inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source</font> +00594 <font class="comment"> stream state was inconsistent (such as zalloc or state being NULL).</font> +00595 <font class="comment">*/</font> +00596 +00597 +00598 <font class="comment">/* utility functions */</font> +00599 +00600 <font class="comment">/*</font> +00601 <font class="comment"> The following utility functions are implemented on top of the</font> +00602 <font class="comment"> basic stream-oriented functions. To simplify the interface, some</font> +00603 <font class="comment"> default options are assumed (compression level and memory usage,</font> +00604 <font class="comment"> standard memory allocation functions). The source code of these</font> +00605 <font class="comment"> utility functions can easily be modified if you need special options.</font> +00606 <font class="comment">*/</font> +00607 +00608 ZEXTERN <font class="keywordtype">int</font> ZEXPORT compress OF((Bytef *dest, uLongf *destLen, +00609 <font class="keyword">const</font> Bytef *source, uLong sourceLen)); +00610 <font class="comment">/*</font> +00611 <font class="comment"> Compresses the source buffer into the destination buffer. sourceLen is</font> +00612 <font class="comment"> the byte length of the source buffer. Upon entry, destLen is the total</font> +00613 <font class="comment"> size of the destination buffer, which must be at least 0.1% larger than</font> +00614 <font class="comment"> sourceLen plus 12 bytes. Upon exit, destLen is the actual size of the</font> +00615 <font class="comment"> compressed buffer.</font> +00616 <font class="comment"> This function can be used to compress a whole file at once if the</font> +00617 <font class="comment"> input file is mmap'ed.</font> +00618 <font class="comment"> compress returns Z_OK if success, Z_MEM_ERROR if there was not</font> +00619 <font class="comment"> enough memory, Z_BUF_ERROR if there was not enough room in the output</font> +00620 <font class="comment"> buffer.</font> +00621 <font class="comment">*/</font> +00622 +00623 ZEXTERN <font class="keywordtype">int</font> ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen, +00624 <font class="keyword">const</font> Bytef *source, uLong sourceLen, +00625 <font class="keywordtype">int</font> level)); +00626 <font class="comment">/*</font> +00627 <font class="comment"> Compresses the source buffer into the destination buffer. The level</font> +00628 <font class="comment"> parameter has the same meaning as in deflateInit. sourceLen is the byte</font> +00629 <font class="comment"> length of the source buffer. Upon entry, destLen is the total size of the</font> +00630 <font class="comment"> destination buffer, which must be at least 0.1% larger than sourceLen plus</font> +00631 <font class="comment"> 12 bytes. Upon exit, destLen is the actual size of the compressed buffer.</font> +00632 <font class="comment"></font> +00633 <font class="comment"> compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough</font> +00634 <font class="comment"> memory, Z_BUF_ERROR if there was not enough room in the output buffer,</font> +00635 <font class="comment"> Z_STREAM_ERROR if the level parameter is invalid.</font> +00636 <font class="comment">*/</font> +00637 +00638 ZEXTERN <font class="keywordtype">int</font> ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen, +00639 <font class="keyword">const</font> Bytef *source, uLong sourceLen)); +00640 <font class="comment">/*</font> +00641 <font class="comment"> Decompresses the source buffer into the destination buffer. sourceLen is</font> +00642 <font class="comment"> the byte length of the source buffer. Upon entry, destLen is the total</font> +00643 <font class="comment"> size of the destination buffer, which must be large enough to hold the</font> +00644 <font class="comment"> entire uncompressed data. (The size of the uncompressed data must have</font> +00645 <font class="comment"> been saved previously by the compressor and transmitted to the decompressor</font> +00646 <font class="comment"> by some mechanism outside the scope of this compression library.)</font> +00647 <font class="comment"> Upon exit, destLen is the actual size of the compressed buffer.</font> +00648 <font class="comment"> This function can be used to decompress a whole file at once if the</font> +00649 <font class="comment"> input file is mmap'ed.</font> +00650 <font class="comment"></font> +00651 <font class="comment"> uncompress returns Z_OK if success, Z_MEM_ERROR if there was not</font> +00652 <font class="comment"> enough memory, Z_BUF_ERROR if there was not enough room in the output</font> +00653 <font class="comment"> buffer, or Z_DATA_ERROR if the input data was corrupted.</font> +00654 <font class="comment">*/</font> +00655 +00656 +00657 <font class="keyword">typedef</font> voidp gzFile; +00658 +00659 ZEXTERN gzFile ZEXPORT gzopen OF((<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keyword">const</font> <font class="keywordtype">char</font> *mode)); +00660 <font class="comment">/*</font> +00661 <font class="comment"> Opens a gzip (.gz) file for reading or writing. The mode parameter</font> +00662 <font class="comment"> is as in fopen ("rb" or "wb") but can also include a compression level</font> +00663 <font class="comment"> ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for</font> +00664 <font class="comment"> Huffman only compression as in "wb1h". (See the description</font> +00665 <font class="comment"> of deflateInit2 for more information about the strategy parameter.)</font> +00666 <font class="comment"></font> +00667 <font class="comment"> gzopen can be used to read a file which is not in gzip format; in this</font> +00668 <font class="comment"> case gzread will directly read from the file without decompression.</font> +00669 <font class="comment"></font> +00670 <font class="comment"> gzopen returns NULL if the file could not be opened or if there was</font> +00671 <font class="comment"> insufficient memory to allocate the (de)compression state; errno</font> +00672 <font class="comment"> can be checked to distinguish the two cases (if errno is zero, the</font> +00673 <font class="comment"> zlib error is Z_MEM_ERROR). */</font> +00674 +00675 ZEXTERN gzFile ZEXPORT gzdopen OF((<font class="keywordtype">int</font> fd, <font class="keyword">const</font> <font class="keywordtype">char</font> *mode)); +00676 <font class="comment">/*</font> +00677 <font class="comment"> gzdopen() associates a gzFile with the file descriptor fd. File</font> +00678 <font class="comment"> descriptors are obtained from calls like open, dup, creat, pipe or</font> +00679 <font class="comment"> fileno (in the file has been previously opened with fopen).</font> +00680 <font class="comment"> The mode parameter is as in gzopen.</font> +00681 <font class="comment"> The next call of gzclose on the returned gzFile will also close the</font> +00682 <font class="comment"> file descriptor fd, just like fclose(fdopen(fd), mode) closes the file</font> +00683 <font class="comment"> descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode).</font> +00684 <font class="comment"> gzdopen returns NULL if there was insufficient memory to allocate</font> +00685 <font class="comment"> the (de)compression state.</font> +00686 <font class="comment">*/</font> +00687 +00688 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzsetparams OF((gzFile file, <font class="keywordtype">int</font> level, <font class="keywordtype">int</font> strategy)); +00689 <font class="comment">/*</font> +00690 <font class="comment"> Dynamically update the compression level or strategy. See the description</font> +00691 <font class="comment"> of deflateInit2 for the meaning of these parameters.</font> +00692 <font class="comment"> gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not</font> +00693 <font class="comment"> opened for writing.</font> +00694 <font class="comment">*/</font> +00695 +00696 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzread OF((gzFile file, voidp buf, <font class="keywordtype">unsigned</font> len)); +00697 <font class="comment">/*</font> +00698 <font class="comment"> Reads the given number of uncompressed bytes from the compressed file.</font> +00699 <font class="comment"> If the input file was not in gzip format, gzread copies the given number</font> +00700 <font class="comment"> of bytes into the buffer.</font> +00701 <font class="comment"> gzread returns the number of uncompressed bytes actually read (0 for</font> +00702 <font class="comment"> end of file, -1 for error). */</font> +00703 +00704 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzwrite OF((gzFile file, +00705 <font class="keyword">const</font> voidp buf, <font class="keywordtype">unsigned</font> len)); +00706 <font class="comment">/*</font> +00707 <font class="comment"> Writes the given number of uncompressed bytes into the compressed file.</font> +00708 <font class="comment"> gzwrite returns the number of uncompressed bytes actually written</font> +00709 <font class="comment"> (0 in case of error).</font> +00710 <font class="comment">*/</font> +00711 +00712 ZEXTERN <font class="keywordtype">int</font> ZEXPORTVA gzprintf OF((gzFile file, <font class="keyword">const</font> <font class="keywordtype">char</font> *format, ...)); +00713 <font class="comment">/*</font> +00714 <font class="comment"> Converts, formats, and writes the args to the compressed file under</font> +00715 <font class="comment"> control of the format string, as in fprintf. gzprintf returns the number of</font> +00716 <font class="comment"> uncompressed bytes actually written (0 in case of error).</font> +00717 <font class="comment">*/</font> +00718 +00719 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzputs OF((gzFile file, <font class="keyword">const</font> <font class="keywordtype">char</font> *s)); +00720 <font class="comment">/*</font> +00721 <font class="comment"> Writes the given null-terminated string to the compressed file, excluding</font> +00722 <font class="comment"> the terminating null character.</font> +00723 <font class="comment"> gzputs returns the number of characters written, or -1 in case of error.</font> +00724 <font class="comment">*/</font> +00725 +00726 ZEXTERN <font class="keywordtype">char</font> * ZEXPORT gzgets OF((gzFile file, <font class="keywordtype">char</font> *buf, <font class="keywordtype">int</font> len)); +00727 <font class="comment">/*</font> +00728 <font class="comment"> Reads bytes from the compressed file until len-1 characters are read, or</font> +00729 <font class="comment"> a newline character is read and transferred to buf, or an end-of-file</font> +00730 <font class="comment"> condition is encountered. The string is then terminated with a null</font> +00731 <font class="comment"> character.</font> +00732 <font class="comment"> gzgets returns buf, or Z_NULL in case of error.</font> +00733 <font class="comment">*/</font> +00734 +00735 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzputc OF((gzFile file, <font class="keywordtype">int</font> c)); +00736 <font class="comment">/*</font> +00737 <font class="comment"> Writes c, converted to an unsigned char, into the compressed file.</font> +00738 <font class="comment"> gzputc returns the value that was written, or -1 in case of error.</font> +00739 <font class="comment">*/</font> +00740 +00741 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzgetc OF((gzFile file)); +00742 <font class="comment">/*</font> +00743 <font class="comment"> Reads one byte from the compressed file. gzgetc returns this byte</font> +00744 <font class="comment"> or -1 in case of end of file or error.</font> +00745 <font class="comment">*/</font> +00746 +00747 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzflush OF((gzFile file, <font class="keywordtype">int</font> flush)); +00748 <font class="comment">/*</font> +00749 <font class="comment"> Flushes all pending output into the compressed file. The parameter</font> +00750 <font class="comment"> flush is as in the deflate() function. The return value is the zlib</font> +00751 <font class="comment"> error number (see function gzerror below). gzflush returns Z_OK if</font> +00752 <font class="comment"> the flush parameter is Z_FINISH and all output could be flushed.</font> +00753 <font class="comment"> gzflush should be called only when strictly necessary because it can</font> +00754 <font class="comment"> degrade compression.</font> +00755 <font class="comment">*/</font> +00756 +00757 ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file, +00758 z_off_t offset, <font class="keywordtype">int</font> whence)); +00759 <font class="comment">/* </font> +00760 <font class="comment"> Sets the starting position for the next gzread or gzwrite on the</font> +00761 <font class="comment"> given compressed file. The offset represents a number of bytes in the</font> +00762 <font class="comment"> uncompressed data stream. The whence parameter is defined as in lseek(2);</font> +00763 <font class="comment"> the value SEEK_END is not supported.</font> +00764 <font class="comment"> If the file is opened for reading, this function is emulated but can be</font> +00765 <font class="comment"> extremely slow. If the file is opened for writing, only forward seeks are</font> +00766 <font class="comment"> supported; gzseek then compresses a sequence of zeroes up to the new</font> +00767 <font class="comment"> starting position.</font> +00768 <font class="comment"></font> +00769 <font class="comment"> gzseek returns the resulting offset location as measured in bytes from</font> +00770 <font class="comment"> the beginning of the uncompressed stream, or -1 in case of error, in</font> +00771 <font class="comment"> particular if the file is opened for writing and the new starting position</font> +00772 <font class="comment"> would be before the current position.</font> +00773 <font class="comment">*/</font> +00774 +00775 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzrewind OF((gzFile file)); +00776 <font class="comment">/*</font> +00777 <font class="comment"> Rewinds the given file. This function is supported only for reading.</font> +00778 <font class="comment"></font> +00779 <font class="comment"> gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)</font> +00780 <font class="comment">*/</font> +00781 +00782 ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file)); +00783 <font class="comment">/*</font> +00784 <font class="comment"> Returns the starting position for the next gzread or gzwrite on the</font> +00785 <font class="comment"> given compressed file. This position represents a number of bytes in the</font> +00786 <font class="comment"> uncompressed data stream.</font> +00787 <font class="comment"></font> +00788 <font class="comment"> gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)</font> +00789 <font class="comment">*/</font> +00790 +00791 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzeof OF((gzFile file)); +00792 <font class="comment">/*</font> +00793 <font class="comment"> Returns 1 when EOF has previously been detected reading the given</font> +00794 <font class="comment"> input stream, otherwise zero.</font> +00795 <font class="comment">*/</font> +00796 +00797 ZEXTERN <font class="keywordtype">int</font> ZEXPORT gzclose OF((gzFile file)); +00798 <font class="comment">/*</font> +00799 <font class="comment"> Flushes all pending output if necessary, closes the compressed file</font> +00800 <font class="comment"> and deallocates all the (de)compression state. The return value is the zlib</font> +00801 <font class="comment"> error number (see function gzerror below).</font> +00802 <font class="comment">*/</font> +00803 +00804 ZEXTERN <font class="keyword">const</font> <font class="keywordtype">char</font> * ZEXPORT gzerror OF((gzFile file, <font class="keywordtype">int</font> *errnum)); +00805 <font class="comment">/*</font> +00806 <font class="comment"> Returns the error message for the last error which occurred on the</font> +00807 <font class="comment"> given compressed file. errnum is set to zlib error number. If an</font> +00808 <font class="comment"> error occurred in the file system and not in the compression library,</font> +00809 <font class="comment"> errnum is set to Z_ERRNO and the application may consult errno</font> +00810 <font class="comment"> to get the exact error code.</font> +00811 <font class="comment">*/</font> +00812 +00813 <font class="comment">/* checksum functions */</font> +00814 +00815 <font class="comment">/*</font> +00816 <font class="comment"> These functions are not related to compression but are exported</font> +00817 <font class="comment"> anyway because they might be useful in applications using the</font> +00818 <font class="comment"> compression library.</font> +00819 <font class="comment">*/</font> +00820 +00821 ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, <font class="keyword">const</font> Bytef *buf, uInt len)); +00822 +00823 <font class="comment">/*</font> +00824 <font class="comment"> Update a running Adler-32 checksum with the bytes buf[0..len-1] and</font> +00825 <font class="comment"> return the updated checksum. If buf is NULL, this function returns</font> +00826 <font class="comment"> the required initial value for the checksum.</font> +00827 <font class="comment"> An Adler-32 checksum is almost as reliable as a CRC32 but can be computed</font> +00828 <font class="comment"> much faster. Usage example:</font> +00829 <font class="comment"></font> +00830 <font class="comment"> uLong adler = adler32(0L, Z_NULL, 0);</font> +00831 <font class="comment"></font> +00832 <font class="comment"> while (read_buffer(buffer, length) != EOF) {</font> +00833 <font class="comment"> adler = adler32(adler, buffer, length);</font> +00834 <font class="comment"> }</font> +00835 <font class="comment"> if (adler != original_adler) error();</font> +00836 <font class="comment">*/</font> +00837 +00838 ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, <font class="keyword">const</font> Bytef *buf, uInt len)); +00839 <font class="comment">/*</font> +00840 <font class="comment"> Update a running crc with the bytes buf[0..len-1] and return the updated</font> +00841 <font class="comment"> crc. If buf is NULL, this function returns the required initial value</font> +00842 <font class="comment"> for the crc. Pre- and post-conditioning (one's complement) is performed</font> +00843 <font class="comment"> within this function so it shouldn't be done by the application.</font> +00844 <font class="comment"> Usage example:</font> +00845 <font class="comment"></font> +00846 <font class="comment"> uLong crc = crc32(0L, Z_NULL, 0);</font> +00847 <font class="comment"></font> +00848 <font class="comment"> while (read_buffer(buffer, length) != EOF) {</font> +00849 <font class="comment"> crc = crc32(crc, buffer, length);</font> +00850 <font class="comment"> }</font> +00851 <font class="comment"> if (crc != original_crc) error();</font> +00852 <font class="comment">*/</font> +00853 +00854 +00855 <font class="comment">/* various hacks, don't look :) */</font> +00856 +00857 <font class="comment">/* deflateInit and inflateInit are macros to allow checking the zlib version</font> +00858 <font class="comment"> * and the compiler's view of z_stream:</font> +00859 <font class="comment"> */</font> +00860 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateInit_ OF((z_streamp strm, <font class="keywordtype">int</font> level, +00861 <font class="keyword">const</font> <font class="keywordtype">char</font> *version, <font class="keywordtype">int</font> stream_size)); +00862 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateInit_ OF((z_streamp strm, +00863 <font class="keyword">const</font> <font class="keywordtype">char</font> *version, <font class="keywordtype">int</font> stream_size)); +00864 ZEXTERN <font class="keywordtype">int</font> ZEXPORT deflateInit2_ OF((z_streamp strm, <font class="keywordtype">int</font> level, <font class="keywordtype">int</font> method, +00865 <font class="keywordtype">int</font> windowBits, <font class="keywordtype">int</font> memLevel, +00866 <font class="keywordtype">int</font> strategy, <font class="keyword">const</font> <font class="keywordtype">char</font> *version, +00867 <font class="keywordtype">int</font> stream_size)); +00868 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateInit2_ OF((z_streamp strm, <font class="keywordtype">int</font> windowBits, +00869 <font class="keyword">const</font> <font class="keywordtype">char</font> *version, <font class="keywordtype">int</font> stream_size)); +00870 <font class="preprocessor">#define deflateInit(strm, level) \</font> +00871 <font class="preprocessor"> deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))</font> +00872 <font class="preprocessor"></font><font class="preprocessor">#define inflateInit(strm) \</font> +00873 <font class="preprocessor"> inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream))</font> +00874 <font class="preprocessor"></font><font class="preprocessor">#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \</font> +00875 <font class="preprocessor"> deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\</font> +00876 <font class="preprocessor"> (strategy), ZLIB_VERSION, sizeof(z_stream))</font> +00877 <font class="preprocessor"></font><font class="preprocessor">#define inflateInit2(strm, windowBits) \</font> +00878 <font class="preprocessor"> inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))</font> +00879 <font class="preprocessor"></font> +00880 +00881 <font class="preprocessor">#if !defined(_Z_UTIL_H) && !defined(NO_DUMMY_DECL)</font> +00882 <font class="preprocessor"></font> <font class="keyword">struct </font>internal_state {<font class="keywordtype">int</font> dummy;}; <font class="comment">/* hack for buggy compilers */</font> +00883 <font class="preprocessor">#endif</font> +00884 <font class="preprocessor"></font> +00885 ZEXTERN <font class="keyword">const</font> <font class="keywordtype">char</font> * ZEXPORT zError OF((<font class="keywordtype">int</font> err)); +00886 ZEXTERN <font class="keywordtype">int</font> ZEXPORT inflateSyncPoint OF((z_streamp z)); +00887 ZEXTERN <font class="keyword">const</font> uLongf * ZEXPORT get_crc_table OF((<font class="keywordtype">void</font>)); +00888 +00889 <font class="preprocessor">#ifdef __cplusplus</font> +00890 <font class="preprocessor"></font>} +00891 <font class="preprocessor">#endif</font> +00892 <font class="preprocessor"></font> +00893 <font class="preprocessor">#endif </font><font class="comment">/* _ZLIB_H */</font> +</pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/ztext.h-source.html b/doc/api-documentation/html/ztext.h-source.html new file mode 100644 index 0000000..69babfe --- /dev/null +++ b/doc/api-documentation/html/ztext.h-source.html @@ -0,0 +1,82 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>ztext.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:27 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ztext.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * ztext.h - code for class 'zText'- a module that reads compressed text +</font>00003 <font class="comment"> * files: ot and nt using indexs ??.vss +</font>00004 <font class="comment"> * +</font>00005 <font class="comment"> * $Id: ztext.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg Exp $ +</font>00006 <font class="comment"> * +</font>00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) +</font>00008 <font class="comment"> * CrossWire Bible Society +</font>00009 <font class="comment"> * P. O. Box 2528 +</font>00010 <font class="comment"> * Tempe, AZ 85280-2528 +</font>00011 <font class="comment"> * +</font>00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it +</font>00013 <font class="comment"> * under the terms of the GNU General Public License as published by the +</font>00014 <font class="comment"> * Free Software Foundation version 2. +</font>00015 <font class="comment"> * +</font>00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but +</font>00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of +</font>00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +</font>00019 <font class="comment"> * General Public License for more details. +</font>00020 <font class="comment"> * +</font>00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef ZTEXT_H +</font>00024 <font class="preprocessor"></font><font class="preprocessor">#define ZTEXT_H +</font>00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <zverse.h></font> +00027 <font class="preprocessor">#include <swtext.h></font> +00028 <font class="comment">//#include <swcomprs.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="comment">/*** SWModule implementation for compressed modules +</font>00033 <font class="comment">* This class handles compressed modules. +</font>00034 <font class="comment">* It should not be used in frontends, unless you are doing very special things. +</font>00035 <font class="comment">*/</font> +00036 <font class="keyword">class </font>SWDLLEXPORT zText:<font class="keyword">public</font> zVerse, <font class="keyword">public</font> <a class="code" href="class_swtext.html">SWText</a> +00037 { +00038 <font class="keywordtype">char</font> *versebuf; +00039 <a class="code" href="class_versekey.html">VerseKey</a> *lastWriteKey; +00040 <font class="keywordtype">bool</font> sameBlock (<a class="code" href="class_versekey.html">VerseKey</a> * lastWriteKey, <a class="code" href="class_versekey.html">VerseKey</a> * key); +00041 <font class="keywordtype">int</font> blockType; +00042 <font class="keyword">public</font>: +00043 +00044 +00045 zText (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00046 0, <font class="keywordtype">int</font> blockType = CHAPTERBLOCKS, SWCompress * icomp = +00047 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0); +00048 <font class="keyword">virtual</font> ~ zText (); +00049 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a19">getRawEntry</a> (); +00050 +00051 <font class="comment">// write interface ----------------------------</font> +00052 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a22">isWritable</a> ()<font class="keyword"> +</font>00053 <font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> <font class="keyword">true</font>; +00055 } +00056 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound)<font class="keyword"> +</font>00057 <font class="keyword"> </font>{ +00058 <font class="keywordflow">return</font> zVerse::createModule (path, blockBound); +00059 } +00060 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00061 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> &<a class="code" href="class_swmodule.html#a23"> operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00062 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a25">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00063 <font class="comment">// end write interface ------------------------</font> +00064 }; +00065 +00066 +00067 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:27 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/ztext_8h-source.html b/doc/api-documentation/html/ztext_8h-source.html new file mode 100644 index 0000000..ad559b4 --- /dev/null +++ b/doc/api-documentation/html/ztext_8h-source.html @@ -0,0 +1,79 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ztext.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ztext.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * ztext.h - code for class 'zText'- a module that reads compressed text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.vss</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: ztext_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef ZTEXT_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define ZTEXT_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <zverse.h></font> +00027 <font class="preprocessor">#include <swtext.h></font> +00028 <font class="comment">//#include <swcomprs.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="comment">/*** SWModule implementation for compressed modules</font> +00033 <font class="comment">* This class handles compressed modules.</font> +00034 <font class="comment">* It should not be used in frontends, unless you are doing very special things.</font> +00035 <font class="comment">*/</font> +00036 <font class="keyword">class </font>SWDLLEXPORT zText:<font class="keyword">public</font> zVerse, <font class="keyword">public</font> <a class="code" href="class_s_w_text.html">SWText</a> { +00037 <font class="keywordtype">char</font> *versebuf; +00038 <a class="code" href="class_verse_key.html">VerseKey</a> *lastWriteKey; +00039 <font class="keywordtype">bool</font> sameBlock (<a class="code" href="class_verse_key.html">VerseKey</a> * lastWriteKey, <a class="code" href="class_verse_key.html">VerseKey</a> * key); +00040 <font class="keywordtype">int</font> blockType; +00041 <font class="keyword">public</font>: +00042 +00043 +00044 zText(<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00045 0, <font class="keywordtype">int</font> blockType = CHAPTERBLOCKS, SWCompress * icomp = +00046 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, +00047 <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); +00048 <font class="keyword">virtual</font> ~zText (); +00049 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a25">getRawEntry</a>(); +00050 +00051 <font class="comment">// write interface ----------------------------</font> +00052 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a28">isWritable</a>()<font class="keyword"> </font>{ <font class="keywordflow">return</font> <font class="keyword">true</font>; } +00053 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound)<font class="keyword"> </font>{ +00054 <font class="keywordflow">return</font> zVerse::createModule (path, blockBound); +00055 } +00056 +00057 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a29">setentry</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf, <font class="keywordtype">long</font> len); <font class="comment">// Modify current module entry</font> +00058 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00059 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a30">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00060 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a32">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00061 <font class="comment">// end write interface ------------------------</font> +00062 }; +00063 +00064 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/ztext_h-source.html b/doc/api-documentation/html/ztext_h-source.html new file mode 100644 index 0000000..dda440f --- /dev/null +++ b/doc/api-documentation/html/ztext_h-source.html @@ -0,0 +1,77 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>ztext.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>ztext.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * ztext.h - code for class 'zText'- a module that reads compressed text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.vss</font> +00004 <font class="comment"> *</font> +00005 <font class="comment"> * $Id: ztext_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font> +00006 <font class="comment"> *</font> +00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> +00008 <font class="comment"> * CrossWire Bible Society</font> +00009 <font class="comment"> * P. O. Box 2528</font> +00010 <font class="comment"> * Tempe, AZ 85280-2528</font> +00011 <font class="comment"> *</font> +00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> +00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> +00014 <font class="comment"> * Free Software Foundation version 2.</font> +00015 <font class="comment"> *</font> +00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> +00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00019 <font class="comment"> * General Public License for more details.</font> +00020 <font class="comment"> *</font> +00021 <font class="comment"> */</font> +00022 +00023 <font class="preprocessor">#ifndef ZTEXT_H</font> +00024 <font class="preprocessor"></font><font class="preprocessor">#define ZTEXT_H</font> +00025 <font class="preprocessor"></font> +00026 <font class="preprocessor">#include <zverse.h></font> +00027 <font class="preprocessor">#include <swtext.h></font> +00028 <font class="comment">//#include <swcomprs.h></font> +00029 +00030 <font class="preprocessor">#include <defs.h></font> +00031 +00032 <font class="comment">/*** SWModule implementation for compressed modules</font> +00033 <font class="comment">* This class handles compressed modules.</font> +00034 <font class="comment">* It should not be used in frontends, unless you are doing very special things.</font> +00035 <font class="comment">*/</font> +00036 <font class="keyword">class </font>SWDLLEXPORT zText:<font class="keyword">public</font> zVerse, <font class="keyword">public</font> <a class="code" href="class_swtext.html">SWText</a> { +00037 <font class="keywordtype">char</font> *versebuf; +00038 <a class="code" href="class_versekey.html">VerseKey</a> *lastWriteKey; +00039 <font class="keywordtype">bool</font> sameBlock (<a class="code" href="class_versekey.html">VerseKey</a> * lastWriteKey, <a class="code" href="class_versekey.html">VerseKey</a> * key); +00040 <font class="keywordtype">int</font> blockType; +00041 <font class="keyword">public</font>: +00042 +00043 +00044 zText(<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = +00045 0, <font class="keywordtype">int</font> blockType = CHAPTERBLOCKS, SWCompress * icomp = +00046 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>); +00047 <font class="keyword">virtual</font> ~zText (); +00048 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a21">getRawEntry</a>(); +00049 +00050 <font class="comment">// write interface ----------------------------</font> +00051 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a24">isWritable</a>()<font class="keyword"> </font>{ <font class="keywordflow">return</font> <font class="keyword">true</font>; } +00052 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound)<font class="keyword"> </font>{ +00053 <font class="keywordflow">return</font> zVerse::createModule (path, blockBound); +00054 } +00055 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> +00056 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> +00057 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a27">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> +00058 <font class="comment">// end write interface ------------------------</font> +00059 }; +00060 +00061 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zverse.h-source.html b/doc/api-documentation/html/zverse.h-source.html new file mode 100644 index 0000000..afd2aa0 --- /dev/null +++ b/doc/api-documentation/html/zverse.h-source.html @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<title>zverse.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.1.5 on Thu May 24 19:50:27 2001 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zverse.h</h1><div class="fragment"><pre>00001 <font class="comment">/****************************************************************************** +</font>00002 <font class="comment"> * rawverse.h - code for class 'RawVerse'- a module that reads raw text +</font>00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss +</font>00004 <font class="comment"> * and provides lookup and parsing functions based on +</font>00005 <font class="comment"> * class VerseKey +</font>00006 <font class="comment"> */</font> +00007 +00008 <font class="preprocessor">#ifndef ZVERSE_H +</font>00009 <font class="preprocessor"></font><font class="preprocessor">#define ZVERSE_H +</font>00010 <font class="preprocessor"></font> +00011 <font class="preprocessor">#include <filemgr.h></font> +00012 <font class="preprocessor">#include <fcntl.h></font> +00013 <font class="preprocessor">#include <rawverse.h></font> +00014 <font class="preprocessor">#include <swcomprs.h></font> +00015 +00016 <font class="preprocessor">#include <defs.h></font> +00017 +00018 <font class="keyword">class </font>SWDLLEXPORT zVerse <font class="comment">/*: public RawVerse */</font> +00019 { +00020 SWCompress *compressor; +00021 +00022 <font class="keyword">protected</font>: +00023 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawVerse objects or derivitives</font> +00024 +00025 FileDesc *idxfp[2]; +00026 FileDesc *textfp[2]; +00027 FileDesc *compfp[2]; +00028 <font class="keywordtype">char</font> *path; +00029 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00030 <font class="keywordtype">void</font> settext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf); +00031 <font class="keywordtype">void</font> linkentry (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> destidxoff, <font class="keywordtype">long</font> srcidxoff); +00032 <font class="keywordtype">void</font> flushCache (); +00033 <font class="comment">//RawVerse();</font> +00034 <font class="keywordtype">char</font> *cacheBuf; +00035 <font class="keywordtype">char</font> cacheTestament; +00036 <font class="keywordtype">long</font> cacheBufIdx; +00037 <font class="keywordtype">bool</font> dirtyCache; +00038 +00039 <font class="keyword">public</font>: +00040 +00041 <font class="preprocessor">#define VERSEBLOCKS 2 +</font>00042 <font class="preprocessor"></font><font class="preprocessor">#define CHAPTERBLOCKS 3 +</font>00043 <font class="preprocessor"></font><font class="preprocessor">#define BOOKBLOCKS 4 +</font>00044 <font class="preprocessor"></font> +00045 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> uniqueIndexID[]; +00046 <font class="keywordtype">char</font> nl; +00047 +00048 +00049 zVerse (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = O_RDONLY, <font class="keywordtype">int</font> blockType = +00050 CHAPTERBLOCKS, SWCompress * icomp = 0); +00051 <font class="keyword">virtual</font> ~ zVerse (); +00052 <font class="keywordtype">void</font> findoffset (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keywordtype">long</font> *start, +00053 <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> *end); +00054 <font class="keywordtype">void</font> swgettext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> size, <font class="keywordtype">char</font> *buf); +00055 <font class="comment">//static char CreateModule(char *path);</font> +00056 <font class="keyword">static</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound); +00057 }; +00058 +00059 +00060 <font class="preprocessor">#endif +</font></div></pre><hr><address><small>Generated at Thu May 24 19:50:27 2001 for The Sword Project by +<a href="http://www.stack.nl/~dimitri/doxygen/index.html"> +<img src="doxygen.gif" alt="doxygen" align=center border=0 +width=110 height=53></a>1.1.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2000</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zverse_8h-source.html b/doc/api-documentation/html/zverse_8h-source.html new file mode 100644 index 0000000..2e18c36 --- /dev/null +++ b/doc/api-documentation/html/zverse_8h-source.html @@ -0,0 +1,71 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>zverse.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.9.1 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zverse.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawverse.h - code for class 'RawVerse'- a module that reads raw text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> * and provides lookup and parsing functions based on</font> +00005 <font class="comment"> * class VerseKey</font> +00006 <font class="comment"> */</font> +00007 +00008 <font class="preprocessor">#ifndef ZVERSE_H</font> +00009 <font class="preprocessor"></font><font class="preprocessor">#define ZVERSE_H</font> +00010 <font class="preprocessor"></font> +00011 <font class="preprocessor">#include <filemgr.h></font> +00012 <font class="preprocessor">#include <fcntl.h></font> +00013 <font class="preprocessor">#include <rawverse.h></font> +00014 <font class="preprocessor">#include <swcomprs.h></font> +00015 +00016 <font class="preprocessor">#include <defs.h></font> +00017 +00018 <font class="keyword">class </font>SWDLLEXPORT zVerse { +00019 SWCompress *compressor; +00020 +00021 <font class="keyword">protected</font>: +00022 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawVerse objects or derivitives</font> +00023 +00024 FileDesc *idxfp[2]; +00025 FileDesc *textfp[2]; +00026 FileDesc *compfp[2]; +00027 <font class="keywordtype">char</font> *path; +00028 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00029 <font class="keywordtype">void</font> settext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> len = 0); +00030 <font class="keywordtype">void</font> linkentry (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> destidxoff, <font class="keywordtype">long</font> srcidxoff); +00031 <font class="keywordtype">void</font> flushCache (); +00032 <font class="comment">//RawVerse();</font> +00033 <font class="keywordtype">char</font> *cacheBuf; +00034 <font class="keywordtype">char</font> cacheTestament; +00035 <font class="keywordtype">long</font> cacheBufIdx; +00036 <font class="keywordtype">bool</font> dirtyCache; +00037 +00038 <font class="keyword">public</font>: +00039 +00040 <font class="preprocessor">#define VERSEBLOCKS 2</font> +00041 <font class="preprocessor"></font><font class="preprocessor">#define CHAPTERBLOCKS 3</font> +00042 <font class="preprocessor"></font><font class="preprocessor">#define BOOKBLOCKS 4</font> +00043 <font class="preprocessor"></font> +00044 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> uniqueIndexID[]; +00045 <font class="keywordtype">char</font> nl; +00046 +00047 +00048 zVerse (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = O_RDONLY, <font class="keywordtype">int</font> blockType = CHAPTERBLOCKS, SWCompress * icomp = 0); +00049 <font class="keyword">virtual</font> ~ zVerse (); +00050 <font class="keywordtype">void</font> findoffset (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keywordtype">long</font> *start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> *end); +00051 <font class="keywordtype">void</font> swgettext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> size, <font class="keywordtype">char</font> *buf); +00052 <font class="keyword">static</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound); +00053 }; +00054 +00055 +00056 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> diff --git a/doc/api-documentation/html/zverse_h-source.html b/doc/api-documentation/html/zverse_h-source.html new file mode 100644 index 0000000..54b1fbd --- /dev/null +++ b/doc/api-documentation/html/zverse_h-source.html @@ -0,0 +1,76 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta name="robots" content="noindex"> +<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>zverse.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body bgcolor="#ffffff"> +<!-- Generated by Doxygen 1.2.6 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center> +<hr><h1>zverse.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> +00002 <font class="comment"> * rawverse.h - code for class 'RawVerse'- a module that reads raw text</font> +00003 <font class="comment"> * files: ot and nt using indexs ??.bks ??.cps ??.vss</font> +00004 <font class="comment"> * and provides lookup and parsing functions based on</font> +00005 <font class="comment"> * class VerseKey</font> +00006 <font class="comment"> */</font> +00007 +00008 <font class="preprocessor">#ifndef ZVERSE_H</font> +00009 <font class="preprocessor"></font><font class="preprocessor">#define ZVERSE_H</font> +00010 <font class="preprocessor"></font> +00011 <font class="preprocessor">#include <filemgr.h></font> +00012 <font class="preprocessor">#include <fcntl.h></font> +00013 <font class="preprocessor">#include <rawverse.h></font> +00014 <font class="preprocessor">#include <swcomprs.h></font> +00015 +00016 <font class="preprocessor">#include <defs.h></font> +00017 +00018 <font class="keyword">class </font>SWDLLEXPORT zVerse <font class="comment">/*: public RawVerse */</font> +00019 { +00020 SWCompress *compressor; +00021 +00022 <font class="keyword">protected</font>: +00023 <font class="keyword">static</font> <font class="keywordtype">int</font> instance; <font class="comment">// number of instantiated RawVerse objects or derivitives</font> +00024 +00025 FileDesc *idxfp[2]; +00026 FileDesc *textfp[2]; +00027 FileDesc *compfp[2]; +00028 <font class="keywordtype">char</font> *path; +00029 <font class="keywordtype">void</font> preptext (<font class="keywordtype">char</font> *buf); +00030 <font class="keywordtype">void</font> settext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf); +00031 <font class="keywordtype">void</font> linkentry (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> destidxoff, <font class="keywordtype">long</font> srcidxoff); +00032 <font class="keywordtype">void</font> flushCache (); +00033 <font class="comment">//RawVerse();</font> +00034 <font class="keywordtype">char</font> *cacheBuf; +00035 <font class="keywordtype">char</font> cacheTestament; +00036 <font class="keywordtype">long</font> cacheBufIdx; +00037 <font class="keywordtype">bool</font> dirtyCache; +00038 +00039 <font class="keyword">public</font>: +00040 +00041 <font class="preprocessor">#define VERSEBLOCKS 2</font> +00042 <font class="preprocessor"></font><font class="preprocessor">#define CHAPTERBLOCKS 3</font> +00043 <font class="preprocessor"></font><font class="preprocessor">#define BOOKBLOCKS 4</font> +00044 <font class="preprocessor"></font> +00045 <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">char</font> uniqueIndexID[]; +00046 <font class="keywordtype">char</font> nl; +00047 +00048 +00049 zVerse (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = O_RDONLY, <font class="keywordtype">int</font> blockType = +00050 CHAPTERBLOCKS, SWCompress * icomp = 0); +00051 <font class="keyword">virtual</font> ~ zVerse (); +00052 <font class="keywordtype">void</font> findoffset (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> idxoff, <font class="keywordtype">long</font> *start, +00053 <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> *end); +00054 <font class="keywordtype">void</font> swgettext (<font class="keywordtype">char</font> testmt, <font class="keywordtype">long</font> start, <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> size, <font class="keywordtype">char</font> *buf); +00055 <font class="comment">//static char CreateModule(char *path);</font> +00056 <font class="keyword">static</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound); +00057 }; +00058 +00059 +00060 <font class="preprocessor">#endif</font> +</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:34 2001 for The Sword Project by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.gif" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, + © 1997-2001</small></address> +</body> +</html> |
