/*
* The ManaPlus Client
* Copyright (C) 2008-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2014 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 .
*/
#include "gui/widgets/guitable.h"
#include "client.h"
#include "input/keyevent.h"
#include "input/keydata.h"
#include "utils/dtor.h"
#include "gui/base/actionlistener.hpp"
#include "gui/base/key.hpp"
#include "render/graphics.h"
#include "debug.h"
float GuiTable::mAlpha = 1.0;
class GuiTableActionListener final : public gcn::ActionListener
{
public:
GuiTableActionListener(GuiTable *restrict _table,
gcn::Widget *restrict _widget,
int _row, int _column);
A_DELETE_COPY(GuiTableActionListener)
~GuiTableActionListener();
void action(const gcn::ActionEvent& actionEvent) override final;
protected:
GuiTable *mTable;
int mRow;
int mColumn;
gcn::Widget *mWidget;
};
GuiTableActionListener::GuiTableActionListener(GuiTable *restrict table,
gcn::Widget *restrict widget,
int row, int column) :
gcn::ActionListener(),
mTable(table),
mRow(row),
mColumn(column),
mWidget(widget)
{
if (widget)
{
widget->addActionListener(this);
widget->_setParent(table);
}
}
GuiTableActionListener::~GuiTableActionListener()
{
if (mWidget)
{
mWidget->removeActionListener(this);
mWidget->_setParent(nullptr);
}
}
void GuiTableActionListener::action(const gcn::ActionEvent
&actionEvent A_UNUSED)
{
mTable->setSelected(mRow, mColumn);
mTable->distributeActionEvent();
}
GuiTable::GuiTable(const Widget2 *const widget,
TableModel *const initial_model, const bool opacity) :
gcn::Widget(),
Widget2(widget),
gcn::MouseListener(),
gcn::KeyListener(),
mModel(nullptr),
mTopWidget(nullptr),
mActionListeners(),
mHighlightColor(getThemeColor(Theme::HIGHLIGHT)),
mSelectedRow(-1),
mSelectedColumn(-1),
mLinewiseMode(false),
mWrappingEnabled(false),
mOpaque(opacity),
mSelectable(true)
{
mBackgroundColor = getThemeColor(Theme::BACKGROUND);
setModel(initial_model);
setFocusable(true);
addMouseListener(this);
addKeyListener(this);
}
GuiTable::~GuiTable()
{
if (gui)
gui->removeDragged(this);
uninstallActionListeners();
delete mModel;
mModel = nullptr;
}
const TableModel *GuiTable::getModel() const
{
return mModel;
}
void GuiTable::setModel(TableModel *const new_model)
{
if (mModel)
{
uninstallActionListeners();
mModel->removeListener(this);
}
mModel = new_model;
installActionListeners();
if (new_model)
{
new_model->installListener(this);
recomputeDimensions();
}
}
void GuiTable::recomputeDimensions()
{
if (!mModel)
return;
const int rows_nr = mModel->getRows();
const int columns_nr = mModel->getColumns();
int width = 0;
if (mSelectable)
{
if (mSelectedRow >= rows_nr)
mSelectedRow = rows_nr - 1;
if (mSelectedColumn >= columns_nr)
mSelectedColumn = columns_nr - 1;
}
for (int i = 0; i < columns_nr; i++)
width += getColumnWidth(i);
setWidth(width);
setHeight(getRowHeight() * rows_nr);
}
void GuiTable::setSelected(const int row, const int column)
{
mSelectedColumn = column;
mSelectedRow = row;
}
int GuiTable::getSelectedRow() const
{
return mSelectedRow;
}
int GuiTable::getSelectedColumn() const
{
return mSelectedColumn;
}
int GuiTable::getRowHeight() const
{
if (mModel)
return mModel->getRowHeight() + 4; // border
else
return 0;
}
int GuiTable::getColumnWidth(const int i) const
{
if (mModel)
return mModel->getColumnWidth(i) + 4; // border
else
return 0;
}
void GuiTable::setSelectedRow(const int selected)
{
if (!mModel || !mSelectable)
{
mSelectedRow = -1;
}
else
{
const int rows = mModel->getRows();
if (selected < 0 && !mWrappingEnabled)
{
mSelectedRow = -1;
}
else if (selected >= rows && mWrappingEnabled)
{
mSelectedRow = 0;
}
else if ((selected >= rows && !mWrappingEnabled) ||
(selected < 0 && mWrappingEnabled))
{
mSelectedRow = rows - 1;
}
else
{
mSelectedRow = selected;
}
}
}
void GuiTable::setSelectedColumn(const int selected)
{
if (!mModel)
{
mSelectedColumn = -1;
}
else
{
const int columns = mModel->getColumns();
if ((selected >= columns && mWrappingEnabled) ||
(selected < 0 && !mWrappingEnabled))
{
mSelectedColumn = 0;
}
else if ((selected >= columns && !mWrappingEnabled) ||
(selected < 0 && mWrappingEnabled))
{
mSelectedColumn = columns - 1;
}
else
{
mSelectedColumn = selected;
}
}
}
void GuiTable::uninstallActionListeners()
{
delete_all(mActionListeners);
mActionListeners.clear();
}
void GuiTable::installActionListeners()
{
if (!mModel)
return;
const int rows = mModel->getRows();
const int columns = mModel->getColumns();
for (int row = 0; row < rows; ++row)
{
for (int column = 0; column < columns; ++column)
{
gcn::Widget *const widget = mModel->getElementAt(row, column);
if (widget)
{
mActionListeners.push_back(new GuiTableActionListener(
this, widget, row, column));
}
}
}
_setFocusHandler(_getFocusHandler());
}
// -- widget ops
void GuiTable::draw(Graphics* graphics)
{
if (!mModel || !getRowHeight())
return;
BLOCK_START("GuiTable::draw")
if (client->getGuiAlpha() != mAlpha)
mAlpha = client->getGuiAlpha();
const gcn::Rectangle &rect = mDimension;
const int width = rect.width;
const int height = rect.height;
const int y = rect.y;
if (mOpaque)
{
mBackgroundColor.a = static_cast(mAlpha * 255.0F);
graphics->setColor(mBackgroundColor);
graphics->fillRectangle(gcn::Rectangle(0, 0, width, height));
}
// First, determine how many rows we need to draw,
// and where we should start.
int rHeight = getRowHeight();
if (!rHeight)
rHeight = 1;
int first_row = -(y / rHeight);
if (first_row < 0)
first_row = 0;
unsigned rows_nr = 1 + (height / rHeight); // May overestimate by one.
unsigned max_rows_nr;
if (mModel->getRows() < first_row)
max_rows_nr = 0;
else
max_rows_nr = mModel->getRows() - first_row; // clip if neccessary:
if (max_rows_nr < rows_nr)
rows_nr = max_rows_nr;
// Now determine the first and last column
// Take the easy way out; these are usually bounded and all visible.
const unsigned first_column = 0;
const unsigned last_column1 = mModel->getColumns();
int y_offset = first_row * rHeight;
for (unsigned r = first_row; r < first_row + rows_nr; ++r)
{
int x_offset = 0;
for (unsigned c = first_column; c + 1 <= last_column1; ++c)
{
gcn::Widget *const widget = mModel->getElementAt(r, c);
const int cWidth = getColumnWidth(c);
if (widget)
{
gcn::Rectangle bounds(x_offset, y_offset, cWidth, rHeight);
if (widget == mTopWidget)
{
bounds.height = widget->getHeight();
bounds.width = widget->getWidth();
}
widget->setDimension(bounds);
if (mSelectedRow > -1)
{
mHighlightColor.a = static_cast(mAlpha * 255.0F);
graphics->setColor(mHighlightColor);
if (mLinewiseMode && r == static_cast(
mSelectedRow) && c == 0)
{
graphics->fillRectangle(gcn::Rectangle(0, y_offset,
width, rHeight));
}
else if (!mLinewiseMode && mSelectedColumn > 0
&& c == static_cast(mSelectedColumn)
&& r == static_cast(mSelectedRow))
{
graphics->fillRectangle(gcn::Rectangle(
x_offset, y_offset, cWidth, rHeight));
}
}
graphics->pushClipArea(bounds);
widget->draw(graphics);
graphics->popClipArea();
}
x_offset += cWidth;
}
y_offset += rHeight;
}
if (mTopWidget)
{
const gcn::Rectangle &bounds = mTopWidget->getDimension();
graphics->pushClipArea(bounds);
mTopWidget->draw(graphics);
graphics->popClipArea();
}
BLOCK_END("GuiTable::draw")
}
void GuiTable::moveToTop(gcn::Widget *widget)
{
gcn::Widget::moveToTop(widget);
mTopWidget = widget;
}
void GuiTable::moveToBottom(gcn::Widget *widget)
{
gcn::Widget::moveToBottom(widget);
if (widget == mTopWidget)
mTopWidget = nullptr;
}
gcn::Rectangle GuiTable::getChildrenArea()
{
return gcn::Rectangle(0, 0, mDimension.width, mDimension.height);
}
// -- KeyListener notifications
void GuiTable::keyPressed(gcn::KeyEvent& keyEvent)
{
const int action = static_cast(&keyEvent)->getActionId();
if (action == Input::KEY_GUI_SELECT)
{
distributeActionEvent();
keyEvent.consume();
}
else if (action == Input::KEY_GUI_UP)
{
setSelectedRow(mSelectedRow - 1);
keyEvent.consume();
}
else if (action == Input::KEY_GUI_DOWN)
{
setSelectedRow(mSelectedRow + 1);
keyEvent.consume();
}
else if (action == Input::KEY_GUI_LEFT)
{
setSelectedColumn(mSelectedColumn - 1);
keyEvent.consume();
}
else if (action == Input::KEY_GUI_RIGHT)
{
setSelectedColumn(mSelectedColumn + 1);
keyEvent.consume();
}
else if (action == Input::KEY_GUI_HOME)
{
setSelectedRow(0);
setSelectedColumn(0);
keyEvent.consume();
}
else if (action == Input::KEY_GUI_END && mModel)
{
setSelectedRow(mModel->getRows() - 1);
setSelectedColumn(mModel->getColumns() - 1);
keyEvent.consume();
}
}
// -- MouseListener notifications
void GuiTable::mousePressed(gcn::MouseEvent& mouseEvent)
{
if (!mModel || !mSelectable)
return;
if (mouseEvent.getButton() == gcn::MouseEvent::LEFT)
{
const int row = getRowForY(mouseEvent.getY());
const int column = getColumnForX(mouseEvent.getX());
if (row > -1 && column > -1 &&
row < mModel->getRows() && column < mModel->getColumns())
{
mSelectedColumn = column;
mSelectedRow = row;
}
distributeActionEvent();
}
}
void GuiTable::mouseWheelMovedUp(gcn::MouseEvent& mouseEvent)
{
if (isFocused())
{
const int selRow = getSelectedRow();
if (selRow > 0 || (selRow == 0 && mWrappingEnabled))
setSelectedRow(selRow - 1);
mouseEvent.consume();
}
}
void GuiTable::mouseWheelMovedDown(gcn::MouseEvent& mouseEvent)
{
if (isFocused())
{
setSelectedRow(getSelectedRow() + 1);
mouseEvent.consume();
}
}
void GuiTable::mouseDragged(gcn::MouseEvent& mouseEvent)
{
if (mouseEvent.getButton() != gcn::MouseEvent::LEFT)
return;
// Make table selection update on drag
const int x = std::max(0, mouseEvent.getX());
const int y = std::max(0, mouseEvent.getY());
setSelectedRow(getRowForY(y));
setSelectedColumn(getColumnForX(x));
}
void GuiTable::modelUpdated(const bool completed)
{
if (completed)
{
recomputeDimensions();
installActionListeners();
}
else
{ // before the update?
mTopWidget = nullptr; // No longer valid in general
uninstallActionListeners();
}
}
gcn::Widget *GuiTable::getWidgetAt(int x, int y)
{
const int row = getRowForY(y);
const int column = getColumnForX(x);
if (mTopWidget && mTopWidget->getDimension().isPointInRect(x, y))
return mTopWidget;
if (mModel && row > -1 && column > -1)
{
gcn::Widget *const w = mModel->getElementAt(row, column);
if (w && w->isFocusable())
return w;
else
return nullptr; // Grab the event locally
}
else
return nullptr;
}
int GuiTable::getRowForY(int y) const
{
int row = -1;
const int rowHeight = getRowHeight();
if (rowHeight > 0)
row = y / rowHeight;
if (!mModel || row < 0 || row >= mModel->getRows())
return -1;
else
return row;
}
int GuiTable::getColumnForX(int x) const
{
if (!mModel)
return -1;
int column;
int delta = 0;
const int colnum = mModel->getColumns();
for (column = 0; column < colnum; column ++)
{
delta += getColumnWidth(column);
if (x <= delta)
break;
}
if (column < 0 || column >= colnum)
return -1;
else
return column;
}
void GuiTable::_setFocusHandler(gcn::FocusHandler* focusHandler)
{
// add check for focusHandler. may be need remove it?
if (!mModel || !focusHandler)
return;
gcn::Widget::_setFocusHandler(focusHandler);
const int rows = mModel->getRows();
const int cols = mModel->getColumns();
for (int r = 0; r < rows; ++r)
{
for (int c = 0; c < cols ; ++c)
{
gcn::Widget *const w = mModel->getElementAt(r, c);
if (w)
w->_setFocusHandler(focusHandler);
}
}
}
void GuiTable::requestFocus()
{
if (!mFocusHandler)
return;
gcn::Widget::requestFocus();
}