blob: c0c9e45a4bf752ac6d5bf2eda9eaa09c36bd1ad6 (
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
|
/*********
*
* 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 CSWORDTREEKEYIDX_H
#define CSWORDTREEKEYIDX_H
//BibleTime
#include "cswordkey.h"
//Sword
#include <treekeyidx.h>
class CSwordModuleInfo;
/** BibleTime's implementation of Sword's TreeKeyIdx class.
* @short CSwordKey implementation for Sword's TreeKey
* @author The BibleTime team
*/
class CSwordTreeKey : public CSwordKey, public sword::TreeKeyIdx {
public:
/** Constructor of this CSwordKey implementation.
* @param k The Sword tree key which belongs to this key
* @param module The module which belongs to this key
*/
CSwordTreeKey( const sword::TreeKeyIdx *k, CSwordModuleInfo* module );
/** Copy constructor.
*/
CSwordTreeKey( const CSwordTreeKey& k );
/** The module which belongs to this key.
* @return The module.
*/
virtual CSwordModuleInfo* module( CSwordModuleInfo* const newModule );
/** Copy method.
* @return A new copy of this object.
*/
virtual CSwordTreeKey* copy() const;
/**
* Returns the TreeKeyIdx::getLocalKey value in unicode.
* Local key is the last part of the tree key, for example "Subsection1" from "/Section1/Subsection1".
* Use this instead of getLocalKey() to avoid encoding problems.
*/
QString getLocalNameUnicode();
/**
* Returns the current key as unicode decoded QString.
*/
virtual QString key() const;
/**
* Set the key. If the parameter is empty or null, the key will be set to "/"
*/
virtual bool key( const QString& key );
/**
* Set the key from char* To avoid encoding problems use key(QString instead),
* otherwise it is caller's responsibility to ensure the correct encoding (utf8/latin1).
*/
virtual bool key( const char* key );
protected:
/**
* Returns the raw key appropriate for use directly with Sword.
*/
virtual const char * rawKey() const;
private:
/** Disable assignment operator */
CSwordTreeKey& operator= (const CSwordTreeKey&);
/** Disable from base class to prevent compiler warnings */
inline virtual CSwordTreeKey& operator= (const sword::TreeKeyIdx&) {
return (*this);
};
};
#endif
|
