OGRE: OgreConfigFile.h Source File - OGRE Documentation

# 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-2006 Torus Knot Software Ltd
    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 You may alternatively use this source under the terms of a specific version of
    00025 the OGRE Unrestricted License provided you have obtained such a license from
    00026 Torus Knot Software Ltd.
    00027 -----------------------------------------------------------------------------
    00028 */
    00029 #ifndef __ConfigFile_H__
    00030 #define __ConfigFile_H__
    00031
    00032 #include "OgrePrerequisites.h"
    00033
    00034 #include "OgreString.h"
    00035 #include "OgreStringVector.h"
    00036 #include "OgreIteratorWrappers.h"
    00037 #include "OgreDataStream.h"
    00038
    00039 namespace Ogre {
    00040
    00056     class _OgreExport ConfigFile : public ConfigAlloc
    00057     {
    00058     public:
    00059
    00060         ConfigFile();
    00061         virtual ~ConfigFile();
    00063         void load(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
    00065         void load(const String& filename, const String& resourceGroup, const String& separators = "\t:=", bool trimWhitespace = true);
    00067         void load(const DataStreamPtr& stream, const String& separators = "\t:=", bool trimWhitespace = true);
    00069         void loadDirect(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
    00071         void loadFromResourceSystem(const String& filename, const String& resourceGroup, const String& separators = "\t:=", bool trimWhitespace = true);
    00072
    00078         String getSetting(const String& key, const String& section = StringUtil::BLANK, const String& defaultValue = StringUtil::BLANK) const;
    00080         StringVector getMultiSetting(const String& key, const String& section = StringUtil::BLANK) const;
    00081
    00082         typedef std::multimap<String, String> SettingsMultiMap;
    00083         typedef MapIterator<SettingsMultiMap> SettingsIterator;
    00085         typedef std::map<String, SettingsMultiMap*> SettingsBySection;
    00086         typedef MapIterator<SettingsBySection> SectionIterator;
    00088         SectionIterator getSectionIterator(void);
    00090         SettingsIterator getSettingsIterator(const String& section = StringUtil::BLANK);
    00091
    00092
    00093
    00095         void clear(void);
    00096     protected:
    00097         SettingsBySection mSettings;
    00098     };
    00099
    00100 }
    00101
    00102
    00103 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 26 11:32:17 2009