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
|
/*
* 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 ROCKETCOREELEMENTDOCUMENT_H
#define ROCKETCOREELEMENTDOCUMENT_H
#include "Element.h"
namespace Rocket {
namespace Core {
class Stream;
}
}
namespace Rocket {
namespace Core {
class Context;
class DocumentHeader;
class ElementText;
class StyleSheet;
/**
Represents a document in the dom tree.
@author Lloyd Weehuizen
*/
class ROCKETCORE_API ElementDocument : public Element
{
public:
ElementDocument(const String& tag);
virtual ~ElementDocument();
/// Process given document header
void ProcessHeader(const DocumentHeader* header);
/// Returns itself as the current document
virtual ElementDocument* GetOwnerDocument();
/// Returns the document's context.
/// @return The context this document exists within.
Context* GetContext();
/// Sets the document's title.
/// @param[in] title The new title of the document.
void SetTitle(const String& title);
/// Returns the title of this document.
/// @return The document's title.
const String& GetTitle() const;
/// Returns the source address of this document.
/// @return The source of this document, usually a file name.
const String& GetSourceURL() const;
/// Sets the style sheet this document, and all of its children, uses.
/// @param[in] style_sheet The style sheet to set on the document.
void SetStyleSheet(StyleSheet* style_sheet);
/// Returns the document's style sheet.
/// @return The document's style sheet.
virtual StyleSheet* GetStyleSheet() const;
/// Brings the document to the front of the document stack.
void PullToFront();
/// Sends the document to the back of the document stack.
void PushToBack();
/**
Flags used for displaying the document.
*/
enum FocusFlags
{
NONE = 0,
FOCUS = (1 << 1),
MODAL = (1 << 2)
};
/// Show the document.
/// @param[in] focus_flags Flags controlling the changing of focus. Leave as FOCUS to switch focus to the document.
void Show(int focus_flags = FOCUS);
/// Hide the document.
void Hide();
/// Close the document.
void Close();
/// Creates the named element.
/// @param[in] name The tag name of the element.
Element* CreateElement(const String& name);
/// Create a text element with the given text content.
/// @param[in] text The text content of the text element.
ElementText* CreateTextNode(const String& text);
/// Does the document have modal display set.
/// @return True if the document is hogging focus.
bool IsModal() const;
/// Load a script into the document. Note that the base implementation does nothing, scripting language addons hook
/// this method.
/// @param[in] stream Stream of code to process.
/// @param[in] source_name Name of the the script the source comes from, useful for debug information.
virtual void LoadScript(Stream* stream, const String& source_name);
/// Updates the layout if necessary.
inline void UpdateLayout() { if (layout_dirty && lock_layout == 0) _UpdateLayout(); }
/// Updates the position of the document based on the style properties.
void UpdatePosition();
/// Increment/Decrement the layout lock
void LockLayout(bool lock);
protected:
/// Refreshes the document layout if required.
virtual void OnUpdate();
/// Repositions the document if necessary.
virtual void OnPropertyChange(const PropertyNameList& changed_properties);
/// Sets the dirty flag on the layout so the document will format its children before the next render.
virtual void DirtyLayout();
/// Returns true if the document has been marked as needing a re-layout.
virtual bool IsLayoutDirty();
/// Processes the 'onpropertychange' event, checking for a change in position or size.
virtual void ProcessEvent(Event& event);
private:
// Find the next element to focus, starting at the current element
bool FocusNextTabElement(Element* current_element, bool forward);
/// Searches forwards or backwards for a focusable element in the given substree
bool SearchFocusSubtree(Element* element, bool forward);
// Title of the document
String title;
// The original path this document came from
String source_url;
// The document's style sheet.
StyleSheet* style_sheet;
Context* context;
// Is the current display modal
bool modal;
// Is the layout dirty?
bool layout_dirty;
int lock_layout;
friend class Context;
friend class Factory;
void _UpdateLayout();
};
}
}
#endif
|
