API-Documentation for Sword 1.5.10

00001 /******************************************************************************
00002  *  rawcom.h   - code for class 'RawCom'- a module that reads raw commentary
00003  *                      files:  ot and nt using indexs ??.bks ??.cps ??.vss
00004  *
00005  * $Id: rawcom.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 RAWCOM_H
00024 #define RAWCOM_H
00025 
00026 #include <rawverse.h>
00027 #include <swcom.h>
00028 
00029 #include <defs.h>
00030 
00031 SWORD_NAMESPACE_START
00032 
00033 class SWDLLEXPORT RawCom : public RawVerse, public SWCom {
00034 
00035 
00036 public:
00037     
00038         RawCom(const char *ipath, const char *iname = 0, const char *idesc = 0,
00039                         SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
00040                         SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
00041                         const char* ilang = 0);
00042         virtual ~RawCom();
00043 
00044         virtual SWBuf &getRawEntryBuf();
00045 
00046         virtual void increment(int steps);
00047         virtual void decrement(int steps) { increment(-steps); }
00048 
00049         // write interface ----------------------------
00050         virtual bool isWritable();
00051         static char createModule(const char *path) { return RawVerse::createModule(path); }
00052         virtual void setEntry(const char *inbuf, long len = -1);        // Modify current module entry
00053         virtual void linkEntry(const SWKey *linkKey);   // Link current module entry to other module entry
00054         virtual void deleteEntry();     // Delete current module entry
00055         // end write interface ------------------------
00056 
00057         SWMODULE_OPERATORS
00058 
00059 };
00060 
00061 SWORD_NAMESPACE_END
00062 
00063 #endif