summaryrefslogtreecommitdiff
path: root/dggui/layout.h
blob: 210c86e251a5bd5081cfefbcea95841b8247a921 (plain)
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
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/***************************************************************************
 *            layout.h
 *
 *  Sat Mar 21 15:12:36 CET 2015
 *  Copyright 2015 Bent Bisballe Nyeng
 *  deva@aasimon.org
 ****************************************************************************/

/*
 *  This file is part of DrumGizmo.
 *
 *  DrumGizmo is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  DrumGizmo is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with DrumGizmo; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 */
#pragma once

#include <cstdlib>
#include <list>
#include <unordered_map>

#include <notifier.h>

namespace GUI
{

class Layout;

class LayoutItem
{
public:
	LayoutItem();
	virtual ~LayoutItem();

	void setLayoutParent(Layout* parent);

	virtual void resize(std::size_t width, std::size_t height) = 0;
	virtual void move(int x, int y) = 0;
	virtual int x() const = 0;
	virtual int y() const = 0;
	virtual std::size_t width() const = 0;
	virtual std::size_t height() const = 0;

private:
	Layout* parent;
};

//! \brief Abtract Layout class.
class Layout : public Listener
{
public:
	Layout(LayoutItem* parent);
	virtual ~Layout()
	{
	}

	virtual void addItem(LayoutItem* item);
	virtual void removeItem(LayoutItem* item);

	//! \brief Reimplement this method to create a new Layout rule.
	virtual void layout() = 0;

protected:
	void sizeChanged(int width, int height);

	LayoutItem* parent;
	typedef std::list<LayoutItem*> LayoutItemList;
	LayoutItemList items;
};

//! \brief Abstract box layout
class BoxLayout : public Layout
{
public:
	BoxLayout(LayoutItem* parent);

	//! \brief Set to false to only move the items, not scale them.
	void setResizeChildren(bool resize_children);

	void setSpacing(size_t spacing);

	// From Layout:
	virtual void layout() override = 0;

protected:
	bool resizeChildren{false};
	size_t spacing{0};
};

enum class HAlignment
{
	left,
	center,
	right,
};

//! \brief A Layout that lays out its elements vertically.
class VBoxLayout : public BoxLayout
{
public:
	VBoxLayout(LayoutItem* parent);

	void setHAlignment(HAlignment alignment);

	// From BoxLayout:
	virtual void layout() override;

protected:
	HAlignment align;
};

enum class VAlignment
{
	top,
	center,
	bottom,
};

//! \brief A Layout that lays out its elements vertically.
class HBoxLayout : public BoxLayout
{
public:
	HBoxLayout(LayoutItem* parent);

	void setVAlignment(VAlignment alignment);

	// From BoxLayout:
	virtual void layout() override;

protected:
	VAlignment align;
};

//! \brief A Layout class which places the items in a regular grid. An item can
//! span multiple rows/columns.
class GridLayout : public BoxLayout
{
public:
	// The range is open, i.e. end is one past the last one.
	struct GridRange
	{
		int column_begin;
		int column_end;
		int row_begin;
		int row_end;
	};

	GridLayout(LayoutItem* parent, std::size_t number_of_columns,
	    std::size_t number_of_rows);

	virtual ~GridLayout()
	{
	}

	// From Layout:
	virtual void removeItem(LayoutItem* item);
	virtual void layout();

	void setPosition(LayoutItem* item, GridRange const& range);

	int lastUsedRow(int column) const;
	int lastUsedColumn(int row) const;

protected:
	std::size_t number_of_columns;
	std::size_t number_of_rows;

	// Note: Yes, this is somewhat redundant to the LayoutItemList of the Layout
	// class. However, this was the best idea I had such that I could still
	// derive from Layout. If you find this ugly, feel free to fix it.
	std::unordered_map<LayoutItem*, GridRange> grid_ranges;

private:
	struct CellSize {
		std::size_t width;
		std::size_t height;
	};

	CellSize calculateCellSize() const;
	void moveAndResize(
	    LayoutItem& item, GridRange const& range, CellSize cell_size) const;
};

} // GUI::