/*
* The Mana World
* Copyright (C) 2008 The Mana World Development Team
*
* This file is part of The Mana World.
*
* 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef TABLE_MODEL_H
#define TABLE_MODEL_H
#include <set>
#include <vector>
class TableModelListener
{
public:
/**
* Must be invoked by the TableModel whenever a global change is about to
* occur or has occurred (e.g., when a row or column is being removed or
* added).
*
* This method is triggered twice, once before and once after the update.
*
* \param completed whether we are signalling the end of the update
*/
virtual void modelUpdated(bool completed) = 0;
};
/**
* A model for a regular table of widgets.
*/
class TableModel
{
public:
virtual ~TableModel() { }
/**
* Determines the number of rows (lines) in the table
*/
virtual int getRows() = 0;
/**
* Determines the number of columns in each row
*/
virtual int getColumns() = 0;
/**
* Determines the height for each row
*/
virtual int getRowHeight() = 0;
/**
* Determines the width of each individual column
*/
virtual int getColumnWidth(int index) = 0;
/**
* Retrieves the widget stored at the specified location within the table.
*/
virtual gcn::Widget *getElementAt(int row, int column) = 0;
virtual void installListener(TableModelListener *listener);
virtual void removeListener(TableModelListener *listener);
protected:
/**
* 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 : public TableModel
{
public:
StaticTableModel(int width, int height);
virtual ~StaticTableModel();
/**
* 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.
*/
virtual void set(int row, int column, gcn::Widget *widget);
/**
* Fixes the column width for a given column; this overrides dynamic width
* inference.
*
* Semantics are undefined for width 0.
*/
virtual void fixColumnWidth(int column, int width);
/**
* Fixes the row height; this overrides dynamic height inference.
*
* Semantics are undefined for width 0.
*/
virtual void fixRowHeight(int height);
/**
* Resizes the table model
*/
virtual void resize();
virtual int getRows();
virtual int getColumns();
virtual int getRowHeight();
virtual int getWidth();
virtual int getHeight();
virtual int getColumnWidth(int index);
virtual gcn::Widget *getElementAt(int row, int column);
protected:
int mRows, mColumns;
int mHeight;
std::vector<gcn::Widget *> mTableModel;
std::vector<int> mWidths;
};
#endif /* !defined(TABLE_MODEL_H) */
