API-Documentation for Sword 1.5.10

00001 /******************************************************************************
00002  *  rawtext.h   - code for class 'RawText'- a module that reads raw text files:
00003  *                ot and nt using indexs ??.bks ??.cps ??.vss
00004  *
00005  * $Id: rawtext.h 1864 2005-11-20 06:06:40Z scribe $
00006  *
00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
00008  *      CrossWire Bible Society
00009  *      P. O. Box 2528
00010  *      Tempe, AZ  85280-2528
00011  *
00012  * This program is free software; you can redistribute it and/or modify it
00013  * under the terms of the GNU General Public License as published by the
00014  * Free Software Foundation version 2.
00015  *
00016  * This program is distributed in the hope that it will be useful, but
00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019  * General Public License for more details.
00020  *
00021  */
00022 
00023 #ifndef RAWTEXT_H
00024 #define RAWTEXT_H
00025 
00026 #include <rawverse.h>
00027 #include <swtext.h>
00028 
00029 #include <defs.h>
00030 
00031 SWORD_NAMESPACE_START
00032 
00033 class RawStr;
00034 
00035 class SWDLLEXPORT RawText : public SWText, public RawVerse {
00036 
00037         RawStr *fastSearch[2];
00038 
00039 public:
00040   
00041         RawText(const char *ipath, const char *iname = 0, const char *idesc = 0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
00042         const char* ilang = 0);
00043         virtual ~RawText();
00044         virtual SWBuf &getRawEntryBuf();
00045         virtual void increment(int steps = 1);
00046         virtual void decrement(int steps = 1) { increment(-steps); }
00047         virtual signed char createSearchFramework(
00048                         void (*percent) (char, void *) = &nullPercent,
00049                         void *percentUserData = 0);
00050         virtual void deleteSearchFramework();
00051         virtual bool hasSearchFramework() { return true; }
00052         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);
00053         // write interface ----------------------------
00054         virtual bool isWritable();
00055         static char createModule(const char *path) { return RawVerse::createModule(path); }
00056         virtual void setEntry(const char *inbuf, long len = -1);        // Modify current module entry
00057         virtual void linkEntry(const SWKey *linkKey);   // Link current module entry to other module entry
00058         virtual void deleteEntry();     // Delete current module entry
00059         // end write interface ------------------------
00060 
00061         SWMODULE_OPERATORS
00062 
00063 };
00064 
00065 SWORD_NAMESPACE_END
00066 #endif