Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OgreConfigFile.h

Go to the documentation of this file.
00001 /*
00002 -----------------------------------------------------------------------------
00003 This source file is part of OGRE
00004     (Object-oriented Graphics Rendering Engine)
00005 For the latest info, see http://www.ogre3d.org/
00006 
00007 Copyright (c) 2000-2005 The OGRE Team
00008 Also see acknowledgements in Readme.html
00009 
00010 This program is free software; you can redistribute it and/or modify it under
00011 the terms of the GNU Lesser General Public License as published by the Free Software
00012 Foundation; either version 2 of the License, or (at your option) any later
00013 version.
00014 
00015 This program is distributed in the hope that it will be useful, but WITHOUT
00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
00018 
00019 You should have received a copy of the GNU Lesser General Public License along with
00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
00022 http://www.gnu.org/copyleft/lesser.txt.
00023 -----------------------------------------------------------------------------
00024 */
00025 #ifndef __ConfigFile_H__
00026 #define __ConfigFile_H__
00027 
00028 #include "OgrePrerequisites.h"
00029 
00030 #include "OgreString.h"
00031 #include "OgreStringVector.h"
00032 #include "OgreIteratorWrappers.h"
00033 #include "OgreDataStream.h"
00034 
00035 namespace Ogre {
00036 
00052     class _OgreExport ConfigFile
00053     {
00054     public:
00055 
00056         ConfigFile();
00057         virtual ~ConfigFile();
00059         void load(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
00061         void load(const String& filename, const String& resourceGroup, const String& separators = "\t:=", bool trimWhitespace = true);
00063         void load(const DataStreamPtr& stream, const String& separators = "\t:=", bool trimWhitespace = true);
00065         void loadDirect(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
00067         void loadFromResourceSystem(const String& filename, const String& resourceGroup, const String& separators = "\t:=", bool trimWhitespace = true);
00068 
00073         String getSetting(const String& key, const String& section = StringUtil::BLANK) const;
00075         StringVector getMultiSetting(const String& key, const String& section = StringUtil::BLANK) const;
00076 
00077         typedef std::multimap<String, String> SettingsMultiMap;
00078         typedef MapIterator<SettingsMultiMap> SettingsIterator;
00080         typedef std::map<String, SettingsMultiMap*> SettingsBySection;
00081         typedef MapIterator<SettingsBySection> SectionIterator;
00083         SectionIterator getSectionIterator(void);
00085         SettingsIterator getSettingsIterator(const String& section = StringUtil::BLANK);
00086 
00087 
00088         
00090         void clear(void);
00091     protected:
00092         SettingsBySection mSettings;
00093     };
00094 
00095 }
00096 
00097 
00098 #endif

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 12:59:42 2006