summaryrefslogtreecommitdiff
path: root/src/backend/drivers/cswordbookmoduleinfo.h
blob: 77adb29f80f501dd2066743a39fb9eeaaec4aeec (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
/*********
*
* 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 CSWORDGENBOOKMODULEINFO_H
#define CSWORDGENBOOKMODULEINFO_H

#include "backend/drivers/cswordmoduleinfo.h"

// Sword includes:
#include <treekeyidx.h>


/** Class for generic book support
  * @author The BibleTime team
  */

class CSwordBookModuleInfo : public CSwordModuleInfo {

    public:
        /** Constructor.
        * @param module The module which belongs to this object
        * @param backend The parent backend for this book module.
        */
        CSwordBookModuleInfo( sword::SWModule* module, CSwordBackend* const backend );
        /** Copy constructor.
        * Copy constructor to copy the passed parameter.
        * @param module The module which should be copied.
        */
        CSwordBookModuleInfo( const CSwordBookModuleInfo& module );
        /** Destructor.
        */
        ~CSwordBookModuleInfo();
        /**
        * Returns the type of the module.
        */
        virtual CSwordModuleInfo::ModuleType type() const;
        /**
        * Returns the maximal depth of sections and subsections.
        */
        int depth();
        /**
        * @return A treekey filled with the structure of this module. Don't delete the returned key because it's casted from the module object.
        */
        sword::TreeKeyIdx* tree() const;

    private:
        /**
        * A recursive helper function to help computng the module depth!
        */
        void computeDepth(sword::TreeKeyIdx* key, int level = 0 );
        int m_depth;
};

inline CSwordBookModuleInfo::ModuleType CSwordBookModuleInfo::type() const {
    return CSwordModuleInfo::GenericBook;
}


#endif