diff options
Diffstat (limited to 'doc/api-documentation/man/man3/swmodule.3')
-rw-r--r-- | doc/api-documentation/man/man3/swmodule.3 | 856 |
1 files changed, 0 insertions, 856 deletions
diff --git a/doc/api-documentation/man/man3/swmodule.3 b/doc/api-documentation/man/man3/swmodule.3 deleted file mode 100644 index e8ab14e..0000000 --- a/doc/api-documentation/man/man3/swmodule.3 +++ /dev/null @@ -1,856 +0,0 @@ -.TH "SWModule" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- -.ad l -.nh -.SH NAME -SWModule \- The class SWModule is the base class for all modules used in Sword. -.SH SYNOPSIS -.br -.PP -\fC#include <swmodule.h>\fR -.PP -Inherited by \fBSWCom\fR, \fBSWLD\fR, and \fBSWText\fR. -.PP -.SS Public Methods - -.in +1c -.ti -1c -.RI "\fBSWModule\fR (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fR *idisp=0, char *imodtype=0, bool unicode=false)" -.br -.RI "\fIInitializes data for instance of SWModule.\fR" -.ti -1c -.RI "virtual \fB~SWModule\fR ()" -.br -.RI "\fICleans up instance of SWModule.\fR" -.ti -1c -.RI "virtual char \fBError\fR ()" -.br -.RI "\fIGets and clears error status.\fR" -.ti -1c -.RI "virtual const bool \fBisUnicode\fR () const" -.br -.ti -1c -.RI "virtual const int \fBgetEntrySize\fR () const" -.br -.ti -1c -.RI "virtual char \fBSetKey\fR (const \fBSWKey\fR *ikey)" -.br -.RI "\fISets a key to this module for position to a particular record or set of records.\fR" -.ti -1c -.RI "virtual char \fBSetKey\fR (const \fBSWKey\fR &ikey)" -.br -.RI "\fISets the key of this module.\fR" -.ti -1c -.RI "virtual \fBSWKey\fR& \fBKey\fR () const" -.br -.RI "\fIGets the current module key.\fR" -.ti -1c -.RI "virtual char \fBKey\fR (const \fBSWKey\fR &ikey)" -.br -.RI "\fISets the current key of the module to ikey, and returns the keytext.\fR" -.ti -1c -.RI "virtual const char* \fBKeyText\fR (const char *imodtype=0)" -.br -.RI "\fISets/gets module KeyText.\fR" -.ti -1c -.RI "virtual char \fBDisplay\fR ()" -.br -.RI "\fICalls this modules display object and passes itself.\fR" -.ti -1c -.RI "virtual \fBSWDisplay\fR* \fBDisp\fR (\fBSWDisplay\fR *idisp=0)" -.br -.RI "\fISets/gets display driver.\fR" -.ti -1c -.RI "virtual char* \fBName\fR (const char *imodname=0)" -.br -.RI "\fISets/gets module name.\fR" -.ti -1c -.RI "virtual char* \fBDescription\fR (const char *imoddesc=0)" -.br -.RI "\fISets/gets module description.\fR" -.ti -1c -.RI "virtual char* \fBType\fR (const char *imodtype=0)" -.br -.RI "\fISets/gets module type.\fR" -.ti -1c -.RI "virtual \fBListKey\fR& \fBSearch\fR (const char *istr, int searchType=0, int flags=0, \fBSWKey\fR *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0)" -.br -.RI "\fISearches a module for a string.\fR" -.ti -1c -.RI "virtual char \fBcreateSearchFramework\fR ()" -.br -.ti -1c -.RI "virtual bool \fBhasSearchFramework\fR ()" -.br -.ti -1c -.RI "virtual bool \fBisSearchOptimallySupported\fR (const char *istr, int searchType, int flags, \fBSWKey\fR *scope)" -.br -.ti -1c -.RI "virtual \fBSWKey\fR* \fBCreateKey\fR ()" -.br -.RI "\fIAllocates a key of specific type for module.\fR" -.ti -1c -.RI "virtual \fBoperator char *\fR ()" -.br -.RI "\fIRenders and returns the current module text.\fR" -.ti -1c -.RI "virtual char* \fBgetRawEntry\fR ()=0" -.br -.RI "\fIThis function is reimplemented by the different kinds of module objects.\fR" -.ti -1c -.RI "virtual \fBoperator SWKey &\fR ()" -.br -.ti -1c -.RI "virtual \fBoperator SWKey *\fR ()" -.br -.ti -1c -.RI "virtual bool \fBisWritable\fR ()" -.br -.RI "\fIIs the module writable? :).\fR" -.ti -1c -.RI "virtual SWModule& \fBoperator<<\fR (const char *)" -.br -.RI "\fIModify the current module entry text only if module \fBisWritable\fR.\fR" -.ti -1c -.RI "virtual SWModule& \fBoperator<<\fR (const \fBSWKey\fR *)" -.br -.RI "\fILink the current module entry to another module entry only if module \fBisWritable\fR.\fR" -.ti -1c -.RI "virtual void \fBdeleteEntry\fR ()" -.br -.RI "\fIDelete current module entry - only if module \fBisWritable\fR.\fR" -.ti -1c -.RI "virtual SWModule& \fBoperator-=\fR (int decrement)" -.br -.RI "\fIDecrements module key a number of entries.\fR" -.ti -1c -.RI "virtual SWModule& \fBoperator+=\fR (int increment)" -.br -.RI "\fIIncrements module key a number of entries.\fR" -.ti -1c -.RI "virtual SWModule& \fBoperator++\fR (int)" -.br -.RI "\fIIncrements module key by 1 entry.\fR" -.ti -1c -.RI "virtual SWModule& \fBoperator--\fR (int)" -.br -.RI "\fIDecrements module key by 1 entry.\fR" -.ti -1c -.RI "virtual SWModule& \fBoperator=\fR (SW_POSITION p)" -.br -.RI "\fIPositions this modules to an entry.\fR" -.ti -1c -.RI "virtual SWModule& \fBAddRenderFilter\fR (\fBSWFilter\fR *newfilter)" -.br -.RI "\fIAdds a RenderFilter to this module's.\fR" -.ti -1c -.RI "virtual SWModule& \fBRemoveRenderFilter\fR (\fBSWFilter\fR *oldfilter)" -.br -.RI "\fIRemoves a RenderFilter to this module's.\fR" -.ti -1c -.RI "virtual void \fBrenderFilter\fR (char *buf, long size, \fBSWKey\fR *\fBkey\fR)" -.br -.RI "\fIRenderFilter a text buffer.\fR" -.ti -1c -.RI "virtual SWModule& \fBAddStripFilter\fR (\fBSWFilter\fR *newfilter)" -.br -.RI "\fIAdds a StripFilter to this module's stripfilters queue.\fR" -.ti -1c -.RI "virtual void \fBstripFilter\fR (char *buf, long size, \fBSWKey\fR *\fBkey\fR)" -.br -.RI "\fIStripFilter a text buffer.\fR" -.ti -1c -.RI "virtual SWModule& \fBAddRawFilter\fR (\fBSWFilter\fR *newfilter)" -.br -.RI "\fIAdds a RawFilter to this module's rawfilters queue.\fR" -.ti -1c -.RI "virtual void \fBfilterBuffer\fR (FilterList *filters, char *buf, long size, \fBSWKey\fR *\fBkey\fR)" -.br -.RI "\fIFilterBuffer a text buffer.\fR" -.ti -1c -.RI "virtual void \fBrawFilter\fR (char *buf, long size, \fBSWKey\fR *\fBkey\fR)" -.br -.RI "\fIRawFilter a text buffer.\fR" -.ti -1c -.RI "virtual SWModule& \fBAddOptionFilter\fR (\fBSWFilter\fR *newfilter)" -.br -.RI "\fIAdds an OptionFilter to this module's optionfilters queue.\fR" -.ti -1c -.RI "virtual void \fBoptionFilter\fR (char *buf, long size, \fBSWKey\fR *\fBkey\fR)" -.br -.RI "\fIOptionFilter a text buffer.\fR" -.ti -1c -.RI "virtual const char* \fBStripText\fR (char *buf=0, int len=-1)" -.br -.RI "\fIcalls all StripFilters on buffer or current text.\fR" -.ti -1c -.RI "virtual const char* \fBRenderText\fR (char *buf=0, int len=-1)" -.br -.RI "\fIcalls all RenderFilters on buffer or current text.\fR" -.ti -1c -.RI "virtual const char* \fBStripText\fR (\fBSWKey\fR *tmpKey)" -.br -.RI "\fIcalls all StripFilters on current text.\fR" -.ti -1c -.RI "virtual const char* \fBRenderText\fR (\fBSWKey\fR *tmpKey)" -.br -.RI "\fIcalls all RenderFilters on current text.\fR" -.in -1c -.SS Public Attributes - -.in +1c -.ti -1c -.RI "bool \fBterminateSearch\fR" -.br -.RI "\fISet this bool to false to terminate the search which is executed by this module (\fBSearch\fR).\fR" -.in -1c -.SS Static Public Methods - -.in +1c -.ti -1c -.RI "void \fBnullPercent\fR (char percent, void *userData)" -.br -.RI "\fIThis is the default callback function for searching.\fR" -.ti -1c -.RI "char \fBcreateModule\fR (const char *)" -.br -.RI "\fICreates a new module.\fR" -.in -1c -.SS Protected Attributes - -.in +1c -.ti -1c -.RI "char \fBerror\fR" -.br -.ti -1c -.RI "\fBSWKey\fR* \fBkey\fR" -.br -.RI "\fIthe current key.\fR" -.ti -1c -.RI "\fBListKey\fR \fBlistkey\fR" -.br -.ti -1c -.RI "char* \fBmodname\fR" -.br -.ti -1c -.RI "char* \fBmoddesc\fR" -.br -.ti -1c -.RI "char* \fBmodtype\fR" -.br -.ti -1c -.RI "\fBSWDisplay\fR* \fBdisp\fR" -.br -.RI "\fIthis module's display object.\fR" -.ti -1c -.RI "char* \fBentrybuf\fR" -.br -.ti -1c -.RI "FilterList* \fBstripFilters\fR" -.br -.RI "\fIexecuted to remove all markup (for searches).\fR" -.ti -1c -.RI "FilterList* \fBrawFilters\fR" -.br -.RI "\fIexecuted immediately upon fileread.\fR" -.ti -1c -.RI "FilterList* \fBrenderFilters\fR" -.br -.RI "\fIexecuted to format for display.\fR" -.ti -1c -.RI "FilterList* \fBoptionFilters\fR" -.br -.RI "\fIexecuted to change markup to user prefs.\fR" -.ti -1c -.RI "bool \fBrender\fR" -.br -.ti -1c -.RI "bool \fBunicode\fR" -.br -.ti -1c -.RI "int \fBentrySize\fR" -.br -.in -1c -.SS Static Protected Attributes - -.in +1c -.ti -1c -.RI "\fBSWDisplay\fR \fBrawdisp\fR" -.br -.in -1c -.SH DETAILED DESCRIPTION -.PP -The class SWModule is the base class for all modules used in Sword. -.PP -Definition at line 47 of file swmodule.h. -.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION -.PP -.SS SWModule::SWModule (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fR * idisp = 0, char * imodtype = 0, bool unicode = false) -.PP -Initializes data for instance of SWModule. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIimodname\fR\fR -Internal name for module; see also \fBName\fR -.TP -\fB\fIimoddesc\fR\fR -Name to display to user for module; see also \fBDescription\fR -.TP -\fB\fIidisp\fR\fR -Display object to use for displaying see also \fBDisp\fR -.TP -\fB\fIimodtype\fR\fR -Type of Module (All modules will be displayed with others of same type under their modtype heading) see also \fBType\fR -.SH MEMBER FUNCTION DOCUMENTATION -.PP -.SS SWModule & SWModule::AddOptionFilter (\fBSWFilter\fR * newfilter)\fC [inline, virtual]\fR -.PP -Adds an OptionFilter to this module's optionfilters queue. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fInewfilter\fR\fR -the filter to add -.PP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 443 of file swmodule.h. -.SS SWModule & SWModule::AddRawFilter (\fBSWFilter\fR * newfilter)\fC [inline, virtual]\fR -.PP -Adds a RawFilter to this module's rawfilters queue. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fInewfilter\fR\fR -the filter to add -.PP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 410 of file swmodule.h. -.SS SWModule & SWModule::AddRenderFilter (\fBSWFilter\fR * newfilter)\fC [inline, virtual]\fR -.PP -Adds a RenderFilter to this module's. -.PP -\fBSee also: \fR -.in +1c -renderfilters queue -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fInewfilter\fR\fR -the filter to add -.PP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 363 of file swmodule.h. -.SS SWModule & SWModule::AddStripFilter (\fBSWFilter\fR * newfilter)\fC [inline, virtual]\fR -.PP -Adds a StripFilter to this module's stripfilters queue. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fInewfilter\fR\fR -the filter to add -.PP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 391 of file swmodule.h. -.SS \fBSWKey\fR * SWModule::CreateKey ()\fC [virtual]\fR -.PP -Allocates a key of specific type for module. -.PP -\fBReturns: \fR -.in +1c -pointer to allocated key -.PP -Reimplemented in \fBSWCom\fR, \fBSWLD\fR, and \fBSWText\fR. -.SS char * SWModule::Description (const char * imoddesc = 0)\fC [virtual]\fR -.PP -Sets/gets module description. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIimoddesc\fR\fR -value which to set moddesc; [0] - only get -.PP -\fBReturns: \fR -.in +1c -pointer to moddesc -.SS \fBSWDisplay\fR * SWModule::Disp (\fBSWDisplay\fR * idisp = 0)\fC [virtual]\fR -.PP -Sets/gets display driver. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIidisp\fR\fR -value which to set disp; [0] - only get -.PP -\fBReturns: \fR -.in +1c -pointer to disp -.SS char SWModule::Display ()\fC [virtual]\fR -.PP -Calls this modules display object and passes itself. -.PP -\fBReturns: \fR -.in +1c -error status -.SS char SWModule::Error ()\fC [virtual]\fR -.PP -Gets and clears error status. -.PP -\fBReturns: \fR -.in +1c -error status -.SS char SWModule::Key (const \fBSWKey\fR & ikey)\fC [inline, virtual]\fR -.PP -Sets the current key of the module to ikey, and returns the keytext. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIikey\fR\fR -new current key for the module -.PP -\fBReturns: \fR -.in +1c -the keytext of the current module key -.PP -Definition at line 161 of file swmodule.h. -.SS \fBSWKey\fR & SWModule::Key () const\fC [inline, virtual]\fR -.PP -Gets the current module key. -.PP -\fBReturns: \fR -.in +1c -the current key of this module -.PP -Definition at line 151 of file swmodule.h. -.SS const char * SWModule::KeyText (const char * ikeytext = 0)\fC [virtual]\fR -.PP -Sets/gets module KeyText. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIikeytext\fR\fR -value which to set keytext; [0] - only get -.PP -\fBReturns: \fR -.in +1c -pointer to keytext -.PP -Reimplemented in \fBSWLD\fR. -.SS char * SWModule::Name (const char * imodname = 0)\fC [virtual]\fR -.PP -Sets/gets module name. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIimodname\fR\fR -value which to set modname; [0] - only get -.PP -\fBReturns: \fR -.in +1c -pointer to modname -.SS SWModule & SWModule::RemoveRenderFilter (\fBSWFilter\fR * oldfilter)\fC [inline, virtual]\fR -.PP -Removes a RenderFilter to this module's. -.PP -\fBSee also: \fR -.in +1c -renderfilters queue -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIoldfilter\fR\fR -the filter to remove -.PP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 372 of file swmodule.h. -.SS const char * SWModule::RenderText (\fBSWKey\fR * tmpKey)\fC [virtual]\fR -.PP -calls all RenderFilters on current text. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fItmpKey\fR\fR -key to use to grab text -.PP -\fBReturns: \fR -.in +1c -this module's text at specified key location massaged by Render filters -.SS const char * SWModule::RenderText (char * buf = 0, int len = -1)\fC [virtual]\fR -.PP -calls all RenderFilters on buffer or current text. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIbuf\fR\fR -buffer to Render instead of current module position; if buf is NULL, the current text will be used -.TP -\fB\fIlen\fR\fR -max len of buf OR current text -- will be applied anyway -.PP -\fBReturns: \fR -.in +1c -this module's text at specified key location massaged by Render filters -.SS \fBListKey\fR & SWModule::Search (const char * istr, int searchType = 0, int flags = 0, \fBSWKey\fR * scope = 0, bool * justCheckIfSupported = 0, void(* percent)(char, void *) = &nullPercent, void * percentUserData = 0)\fC [virtual]\fR -.PP -Searches a module for a string. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIistr\fR\fR -string for which to search -.TP -\fB\fIsearchType\fR\fR -type of search to perform >=0 ->regex; 1->phrase; 2->multiword; -.TP -\fB\fIflags\fR\fR -options flags for search -.TP -\fB\fIjustCheckIfSupported\fR\fR -if set, don't search, only tell if this function supports requested search. -.PP -\fBReturns: \fR -.in +1c -listkey set to verses that contain istr -.SS char SWModule::SetKey (const \fBSWKey\fR & ikey)\fC [virtual]\fR -.PP -Sets the key of this module. -.PP -Similair to -.PP -\fBSee also: \fR -.in +1c -\fBSetKey\fR(const SWKey*) . -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIikey\fR\fR -The \fBSWKey\fR which should be used as new key. -.PP -\fBReturns: \fR -.in +1c -Error status -.SS char SWModule::SetKey (const \fBSWKey\fR * ikey)\fC [virtual]\fR -.PP -Sets a key to this module for position to a particular record or set of records. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIikey\fR\fR -key with which to set this module -.PP -\fBReturns: \fR -.in +1c -error status -.PP -Referenced by Key(). -.SS const char * SWModule::StripText (\fBSWKey\fR * tmpKey)\fC [virtual]\fR -.PP -calls all StripFilters on current text. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fItmpKey\fR\fR -key to use to grab text -.PP -\fBReturns: \fR -.in +1c -this module's text at specified key location massaged by Strip filters -.SS const char * SWModule::StripText (char * buf = 0, int len = -1)\fC [virtual]\fR -.PP -calls all StripFilters on buffer or current text. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIbuf\fR\fR -buf to massage instead of current module position; if buf is NULL, the current text will be used -.TP -\fB\fIlen\fR\fR -max len of buf OR current text -- will be applied anyway -.PP -\fBReturns: \fR -.in +1c -this module's text at specified key location massaged by Strip filters -.SS char * SWModule::Type (const char * imodtype = 0)\fC [virtual]\fR -.PP -Sets/gets module type. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIimodtype\fR\fR -value which to set modtype; [0] - only get -.PP -\fBReturns: \fR -.in +1c -pointer to modtype -.SS char SWModule::createModule (const char * path)\fC [inline, static]\fR -.PP -Creates a new module. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIpath\fR\fR -The first parameter is path of the new module -.PP -\fBReturns: \fR -.in +1c -error -.PP -Definition at line 296 of file swmodule.h. -.SS void SWModule::filterBuffer (FilterList * filters, char * buf, long size, \fBSWKey\fR * key)\fC [inline, virtual]\fR -.PP -FilterBuffer a text buffer. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIfilters\fR\fR -the FilterList of filters to iterate -.TP -\fB\fIbuf\fR\fR -the buffer to filter -.TP -\fB\fIsize\fR\fR -the allocated size of the buffer -.TP -\fB\fIkey\fR\fR -key location from where this buffer was extracted -.PP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 422 of file swmodule.h. -.PP -Referenced by optionFilter(), rawFilter(), renderFilter(), and stripFilter(). -.SS const int SWModule::getEntrySize () const\fC [inline, virtual]\fR -.PP -\fBReturns: \fR -.in +1c -The size of the current entry. -.PP -Definition at line 130 of file swmodule.h. -.SS char * SWModule::getRawEntry ()\fC [pure virtual]\fR -.PP -This function is reimplemented by the different kinds of module objects. -.PP -\fBReturns: \fR -.in +1c -the raw module text of the current entry -.SS const bool SWModule::isUnicode () const\fC [inline, virtual]\fR -.PP -\fBReturns: \fR -.in +1c -True if this module is encoded in Unicode, otherwise return false. -.PP -Definition at line 126 of file swmodule.h. -.SS bool SWModule::isWritable ()\fC [inline, virtual]\fR -.PP -Is the module writable? :). -.PP -\fBReturns: \fR -.in +1c -yes or no -.PP -Definition at line 288 of file swmodule.h. -.SS void SWModule::nullPercent (char percent, void * userData)\fC [static]\fR -.PP -This is the default callback function for searching. -.PP -This function is a placeholder and does nothing. You can define your own function for search progress evaluation, and pass it over to \fBSearch\fR. -.SS SWModule::operator char * ()\fC [virtual]\fR -.PP -Renders and returns the current module text. -.PP -\fBReturns: \fR -.in +1c -the rendered current module text -.SS SWModule & SWModule::operator+= (int increment)\fC [virtual]\fR -.PP -Increments module key a number of entries. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIincrement\fR\fR -Number of entries to jump forward -.PP -\fBReturns: \fR -.in +1c -*this -.SS SWModule & SWModule::operator-= (int decrement)\fC [virtual]\fR -.PP -Decrements module key a number of entries. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIdecrement\fR\fR -Number of entries to jump backward -.PP -\fBReturns: \fR -.in +1c -*this -.SS SWModule & SWModule::operator<< (const \fBSWKey\fR * linkKey)\fC [inline, virtual]\fR -.PP -Link the current module entry to another module entry only if module \fBisWritable\fR. -.PP -.TP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 312 of file swmodule.h. -.SS SWModule & SWModule::operator<< (const char * inbuf)\fC [inline, virtual]\fR -.PP -Modify the current module entry text only if module \fBisWritable\fR. -.PP -.TP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 304 of file swmodule.h. -.SS SWModule & SWModule::operator= (SW_POSITION pos)\fC [virtual]\fR -.PP -Positions this modules to an entry. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIp\fR\fR -position (e.g. TOP, BOTTOM) -.PP -\fBReturns: \fR -.in +1c -*this -.SS void SWModule::optionFilter (char * buf, long size, \fBSWKey\fR * key)\fC [inline, virtual]\fR -.PP -OptionFilter a text buffer. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIbuf\fR\fR -the buffer to filter -.TP -\fB\fIsize\fR\fR -the allocated size of the buffer -.TP -\fB\fIkey\fR\fR -key location from where this buffer was extracted -.PP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 454 of file swmodule.h. -.SS void SWModule::rawFilter (char * buf, long size, \fBSWKey\fR * key)\fC [inline, virtual]\fR -.PP -RawFilter a text buffer. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIbuf\fR\fR -the buffer to filter -.TP -\fB\fIsize\fR\fR -the allocated size of the buffer -.TP -\fB\fIkey\fR\fR -key location from where this buffer was extracted -.PP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 435 of file swmodule.h. -.SS void SWModule::renderFilter (char * buf, long size, \fBSWKey\fR * key)\fC [inline, virtual]\fR -.PP -RenderFilter a text buffer. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIbuf\fR\fR -the buffer to filter -.TP -\fB\fIsize\fR\fR -the allocated size of the buffer -.TP -\fB\fIkey\fR\fR -key location from where this buffer was extracted -.PP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 383 of file swmodule.h. -.SS void SWModule::stripFilter (char * buf, long size, \fBSWKey\fR * key)\fC [inline, virtual]\fR -.PP -StripFilter a text buffer. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIbuf\fR\fR -the buffer to filter -.TP -\fB\fIsize\fR\fR -the allocated size of the buffer -.TP -\fB\fIkey\fR\fR -key location from where this buffer was extracted -.PP -\fBReturns: \fR -.in +1c -*this -.PP -Definition at line 402 of file swmodule.h. -.SH MEMBER DATA DOCUMENTATION -.PP -.SS bool SWModule::terminateSearch -.PP -Set this bool to false to terminate the search which is executed by this module (\fBSearch\fR). -.PP -This is useful for threaded applications to terminate the search in another thread. -.PP -Definition at line 97 of file swmodule.h. - -.SH AUTHOR -.PP -Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file |