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-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef __ConfigFile_H__
    00029 #define __ConfigFile_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032
    00033 #include "OgreString.h"
    00034 #include "OgreStringVector.h"
    00035 #include "OgreIteratorWrappers.h"
    00036 #include "OgreDataStream.h"
    00037
    00038 namespace Ogre {
    00039
    00061     class _OgreExport ConfigFile : public ConfigAlloc
    00062     {
    00063     public:
    00064
    00065         ConfigFile();
    00066         virtual ~ConfigFile();
    00068         void load(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
    00070         void load(const String& filename, const String& resourceGroup, const String& separators = "\t:=", bool trimWhitespace = true);
    00072         void load(const DataStreamPtr& stream, const String& separators = "\t:=", bool trimWhitespace = true);
    00074         void loadDirect(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
    00076         void loadFromResourceSystem(const String& filename, const String& resourceGroup, const String& separators = "\t:=", bool trimWhitespace = true);
    00077
    00083         String getSetting(const String& key, const String& section = StringUtil::BLANK, const String& defaultValue = StringUtil::BLANK) const;
    00085         StringVector getMultiSetting(const String& key, const String& section = StringUtil::BLANK) const;
    00086
    00087         typedef multimap<String, String>::type SettingsMultiMap;
    00088         typedef MapIterator<SettingsMultiMap> SettingsIterator;
    00090         typedef map<String, SettingsMultiMap*>::type SettingsBySection;
    00091         typedef MapIterator<SettingsBySection> SectionIterator;
    00093         SectionIterator getSectionIterator(void);
    00095         SettingsIterator getSettingsIterator(const String& section = StringUtil::BLANK);
    00096
    00097
    00098
    00100         void clear(void);
    00101     protected:
    00102         SettingsBySection mSettings;
    00103     };
    00107 }
    00108
    00109
    00110 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:51