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