diff options
Diffstat (limited to 'doc/api-documentation/html/swmodule.h-source.html')
| -rw-r--r-- | doc/api-documentation/html/swmodule.h-source.html | 246 |
1 files changed, 0 insertions, 246 deletions
diff --git a/doc/api-documentation/html/swmodule.h-source.html b/doc/api-documentation/html/swmodule.h-source.html deleted file mode 100644 index c031f05..0000000 --- a/doc/api-documentation/html/swmodule.h-source.html +++ /dev/null @@ -1,246 +0,0 @@ -<!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> |