summaryrefslogtreecommitdiff
path: root/src/gui/models/tablemodel.h
blob: 62826749fe982d61fefc3cddb931c1d5398c3ea4 (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
/*
 *  The ManaPlus Client
 *  Copyright (C) 2008-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *
 *  This file is part of The ManaPlus Client.
 *
 *  This program 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.
 *
 *  This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef GUI_MODELS_TABLEMODEL_H
#define GUI_MODELS_TABLEMODEL_H

#include "utils/vector.h"

#include <set>

#include "localconsts.h"

class Widget;

class TableModelListener;

/**
 * A model for a regular table of widgets.
 */
class TableModel notfinal
{
    public:
        A_DELETE_COPY(TableModel)

        virtual ~TableModel()
        { }

        /**
         * Determines the number of rows (lines) in the table
         */
        virtual int getRows() const A_WARN_UNUSED = 0;

        /**
         * Determines the number of columns in each row
         */
        virtual int getColumns() const A_WARN_UNUSED = 0;

        /**
         * Determines the height for each row
         */
        virtual int getRowHeight() const A_WARN_UNUSED = 0;

        /**
         * Determines the width of each individual column
         */
        virtual int getColumnWidth(const int index) const A_WARN_UNUSED = 0;

        /**
         * Retrieves the widget stored at the specified location
         *  within the table.
         */
        virtual Widget *getElementAt(const int row, const int column)
                                     const A_WARN_UNUSED = 0;

        virtual void installListener(TableModelListener *const listener);

        virtual void removeListener(TableModelListener *const listener);

    protected:
        TableModel() :
            listeners()
        {
        }

        /**
         * Tells all listeners that the table is about to see an update
         */
        virtual void signalBeforeUpdate();

        /**
         * Tells all listeners that the table has seen an update
         */
        virtual void signalAfterUpdate();

    private:
        std::set<TableModelListener *> listeners;
};


class StaticTableModel final : public TableModel
{
    public:
        StaticTableModel(const int width, const int height);

        A_DELETE_COPY(StaticTableModel)

        ~StaticTableModel() override final;

        /**
         * Inserts a widget into the table model.
         * The model is resized to accomodate the widget's width and height,
         * unless column width / row height have been fixed.
         */
        void set(const int row, const int column, Widget *const widget);

        /**
         * Fixes the column width for a given column; this overrides dynamic
         * width inference.
         *
         * Semantics are undefined for width 0.
         */
        void fixColumnWidth(const int column, const int width);

        /**
         * Fixes the row height; this overrides dynamic height inference.
         *
         * Semantics are undefined for width 0.
         */
        void fixRowHeight(const int height);

        /**
         * Resizes the table model
         */
        void resize();

        int getRows() const override final A_WARN_UNUSED;
        int getColumns() const override final A_WARN_UNUSED;
        int getRowHeight() const override final A_WARN_UNUSED;
        int getWidth() const A_WARN_UNUSED;
        int getHeight() const A_WARN_UNUSED;
        int getColumnWidth(const int index) const override final A_WARN_UNUSED;
        Widget *getElementAt(const int row,
                             const int column) const override final
                             A_WARN_UNUSED;

    protected:
        int mRows;
        int mColumns;
        int mHeight;
        STD_VECTOR<Widget *> mTableModel;
        STD_VECTOR<int> mWidths;
};

#endif  // GUI_MODELS_TABLEMODEL_H