API-Documentation for Sword 1.5.10

00001 /******************************************************************************
00002  *  rawld.cpp - code for class 'RawLD'- a module that reads raw lexicon and
00003  *                              dictionary files: *.dat *.idx
00004  *
00005  * $Id: rawld4.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 RAWLD4_H
00024 #define RAWLD4_H
00025 
00026 #include <rawstr4.h>
00027 #include <swld.h>
00028 
00029 #include <defs.h>
00030 
00031 SWORD_NAMESPACE_START
00032 
00033 class SWDLLEXPORT RawLD4 : public RawStr4, public SWLD {
00034         void strongsPad(char *buf);
00035         char getEntry(long away = 0);
00036 
00037 public:
00038 
00039 
00040         RawLD4(const char *ipath, const char *iname = 0, const char *idesc = 0,
00041                         SWDisplay *idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
00042                         SWTextDirection dir = DIRECTION_LTR,
00043                         SWTextMarkup markup = FMT_UNKNOWN, const char *ilang = 0);
00044 
00045         virtual ~RawLD4();
00046         virtual SWBuf &getRawEntryBuf();
00047 
00048         virtual void increment(int steps = 1);
00049         virtual void decrement(int steps = 1) { increment(-steps); }
00050         // write interface ----------------------------
00051         virtual bool isWritable();
00052         static char createModule(const char *path) { return RawStr4::createModule(path); }
00053 
00054         virtual void setEntry(const char *inbuf, long len = -1);        // Modify current module entry
00055         virtual void linkEntry(const SWKey *linkKey);   // Link current module entry to other module entry
00056         virtual void deleteEntry();     // Delete current module entry
00057         // end write interface ------------------------
00058 
00059 
00060         // OPERATORS -----------------------------------------------------------------
00061         
00062         SWMODULE_OPERATORS
00063 
00064 };
00065 
00066 SWORD_NAMESPACE_END
00067 #endif