TableModel Class Reference

#include <tablemodel.h>

Inheritance diagram for TableModel:

Public Member Functions
virtual	~TableModel ()
virtual int	getRows () const =0
virtual int	getColumns () const =0
virtual int	getRowHeight () const =0
virtual int	getColumnWidth (const int index) const =0
virtual Widget *	getElementAt (const int row, const int column) const =0
virtual void	installListener (TableModelListener *const listener)
virtual void	removeListener (TableModelListener *const listener)

Protected Member Functions
	TableModel ()
virtual void	signalBeforeUpdate ()
virtual void	signalAfterUpdate ()

Private Attributes
std::set< TableModelListener * >	listeners

Detailed Description

A model for a regular table of widgets.

Definition at line 40 of file tablemodel.h.

Constructor & Destructor Documentation

~TableModel()

virtual TableModel::~TableModel ( )

inlinevirtual

Definition at line 45 of file tablemodel.h.

        { }

TableModel()

TableModel::TableModel ( )

inlineprotected

Definition at line 80 of file tablemodel.h.

                     :
            listeners()
        {
        }

Member Function Documentation

getColumns()

virtual int TableModel::getColumns ( ) const

pure virtual

Determines the number of columns in each row

Implemented in PlayerTableModel, and StaticTableModel.

Referenced by GuiTable::draw(), GuiTable::getColumnForX(), GuiTable::installActionListeners(), GuiTable::keyPressed(), GuiTable::recomputeDimensions(), GuiTable::safeDraw(), GuiTable::setFocusHandler(), and GuiTable::setSelectedColumn().

getColumnWidth()

virtual int TableModel::getColumnWidth ( const int  index ) const

pure virtual

Determines the width of each individual column

Implemented in PlayerTableModel, and StaticTableModel.

Referenced by GuiTable::getColumnWidth().

getElementAt()

virtual Widget* TableModel::getElementAt ( const int  row, const int  column  ) const

pure virtual

Retrieves the widget stored at the specified location within the table.

Implemented in PlayerTableModel, and StaticTableModel.

Referenced by GuiTable::draw(), GuiTable::getWidgetAt(), GuiTable::installActionListeners(), GuiTable::safeDraw(), and GuiTable::setFocusHandler().

getRowHeight()

virtual int TableModel::getRowHeight ( ) const

pure virtual

Determines the height for each row

Implemented in PlayerTableModel, and StaticTableModel.

Referenced by GuiTable::getRowHeight().

getRows()

virtual int TableModel::getRows ( ) const

pure virtual

Determines the number of rows (lines) in the table

Implemented in StaticTableModel, and PlayerTableModel.

Referenced by GuiTable::draw(), GuiTable::getRowForY(), GuiTable::installActionListeners(), GuiTable::keyPressed(), GuiTable::recomputeDimensions(), GuiTable::safeDraw(), GuiTable::setFocusHandler(), and GuiTable::setSelectedRow().

installListener()

void TableModel::installListener ( TableModelListener *const  listener )

virtual

Definition at line 34 of file tablemodel.cpp.

{
    if (listener != nullptr)
        listeners.insert(listener);
}

References anonymous_namespace{itemlinkhandler.cpp}::listener, and listeners.

Referenced by GuiTable::setModel().

removeListener()

void TableModel::removeListener ( TableModelListener *const  listener )

virtual

Definition at line 40 of file tablemodel.cpp.

{
    if (listener != nullptr)
        listeners.erase(listener);
}

References anonymous_namespace{itemlinkhandler.cpp}::listener, and listeners.

Referenced by GuiTable::setModel().

signalAfterUpdate()

void TableModel::signalAfterUpdate ( )

protectedvirtual

Tells all listeners that the table has seen an update

Definition at line 55 of file tablemodel.cpp.

{
    for (std::set<TableModelListener *>::const_iterator it = listeners.begin();
         it != listeners.end(); ++it)
    {
        if (*it != nullptr)
            (*it)->modelUpdated(true);
    }
}

References listeners.

Referenced by PlayerTableModel::playerRelationsUpdated(), and StaticTableModel::set().

signalBeforeUpdate()

void TableModel::signalBeforeUpdate ( )

protectedvirtual

Tells all listeners that the table is about to see an update

Definition at line 46 of file tablemodel.cpp.

{
    for (std::set<TableModelListener *>::const_iterator it = listeners.begin();
         it != listeners.end(); ++it)
    {
        (*it)->modelUpdated(false);
    }
}

References listeners.

Referenced by PlayerTableModel::playerRelationsUpdated(), and StaticTableModel::set().

Field Documentation

listeners

std::set<TableModelListener *> TableModel::listeners

private

Definition at line 96 of file tablemodel.h.

Referenced by installListener(), removeListener(), signalAfterUpdate(), and signalBeforeUpdate().

---

The documentation for this class was generated from the following files:

• src/gui/models/tablemodel.h (986a3bf)
• src/gui/models/tablemodel.cpp (986a3bf)