blob: bfbfa2520bdb85637b9a33d91fd5ec42d3eb455d (
plain)
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/*********
*
* This file is part of BibleTime's source code, http://www.bibletime.info/.
*
* Copyright 1999-2008 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License version 2.0.
*
**********/
#ifndef CSWORDVERSEKEY_H
#define CSWORDVERSEKEY_H
#include "backend/keys/cswordkey.h"
#include <QString>
// Sword includes:
#include <versekey.h>
class CSwordModuleInfo;
/**
* The CSwordKey implementation for verse based modules (Bibles and Commentaries)
*
* This class is the implementation of CKey for verse based modules like
* Bibles and commentaries.
* This class provides the special functions to work with the verse based modules.
*
* Useful functions are
* @see NextBook()
* @see PreviousBook()
* @see NextChapter()
* @see PreviousChapter()
* @see NextVerse()
* @see PreviousVerse().
*
* Call the constructor only with a valid verse based modules, otherwise this key will be invalid
* and the application will probably crash.
*
* @version $Id: cswordversekey.h,v 1.26 2006/02/25 11:38:15 joachim Exp $
* @short CSwordKey implementation for Sword's VerseKey.
* @author The BibleTime team
*/
class CSwordVerseKey : public CSwordKey, public sword::VerseKey {
public:
enum JumpType {
UseBook,
UseChapter,
UseVerse
};
/**
* Constructor of this class.
*
* This function will construct a versekey with the current module position
* and it will setup the m_module members.
*
*/
CSwordVerseKey( CSwordModuleInfo* const module );
/**
* Copy constructor.
*/
CSwordVerseKey( const CSwordVerseKey& k );
/**
* VerseKey based constructor.
*/
CSwordVerseKey( const sword::VerseKey* const k, CSwordModuleInfo* const module );
/**
* Clones this object.
*/
virtual CSwordKey* copy() const;
/**
* Set/get the key. If the parameter is not set (means equal to QString::null)
* the used key is returned. Otherwise the key is set and the new on ei returned.
*/
virtual QString key() const;
/**
* Set the current key.
*/
virtual bool key( const QString& );
/**
* Set/get the key. If the parameter is not set (means equal to QString::null)
* the used key is returned. Otherwise the key is set and the new on ei returned.
*/
virtual bool key( const char* key );
/**
* Jumps to the next entry of the given type
*/
bool next( const JumpType type );
/**
* Jumps to the previous entry of the given type
*/
bool previous ( const JumpType type );
/**
* This functions returns the current book as localised text, not as book numer.
*
* Use "char Book()" to retrieve the book number of the current book.
* @return The name of the current book
*/
QString book(const QString& newBook = QString::null);
/**
* Sets the module for this key
*/
virtual CSwordModuleInfo* module( CSwordModuleInfo* const newModule = 0 );
protected:
/**
* Returns the raw key appropriate for use directly with Sword.
*/
virtual const char * rawKey() const;
private:
/** Disable assignment operator */
CSwordVerseKey& operator= (const CSwordVerseKey&);
/** Disable from base class to prevent compiler warnings */
inline virtual CSwordVerseKey& operator= (const sword::VerseKey&) {
return (*this);
};
};
#endif
|
