summaryrefslogtreecommitdiff
path: root/src/gui/widgets/layout.h
blob: 09b511f6e3fc86ee1c888395705f7d612da9b92f (plain) (blame)
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
/*
 *  The Mana World
 *  Copyright 2007 The Mana World Development Team
 *
 *  This file is part of The Mana World.
 *
 *  The Mana World is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  any later version.
 *
 *  The Mana World 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with The Mana World; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  $Id$
 */

#ifndef _TMW_WIDGET_LAYOUT_H__
#define _TMW_WIDGET_LAYOUT_H__

#include <vector>

#include <guichan/widget.hpp>

/**
 * This class describes the formatting of a widget in the cell of a layout
 * table. Horizontally, a widget can either fill the width of the cell (minus
 * the cell padding), or it can retain its size and be flushed left, or flush
 * right, or centered in the cell. The process is similar for the vertical
 * alignment, except that top is represented by LEFT and bottom by RIGHT.
 */
class Cell
{
    friend class Layout;

    public:

        enum Alignment
        {
            LEFT, RIGHT, CENTER, FILL
        };

        Cell(): mWidget(0) {}

        /**
         * Sets the padding around the cell content.
         */
        Cell &setPadding(int p)
        { mPadding = p; return *this; }

        /**
         * Sets the horizontal alignment of the cell content.
         */
        Cell &setHAlign(Alignment a)
        { mAlign[0] = a; return *this; }

        /**
         * Sets the vertical alignment of the cell content.
         */
        Cell &setVAlign(Alignment a)
        { mAlign[1] = a; return *this; }

    private:

        gcn::Widget *mWidget;
        int mPadding;
        int mExtent[2];
        Alignment mAlign[2];
};

/**
 * This class is an helper for setting the position of widgets. They are
 * positioned along the cells of a rectangular table. The size of a given
 * table column can either be set manually or be chosen from the widest widget
 * of the column. The process is similar for table rows. By default, there is a
 * padding of 4 pixels between rows and between columns.
 */
class Layout
{
    public:

        Layout(): mPadding(4), mX(0), mY(0), mW(0), mH(0) {}

        /**
         * Sets the minimum width of a column.
         */
        void setColWidth(int n, int w);

        /**
         * Sets the minimum height of a row.
         */
        void setRowHeight(int n, int h);

        /**
         * Matchs widths of two columns.
         */
        void matchColWidth(int n1, int n2);

        /**
         * Sets the minimum width of the layout.
         */
        void setWidth(int w)
        { mW = w; }

        /**
         * Sets the minimum height of the layout.
         */
        void setHeight(int h)
        { mH = h; }

        /**
         * Sets the padding between cells.
         */
        void setPadding(int p)
        { mPadding = p; }

        /**
         * Places a widget in a given cell.
         */
        Cell &place(gcn::Widget *, int x, int y, int w, int h);

        /**
         * Computes the positions of all the widgets.
         */
        void reflow();

        /**
         * Reflows the current layout. Then starts a new layout just below with
         * the same width.
         */
        void flush();

        enum
        {
            FILL = -1, /**< Expand until the layout as the expected size. */
        };

    private:

        /**
         * Gets the position and size of a widget along a given axis
         */
        void align(int &pos, int &size, int dim, Cell &cell, int *sizes);

        /**
         * Ensures the private vectors are large enough.
         */
        void resizeGrid(int w, int h);

        /**
         * Gets the column/row sizes along a given axis.
         */
        std::vector< int > compute(int dim, int upp);

        std::vector< int > mSizes[2];
        std::vector< std::vector < Cell > > mCells;

        int mPadding;
        int mX, mY, mW, mH, mNW, mNH;
};

#endif