Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/Function.h>
30#include <AK/Noncopyable.h>
31#include <AK/RefPtr.h>
32#include <AK/WeakPtr.h>
33#include <LibGfx/Rect.h>
34#include <LibGfx/Size.h>
35#include <LibHTML/TreeNode.h>
36
37class Document;
38class HtmlView;
39
40class Frame : public TreeNode<Frame> {
41public:
42 static NonnullRefPtr<Frame> create(HtmlView& html_view) { return adopt(*new Frame(html_view)); }
43 ~Frame();
44
45 const Document* document() const { return m_document; }
46 Document* document() { return m_document; }
47
48 void set_document(Document*);
49
50 HtmlView* html_view() { return m_html_view; }
51 const HtmlView* html_view() const { return m_html_view; }
52
53 const Gfx::Size& size() const { return m_size; }
54 void set_size(const Gfx::Size&);
55
56 void set_needs_display(const Gfx::Rect&);
57 Function<void(const Gfx::Rect&)> on_set_needs_display;
58
59 void set_viewport_rect(const Gfx::Rect&);
60 Gfx::Rect viewport_rect() const { return m_viewport_rect; }
61
62private:
63 explicit Frame(HtmlView&);
64
65 WeakPtr<HtmlView> m_html_view;
66 RefPtr<Document> m_document;
67 Gfx::Size m_size;
68 Gfx::Rect m_viewport_rect;
69};