1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*
* This source file is part of libRocket, the HTML/CSS Interface Middleware
*
* For the latest information, see http://www.librocket.com
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
#ifndef ROCKETCOREELEMENTSTYLE_H
#define ROCKETCOREELEMENTSTYLE_H
#include "ElementDefinition.h"
#include "../../Include/Rocket/Core/Types.h"
namespace Rocket {
namespace Core {
class ElementStyleCache;
typedef std::map<String, int> PropCounter;
/**
Manages an element's style and property information.
@author Lloyd Weehuizen
*/
class ElementStyle
{
public:
/// Constructor
/// @param[in] element The element this structure belongs to.
ElementStyle(Element* element);
~ElementStyle();
/// Returns the element's definition, updating if necessary.
const ElementDefinition* GetDefinition();
/// Update this definition if required
void UpdateDefinition();
/// Sets or removes a pseudo-class on the element.
/// @param[in] pseudo_class The pseudo class to activate or deactivate.
/// @param[in] activate True if the pseudo-class is to be activated, false to be deactivated.
void SetPseudoClass(const String& pseudo_class, bool activate);
/// Checks if a specific pseudo-class has been set on the element.
/// @param[in] pseudo_class The name of the pseudo-class to check for.
/// @return True if the pseudo-class is set on the element, false if not.
bool IsPseudoClassSet(const String& pseudo_class) const;
/// Gets a list of the current active pseudo classes
const PseudoClassList& GetActivePseudoClasses() const;
/// Sets or removes a class on the element.
/// @param[in] class_name The name of the class to add or remove from the class list.
/// @param[in] activate True if the class is to be added, false to be removed.
void SetClass(const String& class_name, bool activate);
/// Checks if a class is set on the element.
/// @param[in] class_name The name of the class to check for.
/// @return True if the class is set on the element, false otherwise.
bool IsClassSet(const String& class_name) const;
/// Specifies the entire list of classes for this element. This will replace any others specified.
/// @param[in] class_names The list of class names to set on the style, separated by spaces.
void SetClassNames(const String& class_names);
/// Return the active class list.
/// @return A string containing all the classes on the element, separated by spaces.
String GetClassNames() const;
/// Sets a local property override on the element.
/// @param[in] name The name of the new property.
/// @param[in] property The new property to set.
bool SetProperty(const String& name, const String& value);
/// Sets a local property override on the element to a pre-parsed value.
/// @param[in] name The name of the new property.
/// @param[in] property The parsed property to set.
bool SetProperty(const String& name, const Property& property);
/// Removes a local property override on the element; its value will revert to that defined in
/// the style sheet.
/// @param[in] name The name of the local property definition to remove.
void RemoveProperty(const String& name);
/// Returns one of this element's properties. If this element is not defined this property, or a parent cannot
/// be found that we can inherit the property from, the default value will be returned.
/// @param[in] name The name of the property to fetch the value for.
/// @return The value of this property for this element, or NULL if no property exists with the given name.
const Property* GetProperty(const String& name);
/// Returns one of this element's properties. If this element is not defined this property, NULL will be
/// returned.
/// @param[in] name The name of the property to fetch the value for.
/// @return The value of this property for this element, or NULL if this property has not been explicitly defined for this element.
const Property* GetLocalProperty(const String& name);
/// Resolves one of this element's properties. If the value is a number or px, this is returned. If it's a
/// percentage then it is resolved based on the second argument (the base value).
/// @param[in] property Property to resolve the value for.
/// @param[in] base_value The value that is scaled by the percentage value, if it is a percentage.
/// @return The value of this property for this element.
float ResolveProperty(const Property *property, float base_value);
/// Resolves one of this element's properties. If the value is a number or px, this is returned. If it's a
/// percentage then it is resolved based on the second argument (the base value).
/// @param[in] name The name of the property to resolve the value for.
/// @param[in] base_value The value that is scaled by the percentage value, if it is a percentage.
/// @return The value of this property for this element.
float ResolveProperty(const String& name, float base_value);
/// Iterates over the properties defined on the element.
/// @param[inout] index Index of the property to fetch. This is incremented to the next valid index after the fetch. Indices are not necessarily incremental.
/// @param[out] pseudo_classes The pseudo-classes the property is defined by.
/// @param[out] name The name of the property at the specified index.
/// @param[out] property The property at the specified index.
/// @return True if a property was successfully fetched.
bool IterateProperties(int& index, PseudoClassList& pseudo_classes, String& name, const Property*& property);
/// Returns the active style sheet for this element. This may be NULL.
StyleSheet* GetStyleSheet() const;
/// Mark definition and all children dirty
void DirtyDefinition();
/// Dirty all child definitions
void DirtyChildDefinitions();
// Dirties every property.
void DirtyProperties();
// Dirties em-relative properties.
void DirtyEmProperties();
// Dirties font-size on child elements if appropriate.
void DirtyInheritedEmProperties();
// Dirties rem properties.
void DirtyRemProperties();
/// Returns 'top', 'bottom', 'left' and 'right' properties from element's style or local cache.
void GetOffsetProperties(const Property **top, const Property **bottom, const Property **left, const Property **right );
/// Returns 'border-width' properties from element's style or local cache.
void GetBorderWidthProperties(const Property **border_top_width, const Property **border_bottom_width, const Property **border_left_width, const Property **border_right_width);
/// Returns 'margin' properties from element's style or local cache.
void GetMarginProperties(const Property **margin_top, const Property **margin_bottom, const Property **margin_left, const Property **margin_right);
/// Returns 'padding' properties from element's style or local cache.
void GetPaddingProperties(const Property **padding_top, const Property **padding_bottom, const Property **padding_left, const Property **padding_right);
/// Returns 'width' and 'height' properties from element's style or local cache.
void GetDimensionProperties(const Property **width, const Property **height);
/// Returns local 'width' and 'height' properties from element's style or local cache,
/// ignoring default values.
void GetLocalDimensionProperties(const Property **width, const Property **height);
/// Returns 'overflow' properties' values from element's style or local cache.
void GetOverflow(int *overflow_x, int *overflow_y);
/// Returns 'position' property value from element's style or local cache.
int GetPosition();
/// Returns 'float' property value from element's style or local cache.
int GetFloat();
/// Returns 'display' property value from element's style or local cache.
int GetDisplay();
/// Returns 'white-space' property value from element's style or local cache.
int GetWhitespace();
/// Returns 'line-height' property value from element's style or local cache.
const Property *GetLineHeightProperty();
/// Returns 'text-align' property value from element's style or local cache.
int GetTextAlign();
/// Returns 'text-transform' property value from element's style or local cache.
int GetTextTransform();
/// Returns 'vertical-align' property value from element's style or local cache.
const Property *GetVerticalAlignProperty();
static PropCounter &GetPropCounter();
private:
// Sets a single property as dirty.
void DirtyProperty(const String& property);
// Sets a list of properties as dirty.
void DirtyProperties(const PropertyNameList& properties, bool clear_em_properties = true);
// Sets a list of our potentially inherited properties as dirtied by an ancestor.
void DirtyInheritedProperties(const PropertyNameList& properties);
// Element these properties belong to
Element* element;
// The list of classes applicable to this object.
StringList classes;
// This element's current pseudo-classes.
PseudoClassList pseudo_classes;
// Any properties that have been overridden in this element.
PropertyDictionary* local_properties;
// All properties (including inherited) that are EM-relative.
PropertyNameList* em_properties;
// The definition of this element; if this is NULL one will be fetched from the element's style.
ElementDefinition* definition;
// Set if a new element definition should be fetched from the style.
bool definition_dirty;
// Set if a child element has a dirty style definition
bool child_definition_dirty;
// cached non-inherited properties
ElementStyleCache *cache;
};
}
}
#endif
|
