diff options
author | Roberto C. Sanchez <roberto@connexer.com> | 2014-10-21 22:48:29 -0400 |
---|---|---|
committer | Roberto C. Sanchez <roberto@connexer.com> | 2014-10-21 22:48:29 -0400 |
commit | e8a196082586bb68e0bf254a8f6f4b8f39071f32 (patch) | |
tree | b03dbbd1b5be6092ed5e9bcb3806aa2d4938bba3 /src/backend/keys/cswordtreekey.h | |
parent | dd2f7ce46df53f2c377c02d1bf4df8adcf092072 (diff) |
Imported Upstream version 2.3.3
Diffstat (limited to 'src/backend/keys/cswordtreekey.h')
-rw-r--r-- | src/backend/keys/cswordtreekey.h | 94 |
1 files changed, 48 insertions, 46 deletions
diff --git a/src/backend/keys/cswordtreekey.h b/src/backend/keys/cswordtreekey.h index 4114652..c0c9e45 100644 --- a/src/backend/keys/cswordtreekey.h +++ b/src/backend/keys/cswordtreekey.h @@ -25,55 +25,57 @@ class CSwordModuleInfo; 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; + 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 ); + /** + * 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; + 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); }; + 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 |