| The Sword Project: sword::RawText Class Reference |
Public Member Functions | |
| RawText (const char *ipath, const char *iname=0, const char *idesc=0, SWDisplay *idisp=0, char encoding=ENC_UNKNOWN, char dir=DIRECTION_LTR, char markup=FMT_UNKNOWN, const char *ilang=0) | |
| virtual SWBuf & | getRawEntryBuf () |
| This function is reimplemented by the different kinds of module objects. | |
| virtual void | increment (int steps=1) |
| Increments module key a number of entries. | |
| virtual void | decrement (int steps=1) |
| Decrements module key a number of entries. | |
| virtual signed char | createSearchFramework (void(*percent)(char, void *)=&nullPercent, void *percentUserData=0) |
| ask the object to build any indecies it wants for optimal searching | |
| virtual void | deleteSearchFramework () |
| virtual bool | hasSearchFramework () |
| was SWORD compiled with code to optimize searching for this driver? | |
| virtual ListKey & | search (const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&SWModule::nullPercent, void *percentUserData=0) |
| Searches a module for a string. | |
| virtual bool | isWritable () |
| Is the module writable? :). | |
| virtual void | setEntry (const char *inbuf, long len=-1) |
| Modify the current module entry text - only if module isWritable(). | |
| virtual void | linkEntry (const SWKey *linkKey) |
| Link the current module entry to another module entry - only if module isWritable(). | |
| virtual void | deleteEntry () |
| Delete current module entry - only if module isWritable(). | |
| operator const char * () | |
| operator SWKey & () | |
| operator SWKey * () | |
| SWModule & | operator<< (const char *inbuf) |
| SWModule & | operator<< (const SWKey *sourceKey) |
| SWModule & | operator-= (int steps) |
| SWModule & | operator+= (int steps) |
| SWModule & | operator++ (int) |
| SWModule & | operator-- (int) |
| SWModule & | operator= (SW_POSITION p) |
Static Public Member Functions | |
| static char | createModule (const char *path) |
Private Attributes | |
| RawStr * | fastSearch [2] |
Definition at line 35 of file rawtext.h.
| virtual SWBuf& sword::RawText::getRawEntryBuf | ( | ) | [virtual] |
This function is reimplemented by the different kinds of module objects.
Implements sword::SWModule.
| virtual void sword::RawText::increment | ( | int | steps = 1 |
) | [virtual] |
Increments module key a number of entries.
| steps | Number of entries to jump forward |
Reimplemented from sword::SWModule.
| virtual void sword::RawText::decrement | ( | int | steps = 1 |
) | [inline, virtual] |
Decrements module key a number of entries.
| steps | Number of entries to jump backward |
Reimplemented from sword::SWModule.
Definition at line 46 of file rawtext.h.
References sword::SWModule::increment().
| virtual ListKey& sword::RawText::search | ( | const char * | istr, | |
| int | searchType = 0, |
|||
| int | flags = 0, |
|||
| SWKey * | scope = 0, |
|||
| bool * | justCheckIfSupported = 0, |
|||
| void(*)(char, void *) | percent = &SWModule::nullPercent, |
|||
| void * | percentUserData = 0 | |||
| ) | [virtual] |
Searches a module for a string.
| istr | string for which to search | |
| searchType | type of search to perform >=0 - regex -1 - phrase -2 - multiword -3 - entryAttrib (eg. Word//Strongs/G1234/) -4 - Lucene | |
| flags | options flags for search | |
| scope | Key containing the scope. VerseKey or ListKey are useful here. | |
| justCheckIfSupported | if set, don't search, only tell if this function supports requested search. | |
| percent | Callback function to get the current search status in %. | |
| percentUserData | User data that is given to the callback function as parameter. |
Reimplemented from sword::SWModule.
| virtual bool sword::RawText::isWritable | ( | ) | [virtual] |
| The SWORD Project; P. O. Box 2528; Tempe, AZ 85280-2528 USA |