PropertyDictionary.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCOREPROPERTYDICTIONARY_H
00029 #define ROCKETCOREPROPERTYDICTIONARY_H
00030 
00031 #include <Rocket/Core/Header.h>
00032 #include <Rocket/Core/Property.h>
00033 
00034 namespace Rocket {
00035 namespace Core {
00036 
00037 typedef std::map< String, Property > PropertyMap;
00038 
00045 class ROCKETCORE_API PropertyDictionary
00046 {
00047 public:
00048         PropertyDictionary();
00049         ~PropertyDictionary();
00050 
00054         void SetProperty(const String& name, const Property& property);
00057         void RemoveProperty(const String& name);
00060         const Property* GetProperty(const String& name) const;
00061 
00064         int GetNumProperties() const;
00067         const PropertyMap& GetProperties() const;
00068 
00075         void Import(const PropertyDictionary& property_dictionary, int specificity = -1);
00076 
00082         void Merge(const PropertyDictionary& property_dictionary, int specificity_offset = 0);
00083 
00084 private:
00085         // Sets a property on the dictionary and its specificity if there is no name conflict, or its
00086         // specificity (given by the parameter, not read from the property itself) is at least equal to
00087         // the specificity of the conflicting property.
00088         void SetProperty(const String& name, const Rocket::Core::Property& property, int specificity);
00089 
00090         PropertyMap properties;
00091 };
00092 
00093 }
00094 }
00095 
00096 #endif