1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/******************************************************************************
*
* swcom.h - code for base class 'SWCom'. SWCom is the basis for all
* types of commentary modules.
* It is traditionally close to the same as the SWText
* module type, but has defaults set which more
* closely represent how a commentary will be used and how
* the bulk of our commentaries expect to be used. For example,
* most commentaries consist of entries for a range of text
* (Matt.1.1-6: "Matthew begins with by telling us..."). This
* same entry will be returned when any verse between Matt.1.1-6
* is requested from the engine. This is done with verse linking.
* Since linking is used heavily in commentaries, the flag
* skipConsecutiveLinks is defaulted to true so when the
* commentary is incremented, it will go to the next ENTRY,
* not the next verse (likely Matt.1.7, from our example above).
*
* $Id: swcom.h 2833 2013-06-29 06:40:28Z chrislit $
*
* Copyright 1997-2013 CrossWire Bible Society (http://www.crosswire.org)
* CrossWire Bible Society
* P. O. Box 2528
* Tempe, AZ 85280-2528
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation version 2.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
*/
#ifndef SWCOM_H
#define SWCOM_H
#include <swmodule.h>
#include <defs.h>
SWORD_NAMESPACE_START
class VerseKey;
class SWKey;
/** The basis for all commentary modules
*/
class SWDLLEXPORT SWCom : public SWModule {
mutable VerseKey *tmpVK1;
mutable VerseKey *tmpVK2;
mutable bool tmpSecond;
char *versification;
protected:
VerseKey &getVerseKey(const SWKey *key = 0) const;
public:
/** Initializes data for instance of SWCom
*/
SWCom(const char *imodname = 0, const char *imoddesc = 0,
SWDisplay *idisp = 0, SWTextEncoding enc = ENC_UNKNOWN,
SWTextDirection dir = DIRECTION_LTR,
SWTextMarkup mark = FMT_UNKNOWN, const char *ilang = 0,
const char *versification = "KJV");
virtual ~SWCom();
virtual SWKey *createKey() const;
virtual long getIndex() const;
virtual void setIndex(long iindex);
// OPERATORS -----------------------------------------------------------------
SWMODULE_OPERATORS
};
SWORD_NAMESPACE_END
#endif
|
