[9559] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
| 3 | * > www.orxonox.net < |
---|
| 4 | * |
---|
| 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
| 22 | * Author: |
---|
| 23 | * Fabian 'x3n' Landau |
---|
| 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
| 29 | /** |
---|
| 30 | @file |
---|
| 31 | @ingroup Config ConfigFile |
---|
| 32 | */ |
---|
| 33 | |
---|
| 34 | #ifndef _ConfigFileEntryValue_H__ |
---|
| 35 | #define _ConfigFileEntryValue_H__ |
---|
| 36 | |
---|
| 37 | #include "core/CorePrereqs.h" |
---|
| 38 | |
---|
[9684] | 39 | #include <string> |
---|
[9559] | 40 | #include "ConfigFileEntry.h" |
---|
| 41 | |
---|
| 42 | namespace orxonox |
---|
| 43 | { |
---|
| 44 | ////////////////////////// |
---|
| 45 | // ConfigFileEntryValue // |
---|
| 46 | ////////////////////////// |
---|
| 47 | /** |
---|
| 48 | @brief This class represents a normal value in the config file. |
---|
| 49 | */ |
---|
| 50 | class _CoreExport ConfigFileEntryValue : public ConfigFileEntry |
---|
| 51 | { |
---|
| 52 | public: |
---|
| 53 | /** |
---|
| 54 | @brief Constructor: Initializes the entry. |
---|
| 55 | |
---|
| 56 | @param name The name of the entry |
---|
| 57 | @param value The value of the entry |
---|
| 58 | @param bString If true, the value is treated as string which means some special treatment of special characters. |
---|
| 59 | @param additionalComment An optional comment that will be placed behind the value in the config file |
---|
| 60 | */ |
---|
| 61 | inline ConfigFileEntryValue(const std::string& name, const std::string& value = "", bool bString = false, const std::string& additionalComment = "") |
---|
| 62 | : name_(name) |
---|
| 63 | , value_(value) |
---|
| 64 | , additionalComment_(additionalComment) |
---|
| 65 | , bString_(bString) |
---|
| 66 | { this->update(); } |
---|
| 67 | |
---|
| 68 | /// Destructor |
---|
| 69 | inline virtual ~ConfigFileEntryValue() {} |
---|
| 70 | |
---|
| 71 | inline virtual const std::string& getName() const |
---|
| 72 | { return this->name_; } |
---|
| 73 | |
---|
| 74 | inline virtual void setComment(const std::string& comment) |
---|
| 75 | { this->additionalComment_ = comment; this->update(); } |
---|
| 76 | |
---|
| 77 | inline virtual void setValue(const std::string& value) |
---|
| 78 | { this->value_ = value; this->update(); } |
---|
| 79 | inline virtual const std::string& getValue() const |
---|
| 80 | { return this->value_; } |
---|
| 81 | |
---|
| 82 | inline void virtual setString(bool bString) |
---|
| 83 | { this->bString_ = bString; this->update(); } |
---|
| 84 | |
---|
| 85 | inline virtual const std::string& getFileEntry() const |
---|
| 86 | { return this->fileEntry_; } |
---|
| 87 | |
---|
| 88 | /// Returns the "key" of the value (in this case it's just the name of the entry, but for vectors it's different) |
---|
| 89 | inline virtual const std::string& getKeyString() const |
---|
| 90 | { return this->name_; } |
---|
| 91 | |
---|
| 92 | protected: |
---|
| 93 | virtual void update(); |
---|
| 94 | |
---|
| 95 | const std::string name_; ///< The name of the value |
---|
| 96 | std::string value_; ///< The value |
---|
| 97 | std::string additionalComment_; ///< The additional comment |
---|
| 98 | std::string fileEntry_; ///< The string as it will be stored in the config file |
---|
| 99 | bool bString_; ///< If true, the value is treated as string which means some special treatment of special characters. |
---|
| 100 | }; |
---|
| 101 | } |
---|
| 102 | |
---|
| 103 | #endif /* _ConfigFileEntryValue_H__ */ |
---|