jcs.org
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/OwnPtr.h>
30#include <AK/Vector.h>
31#include <AK/WeakPtr.h>
32#include <LibCore/Object.h>
33#include <LibGUI/Forward.h>
34#include <LibGUI/Margins.h>
35
36namespace GUI {
37
38class Layout : public Core::Object {
39 C_OBJECT_ABSTRACT(Layout);
40
41public:
42 virtual ~Layout();
43
44 void add_widget(Widget&);
45 void insert_widget_before(Widget& widget, Widget& before_widget);
46 void add_layout(OwnPtr<Layout>&&);
47 void add_spacer();
48
49 void remove_widget(Widget&);
50
51 virtual void run(Widget&) = 0;
52
53 void notify_adopted(Badge<Widget>, Widget&);
54 void notify_disowned(Badge<Widget>, Widget&);
55
56 Margins margins() const { return m_margins; }
57 void set_margins(const Margins&);
58
59 int spacing() const { return m_spacing; }
60 void set_spacing(int);
61
62 virtual void save_to(JsonObject&) override;
63
64protected:
65 Layout();
66
67 struct Entry {
68 enum class Type {
69 Invalid = 0,
70 Widget,
71 Layout,
72 Spacer,
73 };
74
75 Type type { Type::Invalid };
76 WeakPtr<Widget> widget;
77 OwnPtr<Layout> layout;
78 };
79 void add_entry(Entry&&);
80
81 WeakPtr<Widget> m_owner;
82 Vector<Entry> m_entries;
83
84 Margins m_margins;
85 int m_spacing { 3 };
86};
87
88}