Property.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 ROCKETCOREPROPERTY_H
00029 #define ROCKETCOREPROPERTY_H
00030 
00031 #include <Rocket/Core/Variant.h>
00032 #include <Rocket/Core/Header.h>
00033 
00034 namespace Rocket {
00035 namespace Core {
00036 
00037 class PropertyDefinition;
00038 
00043 class ROCKETCORE_API Property
00044 {
00045 public:
00046         enum Unit
00047         {
00048                 UNKNOWN = 1 << 0,
00049 
00050                 KEYWORD = 1 << 1,                       // generic keyword; fetch as < int >
00051 
00052                 STRING = 1 << 2,                        // generic string; fetch as < String >
00053 
00054                 // Absolute values.
00055                 NUMBER = 1 << 3,                        // number unsuffixed; fetch as < float >
00056                 PX = 1 << 4,                            // number suffixed by 'px'; fetch as < float >
00057                 COLOUR = 1 << 5,                        // colour; fetch as < Colourb >
00058                 ABSOLUTE_UNIT = NUMBER | PX | COLOUR,
00059 
00060                 // Relative values.
00061                 EM = 1 << 6,                            // number suffixed by 'em'; fetch as < float >
00062                 PERCENT = 1 << 7,                       // number suffixed by '%'; fetch as < float >
00063                 RELATIVE_UNIT = EM | PERCENT
00064         };
00065 
00066         Property();
00067         template < typename PropertyType >
00068         Property(PropertyType value, Unit unit, int specificity = -1) : value(Variant(value)), unit(unit), specificity(specificity)
00069         {
00070                 definition = NULL;
00071                 parser_index = -1;
00072 
00073                 source_line_number = 0;
00074         }
00075 
00076         ~Property();    
00077 
00079         String ToString() const;
00080 
00082         template <typename T>
00083         T Get() const
00084         {
00085                 return value.Get<T>();
00086         }
00087 
00088         Variant value;
00089         Unit unit;
00090         int specificity;
00091 
00092         const PropertyDefinition* definition;
00093         int parser_index;
00094 
00095         String source;
00096         int source_line_number;
00097 };
00098 
00099 }
00100 }
00101 
00102 #endif