table.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2008-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana 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/>.
 */
 
#pragma once
 
#include "tablemodel.h"
 
#include <guichan/keylistener.hpp>
#include <guichan/mouselistener.hpp>
#include <guichan/widget.hpp>
 
#include <vector>
 
class GuiTableActionListener;
 
class GuiTable final : public gcn::Widget,
                       public gcn::MouseListener,
                       public gcn::KeyListener,
                       public TableModelListener
{
    // so that the action listener can call distributeActionEvent
    friend class GuiTableActionListener;
 
public:
    GuiTable(TableModel *initialModel = nullptr, gcn::Color background = 0xffffff,
             bool opacity = true);
 
    ~GuiTable() override;
 
    TableModel *getModel() const;
 
    void setModel(TableModel *m);
 
    void setSelected(int row, int column);
 
    int getSelectedRow() const;
 
    int getSelectedColumn() const;
 
    void setSelectedRow(int selected);
 
    void setSelectedColumn(int selected);
 
    bool isWrappingEnabled() const {return mWrappingEnabled;}
 
    void setWrappingEnabled(bool wrappingEnabled)
    {mWrappingEnabled = wrappingEnabled;}
 
    gcn::Rectangle getChildrenArea() override;
 
    void setLinewiseSelection(bool linewise);
 
    // Inherited from Widget
    void draw(gcn::Graphics* graphics) override;
 
    // Overridden to disable drawing of the frame
    void drawFrame(gcn::Graphics* graphics) override {}
 
    gcn::Widget *getWidgetAt(int x, int y) override;
 
    void moveToTop(gcn::Widget *child) override;
 
    void moveToBottom(gcn::Widget *child) override;
 
    void _setFocusHandler(gcn::FocusHandler* focusHandler) override;
 
    // Inherited from KeyListener
    void keyPressed(gcn::KeyEvent& keyEvent) override;
 
    void setOpaque(bool opaque) {mOpaque = opaque;}
 
    bool isOpaque() const {return mOpaque;}
 
    // Inherited from MouseListener
    void mousePressed(gcn::MouseEvent& mouseEvent) override;
 
    void mouseWheelMovedUp(gcn::MouseEvent& mouseEvent) override;
 
    void mouseWheelMovedDown(gcn::MouseEvent& mouseEvent) override;
 
    void mouseDragged(gcn::MouseEvent& mouseEvent) override;
 
    // Constraints inherited from TableModelListener
    void modelUpdated(bool) override;
 
protected:
    void uninstallActionListeners();
    void installActionListeners();
 
    int getRowHeight() const;
    int getColumnWidth(int i) const;
 
private:
    int getRowForY(int y) const; // -1 on error
    int getColumnForX(int x) const; // -1 on error
    void recomputeDimensions();
 
    bool mLinewiseMode = false;
    bool mWrappingEnabled = false;
    bool mOpaque;
 
    gcn::Color mBackgroundColor;
 
    TableModel *mModel = nullptr;
 
    int mSelectedRow = 0;
    int mSelectedColumn = 0;
 
    gcn::Widget *mTopWidget = nullptr;
 
    std::vector<GuiTableActionListener *> mActionListeners;
};