summaryrefslogtreecommitdiff
path: root/src/gui/table.h
blob: b4c607ae45e62e3a7e155e3dd8589943a3f765ad (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
/*
 *  The Mana World
 *  Copyright 2008 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
 */

#ifndef TMW_TABLE_H_
#define TMW_TABLE_H_

#include <vector>

#include <guichan/gui.hpp>
#include <guichan/keylistener.hpp>
#include <guichan/mouselistener.hpp>
#include <guichan/platform.hpp>
#include <guichan/widget.hpp>

#include "table_model.h"

#include "../guichanfwd.h"

class GuiTableActionListener;

/**
 * A table, with rows and columns made out of sub-widgets. Largely inspired by (and can be thought of as a generalisation of)
 * the guichan listbox implementation.
 *
 * Normally you want this within a ScrollArea.
 *
 * \ingroup GUI
 */
class GuiTable : public gcn::Widget,
                 public gcn::MouseListener,
                 public gcn::KeyListener,
                 public TableModelListener
{
    friend class GuiTableActionListener; // so that the action listener can call distributeActionEvent
public:
    GuiTable(TableModel * initial_model = NULL);

    virtual ~GuiTable(void);

    /**
     * Retrieves the active table model
     */
    TableModel *getModel(void) const;

    /**
     * Sets the table model
     *
     * Note that actions issued by widgets returned from the model will update the table
     * selection, but only AFTER any event handlers installed within the widget have been
     *triggered. To be notified after such an update, add an action listener to the table
     * instead.
     */
    void setModel(TableModel *m);

    void setSelected(int row, int column);

    int getSelectedRow(void);

    int getSelectedColumn(void);

    gcn::Rectangle getChildrenArea(void);

    /**
     * Toggle whether to use linewise selection mode, in which the table selects an entire
     * line at a time, rather than a single cell.
     *
     * Note that column information is tracked even in linewise selection mode; this mode
     * therefore only affects visualisation.
     *
     * Disabled by default.
     *
     * \param linewise: Whether to enable linewise selection mode
     */
    void setLinewiseSelection(bool linewise);

    // Inherited from Widget
    virtual void draw(gcn::Graphics* graphics);

    virtual void logic(void);

    virtual gcn::Widget *getWidgetAt(int x, int y);

    virtual void moveToTop(gcn::Widget *child);

    virtual void moveToBottom(gcn::Widget *child);

    virtual void _setFocusHandler(gcn::FocusHandler* focusHandler);

    // Inherited from KeyListener
    virtual void keyPressed(gcn::KeyEvent& keyEvent);


    // Inherited from MouseListener
    virtual void mousePressed(gcn::MouseEvent& mouseEvent);

    virtual void mouseWheelMovedUp(gcn::MouseEvent& mouseEvent);

    virtual void mouseWheelMovedDown(gcn::MouseEvent& mouseEvent);
        
    virtual void mouseDragged(gcn::MouseEvent& mouseEvent);

    // Constraints inherited from TableModelListener
    virtual void modelUpdated(bool);

protected:

    virtual void uninstallActionListeners(void); // frees all action listeners on inner widgets
    virtual void installActionListeners(void); // installs all action listeners on inner widgets

    virtual int getRowHeight(void);
    virtual int getColumnWidth(int i);
    
private:

    int getRowForY(int y); // -1 on error
    int getColumnForX(int x); // -1 on error
    void recomputeDimensions(void);
    bool mLinewiseMode;

    TableModel *mModel;

    int mSelectedRow;
    int mSelectedColumn;

    int mPopFramesNr; // Number of frames to skip upwards when drawing the selected widget

    gcn::Widget *mTopWidget; // If someone moves a fresh widget to the top, we must display it

    std::vector<GuiTableActionListener *> action_listeners; // Vector for compactness; used as a list in practice.
};


#endif /* !defined(TMW_TABLE_H_) */