The SWORD Project  1.9.0.svnversion
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
rawcom.h
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  * rawcom.h - class RawCom: a module driver that supports commentary
4  * modules uncompressed with entry size 2 bytes or less
5  *
6  * $Id: rawcom.h 3786 2020-08-30 11:35:14Z scribe $
7  *
8  * Copyright 1997-2013 CrossWire Bible Society (http://www.crosswire.org)
9  * CrossWire Bible Society
10  * P. O. Box 2528
11  * Tempe, AZ 85280-2528
12  *
13  * This program is free software; you can redistribute it and/or modify it
14  * under the terms of the GNU General Public License as published by the
15  * Free Software Foundation version 2.
16  *
17  * This program is distributed in the hope that it will be useful, but
18  * WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20  * General Public License for more details.
21  *
22  */
23 
24 #ifndef RAWCOM_H
25 #define RAWCOM_H
26 
27 #include <rawverse.h>
28 #include <swcom.h>
29 
30 #include <defs.h>
31 
33 
34 class SWDLLEXPORT RawCom : public RawVerse, public SWCom {
35 
36 public:
37  RawCom(const char *ipath, const char *iname = 0, const char *idesc = 0,
38  SWDisplay *idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
40  const char *ilang = 0, const char *versification = "KJV");
41  virtual ~RawCom();
42 
43  virtual SWBuf &getRawEntryBuf() const;
44 
45  virtual void increment(int steps = 1);
46  virtual void decrement(int steps = 1) { increment(-steps); }
47 
48  // write interface ----------------------------
49  virtual bool isWritable() const;
50  static char createModule(const char *path, const char *v11n = "KJV") { return RawVerse::createModule(path, v11n); }
51  virtual void setEntry(const char *inbuf, long len = -1); // Modify current module entry
52  virtual void linkEntry(const SWKey *linkKey); // Link current module entry to other module entry
53  virtual void deleteEntry(); // Delete current module entry
54  // end write interface ------------------------
55 
56  virtual bool isLinked(const SWKey *k1, const SWKey *k2) const;
57  virtual bool hasEntry(const SWKey *k) const;
58 
59 
61 
62 };
63 
65 
66 #endif
#define SWTextEncoding
Definition: swmodule.h:78
#define SWORD_NAMESPACE_START
Definition: defs.h:39
Definition: swbuf.h:47
Definition: rawcom.h:34
#define SWDLLEXPORT
Definition: defs.h:171
virtual void deleteEntry()
Definition: swmodule.h:525
virtual void setEntry(const char *inbuf, long len=-1)
Definition: swmodule.cpp:1680
virtual void decrement(int steps=1)
Definition: rawcom.h:46
SWBuf v11n
Definition: osis2mod.cpp:107
virtual bool isLinked(const SWKey *, const SWKey *) const
Definition: swmodule.h:808
virtual void linkEntry(const SWKey *sourceKey)
Definition: swmodule.cpp:1683
virtual bool isWritable() const
Definition: swmodule.h:506
virtual bool hasEntry(const SWKey *) const
Definition: swmodule.h:809
virtual void increment(int steps=1)
Definition: swmodule.cpp:355
Definition: swcom.h:49
virtual SWBuf & getRawEntryBuf() const =0
static char createModule(const char *path, const char *v11n="KJV")
Definition: rawverse.cpp:248
#define SWMODULE_OPERATORS
Definition: swmodule.h:54
#define SWTextDirection
Definition: swmodule.h:77
#define SWORD_NAMESPACE_END
Definition: defs.h:40
Definition: swkey.h:77
#define SWTextMarkup
Definition: swmodule.h:79
static char createModule(const char *path, const char *v11n="KJV")
Definition: rawcom.h:50