diff options
Diffstat (limited to 'src/backend/keys/cswordversekey.h')
-rw-r--r-- | src/backend/keys/cswordversekey.h | 140 |
1 files changed, 71 insertions, 69 deletions
diff --git a/src/backend/keys/cswordversekey.h b/src/backend/keys/cswordversekey.h index e421b6c..0f286dc 100644 --- a/src/backend/keys/cswordversekey.h +++ b/src/backend/keys/cswordversekey.h @@ -44,79 +44,81 @@ class CSwordModuleInfo; class CSwordVerseKey : public CSwordKey, public sword::VerseKey { -public: - enum JumpType { - UseBook, - UseChapter, - UseVerse - }; + 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 ); + /** + * 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 ); + /** + * 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; + 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); }; + 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 |