FontEffectInstancer.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 ROCKETCOREFONTEFFECTINSTANCER_H
00029 #define ROCKETCOREFONTEFFECTINSTANCER_H
00030 
00031 #include <Rocket/Core/ReferenceCountable.h>
00032 #include <Rocket/Core/Header.h>
00033 #include <Rocket/Core/PropertyDictionary.h>
00034 #include <Rocket/Core/PropertySpecification.h>
00035 
00036 namespace Rocket {
00037 namespace Core {
00038 
00039 class FontEffect;
00040 
00050 class ROCKETCORE_API FontEffectInstancer : public ReferenceCountable
00051 {
00052 public:
00053         FontEffectInstancer();
00054         virtual ~FontEffectInstancer();
00055 
00060         virtual FontEffect* InstanceFontEffect(const String& name, const PropertyDictionary& properties) = 0;
00063         virtual void ReleaseFontEffect(FontEffect* font_effect) = 0;
00064 
00066         virtual void Release() = 0;
00067 
00069         const PropertySpecification& GetPropertySpecification() const;
00070 
00071 protected:
00077         PropertyDefinition& RegisterProperty(const String& property_name, const String& default_value, bool affects_generation = true);
00083         bool RegisterShorthand(const String& shorthand_name, const String& property_names, PropertySpecification::ShorthandType type = PropertySpecification::AUTO);
00084 
00085         // Releases the instancer.
00086         virtual void OnReferenceDeactivate();
00087 
00088 private:
00089         PropertySpecification properties;
00090 
00091         // Properties that define the geometry.
00092         std::set< String > volatile_properties;
00093 
00094         friend class Factory;
00095 };
00096 
00097 }
00098 }
00099 
00100 #endif