#include <guitable.h>

Inheritance diagram for GuiTable:

Public Member Functions
	GuiTable (const Widget2 const widget, TableModel const initial_model, const Opaque opacity)

	~GuiTable ()

void	setModel (TableModel *const m)

const TableModel *	getModel () const

void	setSelected (const int row, const int column)

int	getSelectedRow () const

int	getSelectedColumn () const

void	setSelectedRow (const int selected)

void	setSelectedColumn (const int selected)

bool	isWrappingEnabled () const

void	setWrappingEnabled (bool wrappingEnabled)

Rect	getChildrenArea ()

void	setLinewiseSelection (bool linewise)

void	draw (Graphics *const graphics)

void	safeDraw (Graphics *const graphics)

Widget *	getWidgetAt (int x, int y)

void	moveToTop (Widget *const widget)

void	moveToBottom (Widget *const widget)

void	setFocusHandler (FocusHandler *const focusHandler)

void	keyPressed (KeyEvent &event)

void	setOpaque (Opaque opaque)

bool	isOpaque () const

void	mousePressed (MouseEvent &event)

void	mouseWheelMovedUp (MouseEvent &event)

void	mouseWheelMovedDown (MouseEvent &event)

void	mouseDragged (MouseEvent &event)

void	modelUpdated (const bool completed)

void	requestFocus ()

void	setSelectableGui (bool b)

Public Member Functions inherited from Widget
	Widget (const Widget2 *const widget)

	~Widget ()

virtual void	drawFrame (Graphics *graphics)

virtual void	safeDrawFrame (Graphics *graphics)

void	setFrameSize (const unsigned int frameSize)

unsigned int	getFrameSize () const

virtual void	logic ()

Widget *	getParent () const

void	setWidth (const int width)

int	getWidth () const

void	setHeight (const int height)

int	getHeight () const

void	setSize (const int width, const int height)

void	setX (const int x)

int	getX () const

void	setY (const int y)

int	getY () const

void	setPosition (const int x, const int y)

void	setDimension (const Rect &dimension)

const Rect &	getDimension () const

void	setFocusable (const bool focusable)

bool	isFocusable () const

virtual bool	isFocused () const

void	setEnabled (const bool enabled)

bool	isEnabled () const

void	setVisible (Visible visible)

bool	isVisible () const

void	setBaseColor (const Color &color)

const Color &	getBaseColor () const

void	setForegroundColor (const Color &color)

const Color &	getForegroundColor () const

void	setBackgroundColor (const Color &color)

const Color &	getBackgroundColor () const

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

FocusHandler *	getFocusHandler ()

void	addActionListener (ActionListener *const actionListener)

void	removeActionListener (ActionListener *const actionListener)

void	addDeathListener (WidgetDeathListener *const deathListener)

void	removeDeathListener (WidgetDeathListener *const deathListener)

void	addMouseListener (MouseListener *const mouseListener)

void	removeMouseListener (MouseListener *const mouseListener)

void	addKeyListener (KeyListener *const keyListener)

void	removeKeyListener (KeyListener *const keyListener)

void	addFocusListener (FocusListener *const focusListener)

void	removeFocusListener (FocusListener *const focusListener)

void	addWidgetListener (WidgetListener *const widgetListener)

void	removeWidgetListener (WidgetListener *const widgetListener)

void	setActionEventId (const std::string &actionEventId)

const std::string &	getActionEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	setParent (Widget *parent)

Font *	getFont () const

void	setFont (Font *const font)

virtual void	fontChanged ()

bool	isTabInEnabled () const

void	setTabInEnabled (const bool enabled)

bool	isTabOutEnabled () const

void	setTabOutEnabled (const bool enabled)

void	requestModalFocus ()

virtual void	requestModalMouseInputFocus ()

virtual void	releaseModalFocus ()

virtual void	releaseModalMouseInputFocus ()

virtual bool	isModalFocused () const

virtual bool	isModalMouseInputFocused () const

const std::list< MouseListener * > &	getMouseListeners () const A_CONST

const std::list< KeyListener * > &	getKeyListeners () const A_CONST

const std::list< FocusListener * > &	getFocusListeners () const A_CONST

virtual FocusHandler *	getInternalFocusHandler ()

void	setInternalFocusHandler (FocusHandler *const internalFocusHandler)

virtual void	focusNext ()

virtual void	focusPrevious ()

virtual void	showWidgetPart (Widget *const widget, const Rect &area)

void	setId (const std::string &id)

const std::string &	getId () const

virtual void	showPart (const Rect &rectangle)

bool	isAllowLogic () const

void	setMouseConsume (const bool b)

bool	isMouseConsume () const

void	setRedraw (const bool b)

virtual bool	isSelectable () const

void	setSelectable (const bool selectable)

void	windowResized ()

virtual void	postInit ()

Public Member Functions inherited from Widget2
virtual	~Widget2 ()

const Color &	getThemeColor (const ThemeColorIdT type, const unsigned int alpha) const A_INLINE

const Color &	getThemeCharColor (const signed char c, bool &valid) const A_INLINE

virtual void	setWidget2 (const Widget2 *const widget)

void	setPalette (int palette)

void	checkPalette ()

void	setForegroundColor2 (const Color &color)

Widget *	getWindow () const

virtual void	setWindow (Widget *const window)

Public Member Functions inherited from MouseListener
virtual	~MouseListener ()

virtual void	mouseEntered (MouseEvent &event)

virtual void	mouseExited (MouseEvent &event)

virtual void	mouseReleased (MouseEvent &event)

virtual void	mouseClicked (MouseEvent &event)

virtual void	mouseMoved (MouseEvent &event)

Public Member Functions inherited from KeyListener
virtual	~KeyListener ()

virtual void	keyReleased (KeyEvent &event)

Public Member Functions inherited from TableModelListener
	TableModelListener ()

virtual	~TableModelListener ()

Protected Member Functions
void	uninstallActionListeners ()

void	installActionListeners ()

int	getRowHeight () const

int	getColumnWidth (const int i) const

Protected Member Functions inherited from Widget
void	distributeActionEvent ()

void	distributeResizedEvent ()

void	distributeMovedEvent ()

void	distributeHiddenEvent ()

void	distributeShownEvent ()

Protected Member Functions inherited from Widget2
	Widget2 (const Widget2 *const widget)

Protected Member Functions inherited from MouseListener
	MouseListener ()

Protected Member Functions inherited from KeyListener
	KeyListener ()

Private Member Functions
int	getRowForY (const int y) const

int	getColumnForX (const int x) const

void	recomputeDimensions ()

Private Attributes
TableModel *	mModel

Widget *	mTopWidget

std::vector< GuiTableActionListener * >	mActionListeners2

Color	mHighlightColor

int	mSelectedRow

int	mSelectedColumn

bool	mLinewiseMode

bool	mWrappingEnabled

Opaque	mOpaque

bool	mSelectableGui

Static Private Attributes
static float	mAlpha = 1.0

Friends
class	GuiTableActionListener

Additional Inherited Members
Static Public Member Functions inherited from Widget
static void	setGlobalFont (Font *const font)

static Font *	getGloablFont ()

static void	cleanGlobalFont ()

static bool	widgetExists (const Widget *const widget)

static void	distributeWindowResizeEvent ()

static Widget *	callPostInit (Widget *const widget)

Data Fields inherited from Widget
Visible	mVisible

Protected Types inherited from Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

typedef std::list< WidgetDeathListener * >	WidgetDeathListenerList

typedef WidgetDeathListenerList::iterator	WidgetDeathListenerIterator

typedef std::list< FocusListener * >	FocusListenerList

typedef FocusListenerList::iterator	FocusListenerIterator

typedef std::list< WidgetListener * >	WidgetListenerList

typedef WidgetListenerList::iterator	WidgetListenerIterator

Protected Attributes inherited from Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

WidgetDeathListenerList	mDeathListeners

FocusListenerList	mFocusListeners

WidgetListenerList	mWidgetListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Rect	mDimension

std::string	mActionEventId

std::string	mId

FocusHandler *	mFocusHandler

FocusHandler *	mInternalFocusHandler

Widget *	mParent

Font *	mCurrentFont

unsigned int	mFrameSize

bool	mFocusable

bool	mTabIn

bool	mTabOut

bool	mEnabled

bool	mAllowLogic

bool	mMouseConsume

bool	mRedraw

bool	mSelectable

Protected Attributes inherited from Widget2
int	mPaletteOffset

Widget *	mWindow

Color	mForegroundColor2

Static Protected Attributes inherited from Widget
static Font *	mGlobalFont = 0

Detailed Description

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.

Definition at line 49 of file guitable.h.

Constructor & Destructor Documentation

◆ GuiTable()

GuiTable::GuiTable	(	const Widget2 *const	widget,
		TableModel *const	initial_model,
		const Opaque	opacity
	)

Definition at line 43 of file guitable.cpp.

                                          :
     Widget(widget),
     MouseListener(),
     KeyListener(),
     TableModelListener(),
     mModel(nullptr),
     mTopWidget(nullptr),
     mActionListeners2(),
     mHighlightColor(getThemeColor(ThemeColorId::HIGHLIGHT, 255U)),
     mSelectedRow(-1),
     mSelectedColumn(-1),
     mLinewiseMode(false),
     mWrappingEnabled(false),
     mOpaque(opacity),
     mSelectableGui(true)
 {
     mAllowLogic = false;
     mBackgroundColor = getThemeColor(ThemeColorId::BACKGROUND, 255U);
  
     setModel(initial_model);
     setFocusable(true);
  
     addMouseListener(this);
     addKeyListener(this);
 }

References Widget::addKeyListener(), Widget::addMouseListener(), LinkHighlightMode::BACKGROUND, Widget2::getThemeColor(), Widget::mAllowLogic, Widget::mBackgroundColor, Widget::setFocusable(), and setModel().

◆ ~GuiTable()

GuiTable::~GuiTable ( )

Definition at line 71 of file guitable.cpp.

 {
     if (gui != nullptr)
         gui->removeDragged(this);
  
     uninstallActionListeners();
     delete2(mModel)
 }

References delete2, gui, mModel, Gui::removeDragged(), and uninstallActionListeners().

Member Function Documentation

◆ draw()

void GuiTable::draw ( Graphics *const graphics )

virtual

Draws the widget. It is called by the parent widget when it is time for the widget to draw itself. The graphics object is set up so that all drawing is relative to the widget, i.e coordinate (0,0) is the top left corner of the widget. It is not possible to draw outside of a widget's dimension.

Parameters

graphics aA graphics object to draw with.

Implements Widget.

Definition at line 227 of file guitable.cpp.

 {
     if (getRowHeight() == 0)
         return;
  
     BLOCK_START("GuiTable::draw")
     if (settings.guiAlpha != mAlpha)
         mAlpha = settings.guiAlpha;
  
     const Rect &rect = mDimension;
     const int width = rect.width;
     const int height = rect.height;
     const int y = rect.y;
     if (mOpaque == Opaque_true)
     {
         mBackgroundColor.a = CAST_U32(mAlpha * 255.0F);
         graphics->setColor(mBackgroundColor);
         graphics->fillRectangle(Rect(0, 0, width, height));
     }
  
     // First, determine how many rows we need to draw,
     // and where we should start.
     int rHeight = getRowHeight();
     if (rHeight == 0)
         rHeight = 1;
     int first_row = -(y / rHeight);
  
     if (first_row < 0)
         first_row = 0;
  
     unsigned int rows_nr = CAST_U32(1 +
         height / rHeight);  // May overestimate by one.
     unsigned int max_rows_nr;
     if (mModel->getRows() < first_row)
     {
         max_rows_nr = 0U;
     }
     else
     {
         max_rows_nr = CAST_U32(
             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 = CAST_U32(
         mModel->getColumns());
  
     int y_offset = first_row * rHeight;
  
     for (unsigned int r = CAST_U32(first_row);
          r < CAST_U32(first_row) + rows_nr;
          ++r)
     {
         int x_offset = 0;
  
         for (unsigned c = first_column; c + 1 <= last_column1; ++c)
         {
             Widget *const widget = mModel->getElementAt(CAST_S32(r),
                 CAST_S32(c));
             const int cWidth = CAST_S32(getColumnWidth(
                 CAST_S32(c)));
             if (widget != nullptr)
             {
                 Rect 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 = CAST_U32(
                         mAlpha * 255.0F);
                     graphics->setColor(mHighlightColor);
  
                     if (mLinewiseMode && r == CAST_U32(
                         mSelectedRow) && c == 0)
                     {
                         graphics->fillRectangle(Rect(0, y_offset,
                             width, rHeight));
                     }
                     else if (!mLinewiseMode && mSelectedColumn > 0
                              && c == CAST_U32(mSelectedColumn)
                              && r == CAST_U32(mSelectedRow))
                     {
                         graphics->fillRectangle(Rect(
                             x_offset, y_offset, cWidth, rHeight));
                     }
                 }
                 graphics->pushClipArea(bounds);
                 widget->draw(graphics);
                 graphics->popClipArea();
             }
  
             x_offset += cWidth;
         }
  
         y_offset += rHeight;
     }
  
     if (mTopWidget != nullptr)
     {
         const Rect &bounds = mTopWidget->getDimension();
         graphics->pushClipArea(bounds);
         mTopWidget->draw(graphics);
         graphics->popClipArea();
     }
     BLOCK_END("GuiTable::draw")
 }

References Color::a, BLOCK_END, BLOCK_START, CAST_S32, CAST_U32, Widget::draw(), Graphics::fillRectangle(), TableModel::getColumns(), getColumnWidth(), Widget::getDimension(), TableModel::getElementAt(), Widget::getHeight(), getRowHeight(), TableModel::getRows(), Widget::getWidth(), Settings::guiAlpha, Rect::height, mAlpha, Widget::mBackgroundColor, Widget::mDimension, mHighlightColor, mLinewiseMode, mModel, mOpaque, mSelectedColumn, mSelectedRow, mTopWidget, Opaque_true, Graphics::popClipArea(), Graphics::pushClipArea(), Graphics::setColor(), Widget::setDimension(), settings, Rect::width, Rect::y, and y.

◆ getChildrenArea()

Rect GuiTable::getChildrenArea ( )

virtual

Gets the area of the widget occupied by the widget's children. By default this method returns an empty rectangle as not all widgets are containers. If you want to make a container this method should return the area where the children resides. This method is used when drawing children of a widget when computing clip rectangles for the children.

An example of a widget that overloads this method is ScrollArea. A ScrollArea has a view of its contant and that view is the children area. The size of a ScrollArea's children area might vary depending on if the scroll bars of the ScrollArea is shown or not.

Returns: The area of the widget occupied by the widget's children.

See also: BasicContainer; BasicContainer::getChildrenArea; BasicContainer::drawChildren

Reimplemented from Widget.

Definition at line 476 of file guitable.cpp.

 {
     return Rect(0, 0, mDimension.width, mDimension.height);
 }

References Rect::height, Widget::mDimension, and Rect::width.

◆ getColumnForX()

int GuiTable::getColumnForX ( const int x ) const

private

Definition at line 631 of file guitable.cpp.

 {
     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 >= colnum)
         return -1;
     return column;
 }

References TableModel::getColumns(), getColumnWidth(), mModel, and x.

Referenced by getWidgetAt(), mouseDragged(), and mousePressed().

◆ getColumnWidth()

int GuiTable::getColumnWidth ( const int i ) const

protected

Definition at line 146 of file guitable.cpp.

 {
     return mModel->getColumnWidth(i) + 4;  // border
 }

References TableModel::getColumnWidth(), and mModel.

Referenced by draw(), getColumnForX(), recomputeDimensions(), and safeDraw().

◆ getModel()

const TableModel * GuiTable::getModel ( ) const

Retrieves the active table model

Definition at line 80 of file guitable.cpp.

 {
     return mModel;
 }

References mModel.

◆ getRowForY()

int GuiTable::getRowForY ( const int y ) const

private

Definition at line 618 of file guitable.cpp.

 {
     int row = -1;
  
     const int rowHeight = getRowHeight();
     if (rowHeight > 0)
        row = y / rowHeight;
  
     if (row < 0 || row >= mModel->getRows())
         return -1;
     return row;
 }

References getRowHeight(), TableModel::getRows(), mModel, and y.

Referenced by getWidgetAt(), mouseDragged(), and mousePressed().

◆ getRowHeight()

int GuiTable::getRowHeight ( ) const

protected

Definition at line 141 of file guitable.cpp.

 {
     return mModel->getRowHeight() + 4;  // border
 }

References TableModel::getRowHeight(), and mModel.

Referenced by draw(), getRowForY(), recomputeDimensions(), and safeDraw().

◆ getSelectedColumn()

int GuiTable::getSelectedColumn ( ) const

Definition at line 136 of file guitable.cpp.

 {
     return mSelectedColumn;
 }

References mSelectedColumn.

◆ getSelectedRow()

int GuiTable::getSelectedRow ( ) const

Definition at line 131 of file guitable.cpp.

 {
     return mSelectedRow;
 }

References mSelectedRow.

Referenced by Setup_Relations::action(), mouseWheelMovedDown(), and mouseWheelMovedUp().

◆ getWidgetAt()

Widget * GuiTable::getWidgetAt	(	int	x,
		int	y
	)

virtual

Gets a widget from a certain position in the widget. This function is used to decide which gets mouse input, thus it can be overloaded to change that behaviour.

NOTE: This always returns NULL if the widget is not a container.

Parameters

x	The x coordinate of the widget to get.
y	The y coordinate of the widget to get.

Returns: The widget at the specified coodinate, NULL if no widget is found.

Reimplemented from Widget.

Definition at line 595 of file guitable.cpp.

 {
     if (mModel == nullptr)
         return nullptr;
  
     const int row = getRowForY(y);
     const int column = getColumnForX(x);
  
     if (mTopWidget != nullptr &&
         mTopWidget->getDimension().isPointInRect(x, y))
     {
         return mTopWidget;
     }
  
     if (row > -1 && column > -1)
     {
         Widget *const w = mModel->getElementAt(row, column);
         if (w != nullptr && w->isFocusable())
             return w;
     }
     return nullptr;
 }

References getColumnForX(), Widget::getDimension(), TableModel::getElementAt(), getRowForY(), Widget::isFocusable(), Rect::isPointInRect(), mModel, mTopWidget, x, and y.

◆ installActionListeners()

void GuiTable::installActionListeners ( )

protected

Installs all action listeners on inner widgets.

Definition at line 205 of file guitable.cpp.

 {
     const int rows = mModel->getRows();
     const int columns = mModel->getColumns();
  
     for (int row = 0; row < rows; ++row)
     {
         for (int column = 0; column < columns; ++column)
         {
             Widget *const widget = mModel->getElementAt(row, column);
             if (widget != nullptr)
             {
                 mActionListeners2.push_back(new GuiTableActionListener(
                     this, widget, row, column));
             }
         }
     }
  
     setFocusHandler(getFocusHandler());
 }

References TableModel::getColumns(), TableModel::getElementAt(), Widget::getFocusHandler(), TableModel::getRows(), GuiTableActionListener, mActionListeners2, mModel, and setFocusHandler().

Referenced by modelUpdated(), and setModel().

◆ isOpaque()

bool GuiTable::isOpaque ( ) const

inline

Checks if the table is opaque, that is if the table area displays its background.

Returns: True if the table is opaque, false otherwise.

Definition at line 146 of file guitable.h.

147 { return mOpaque == Opaque_true; }

References mOpaque, and Opaque_true.

◆ isWrappingEnabled()

bool GuiTable::isWrappingEnabled ( ) const

inline

Definition at line 91 of file guitable.h.

92 { return mWrappingEnabled; }

References mWrappingEnabled.

◆ keyPressed()

void GuiTable::keyPressed ( KeyEvent & event )

virtual

Called if a key is pressed when the widget has keyboard focus. If a key is held down the widget will generate multiple key presses.

Parameters

event Discribes the event.

Reimplemented from KeyListener.

Definition at line 482 of file guitable.cpp.

 {
     const InputActionT action = event.getActionId();
  
     if (action == InputAction::GUI_SELECT)
     {
         distributeActionEvent();
         event.consume();
     }
     else if (action == InputAction::GUI_UP)
     {
         setSelectedRow(mSelectedRow - 1);
         event.consume();
     }
     else if (action == InputAction::GUI_DOWN)
     {
         setSelectedRow(mSelectedRow + 1);
         event.consume();
     }
     else if (action == InputAction::GUI_LEFT)
     {
         setSelectedColumn(mSelectedColumn - 1);
         event.consume();
     }
     else if (action == InputAction::GUI_RIGHT)
     {
         setSelectedColumn(mSelectedColumn + 1);
         event.consume();
     }
     else if (action == InputAction::GUI_HOME)
     {
         setSelectedRow(0);
         setSelectedColumn(0);
         event.consume();
     }
     else if (action == InputAction::GUI_END && (mModel != nullptr))
     {
         setSelectedRow(mModel->getRows() - 1);
         setSelectedColumn(mModel->getColumns() - 1);
         event.consume();
     }
 }

References Widget::distributeActionEvent(), TableModel::getColumns(), TableModel::getRows(), InputAction::GUI_DOWN, InputAction::GUI_END, InputAction::GUI_HOME, InputAction::GUI_LEFT, InputAction::GUI_RIGHT, InputAction::GUI_SELECT, InputAction::GUI_UP, mModel, mSelectedColumn, mSelectedRow, setSelectedColumn(), and setSelectedRow().

◆ modelUpdated()

void GuiTable::modelUpdated ( const bool completed )

virtual

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.

Parameters

completed whether we are signalling the end of the update

Implements TableModelListener.

Definition at line 581 of file guitable.cpp.

 {
     if (completed)
     {
         recomputeDimensions();
         installActionListeners();
     }
     else
     {   // before the update?
         mTopWidget = nullptr;  // No longer valid in general
         uninstallActionListeners();
     }
 }

References installActionListeners(), mTopWidget, recomputeDimensions(), and uninstallActionListeners().

◆ mouseDragged()

void GuiTable::mouseDragged ( MouseEvent & event )

virtual

Called when the mouse has moved and the mouse has previously been pressed on the widget.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 568 of file guitable.cpp.

 {
     if (event.getButton() != MouseButton::LEFT)
         return;
  
     // Make table selection update on drag
     const int x = std::max(0, event.getX());
     const int y = std::max(0, event.getY());
  
     setSelectedRow(getRowForY(y));
     setSelectedColumn(getColumnForX(x));
 }

References MouseEvent::getButton(), getColumnForX(), getRowForY(), MouseEvent::getX(), MouseEvent::getY(), MouseButton::LEFT, setSelectedColumn(), setSelectedRow(), x, and y.

◆ mousePressed()

void GuiTable::mousePressed ( MouseEvent & event )

virtual

Called when a mouse button has been pressed on the widget area.

NOTE: A mouse press is NOT equal to a mouse click. Use mouseClickMessage to check for mouse clicks.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 526 of file guitable.cpp.

 {
     if (!mSelectableGui)
         return;
  
     if (event.getButton() == MouseButton::LEFT)
     {
         const int row = getRowForY(event.getY());
         const int column = getColumnForX(event.getX());
  
         if (row > -1 && column > -1 &&
             row < mModel->getRows() && column < mModel->getColumns())
         {
             mSelectedColumn = column;
             mSelectedRow = row;
             event.consume();
         }
  
         distributeActionEvent();
     }
 }

References Widget::distributeActionEvent(), MouseEvent::getButton(), getColumnForX(), getRowForY(), MouseEvent::getX(), MouseEvent::getY(), MouseButton::LEFT, mSelectableGui, mSelectedColumn, and mSelectedRow.

◆ mouseWheelMovedDown()

void GuiTable::mouseWheelMovedDown ( MouseEvent & event )

virtual

Called when the mouse wheel has moved down on the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 559 of file guitable.cpp.

 {
     if (isFocused())
     {
         setSelectedRow(getSelectedRow() + 1);
         event.consume();
     }
 }

References getSelectedRow(), Widget::isFocused(), and setSelectedRow().

◆ mouseWheelMovedUp()

void GuiTable::mouseWheelMovedUp ( MouseEvent & event )

virtual

Called when the mouse wheel has moved up on the widget area.

Parameters

event Describes the event.

Reimplemented from MouseListener.

Definition at line 548 of file guitable.cpp.

 {
     if (isFocused())
     {
         const int selRow = getSelectedRow();
         if (selRow > 0 || (selRow == 0 && mWrappingEnabled))
             setSelectedRow(selRow - 1);
         event.consume();
     }
 }

References getSelectedRow(), Widget::isFocused(), mWrappingEnabled, and setSelectedRow().

◆ moveToBottom()

void GuiTable::moveToBottom ( Widget *const widget )

virtual

Moves a widget in this widget to the bottom of this widget. The moved widget will be drawn below all other widgets in this widget.

Parameters

widget The widget to move to the bottom.

See also: moveToTop

Reimplemented from Widget.

Definition at line 469 of file guitable.cpp.

 {
     Widget::moveToBottom(widget);
     if (widget == mTopWidget)
         mTopWidget = nullptr;
 }

References Widget::moveToBottom(), and mTopWidget.

◆ moveToTop()

void GuiTable::moveToTop ( Widget *const widget )

virtual

Moves a widget to the top of this widget. The moved widget will be drawn above all other widgets in this widget.

Parameters

widget The widget to move to the top.

See also: moveToBottom

Reimplemented from Widget.

Definition at line 463 of file guitable.cpp.

 {
     Widget::moveToTop(widget);
     mTopWidget = widget;
 }

References Widget::moveToTop(), and mTopWidget.

◆ recomputeDimensions()

void GuiTable::recomputeDimensions ( )

private

Definition at line 100 of file guitable.cpp.

 {
     if (mModel == nullptr)
         return;
  
     const int rows_nr = mModel->getRows();
     const int columns_nr = mModel->getColumns();
     int width = 0;
  
     if (mSelectableGui)
     {
         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);
 }

References TableModel::getColumns(), getColumnWidth(), getRowHeight(), TableModel::getRows(), mModel, mSelectableGui, mSelectedColumn, mSelectedRow, Widget::setHeight(), and Widget::setWidth().

Referenced by modelUpdated(), and setModel().

◆ requestFocus()

void GuiTable::requestFocus ( )

virtual

Requests focus for the widget. A widget will only recieve focus if it is focusable.

Reimplemented from Widget.

Definition at line 671 of file guitable.cpp.

 {
     if (mFocusHandler == nullptr)
         return;
     Widget::requestFocus();
 }

References Widget::mFocusHandler, and Widget::requestFocus().

◆ safeDraw()

void GuiTable::safeDraw ( Graphics *const graphics )

virtual

Implements Widget.

Definition at line 345 of file guitable.cpp.

 {
     if (getRowHeight() == 0)
         return;
  
     BLOCK_START("GuiTable::draw")
     if (settings.guiAlpha != mAlpha)
         mAlpha = settings.guiAlpha;
  
     const Rect &rect = mDimension;
     const int width = rect.width;
     const int height = rect.height;
     const int y = rect.y;
     if (mOpaque == Opaque_true)
     {
         mBackgroundColor.a = CAST_U32(mAlpha * 255.0F);
         graphics->setColor(mBackgroundColor);
         graphics->fillRectangle(Rect(0, 0, width, height));
     }
  
     // First, determine how many rows we need to draw,
     // and where we should start.
     int rHeight = getRowHeight();
     if (rHeight == 0)
         rHeight = 1;
     int first_row = -(y / rHeight);
  
     if (first_row < 0)
         first_row = 0;
  
     unsigned int rows_nr = CAST_U32(
         1 + height / rHeight);  // May overestimate by one.
     unsigned int max_rows_nr;
     if (mModel->getRows() < first_row)
     {
         max_rows_nr = 0;
     }
     else
     {
         max_rows_nr = CAST_U32(
             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 int first_column = 0;
     const unsigned int last_column1 = CAST_U32(
         mModel->getColumns());
  
     int y_offset = first_row * rHeight;
  
     for (unsigned int r = CAST_U32(first_row);
          r < CAST_U32(first_row + CAST_S32(rows_nr));
          ++r)
     {
         int x_offset = 0;
  
         for (unsigned c = first_column; c + 1 <= last_column1; ++c)
         {
             Widget *const widget = mModel->getElementAt(CAST_S32(r),
                 CAST_S32(c));
             const int cWidth = CAST_S32(getColumnWidth(
                 CAST_S32(c)));
             if (widget != nullptr)
             {
                 Rect 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 = CAST_U32(
                         mAlpha * 255.0F);
                     graphics->setColor(mHighlightColor);
  
                     if (mLinewiseMode && r == CAST_U32(
                         mSelectedRow) && c == 0)
                     {
                         graphics->fillRectangle(Rect(0, y_offset,
                             width, rHeight));
                     }
                     else if (!mLinewiseMode && mSelectedColumn > 0
                              && c == CAST_U32(mSelectedColumn)
                              && r == CAST_U32(mSelectedRow))
                     {
                         graphics->fillRectangle(Rect(
                             x_offset, y_offset, cWidth, rHeight));
                     }
                 }
                 graphics->pushClipArea(bounds);
                 widget->safeDraw(graphics);
                 graphics->popClipArea();
             }
  
             x_offset += cWidth;
         }
  
         y_offset += rHeight;
     }
  
     if (mTopWidget != nullptr)
     {
         const Rect &bounds = mTopWidget->getDimension();
         graphics->pushClipArea(bounds);
         mTopWidget->safeDraw(graphics);
         graphics->popClipArea();
     }
     BLOCK_END("GuiTable::draw")
 }

References Color::a, BLOCK_END, BLOCK_START, CAST_S32, CAST_U32, Graphics::fillRectangle(), TableModel::getColumns(), getColumnWidth(), Widget::getDimension(), TableModel::getElementAt(), Widget::getHeight(), getRowHeight(), TableModel::getRows(), Widget::getWidth(), Settings::guiAlpha, Rect::height, mAlpha, Widget::mBackgroundColor, Widget::mDimension, mHighlightColor, mLinewiseMode, mModel, mOpaque, mSelectedColumn, mSelectedRow, mTopWidget, Opaque_true, Graphics::popClipArea(), Graphics::pushClipArea(), Widget::safeDraw(), Graphics::setColor(), Widget::setDimension(), settings, Rect::width, Rect::y, and y.

◆ setFocusHandler()

void GuiTable::setFocusHandler ( FocusHandler *const focusHandler )

virtual

Sets the focus handler to be used.

WARNING: This function is used internally and should not be called or overloaded unless you know what you are doing.

Parameters

focusHandler The focus handler to use.

See also: getFocusHandler

Reimplemented from Widget.

Definition at line 649 of file guitable.cpp.

 {
     // add check for focusHandler. may be need remove it?
  
     if (focusHandler == nullptr)
         return;
  
     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)
         {
             Widget *const w = mModel->getElementAt(r, c);
             if (w != nullptr)
                 w->setFocusHandler(focusHandler);
         }
     }
 }

References TableModel::getColumns(), TableModel::getElementAt(), TableModel::getRows(), mModel, and Widget::setFocusHandler().

Referenced by installActionListeners().

◆ setLinewiseSelection()

void GuiTable::setLinewiseSelection ( bool linewise )

inline

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.

Parameters

linewise Whether to enable linewise selection mode

Definition at line 112 of file guitable.h.

113 { mLinewiseMode = linewise; }

References mLinewiseMode.

Referenced by Setup_Relations::Setup_Relations().

◆ setModel()

void GuiTable::setModel ( TableModel *const m )

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.

Definition at line 85 of file guitable.cpp.

 {
     if (mModel != nullptr)
     {
         uninstallActionListeners();
         mModel->removeListener(this);
     }
  
     mModel = new_model;
     installActionListeners();
  
     new_model->installListener(this);
     recomputeDimensions();
 }

References installActionListeners(), TableModel::installListener(), mModel, recomputeDimensions(), TableModel::removeListener(), and uninstallActionListeners().

Referenced by GuiTable(), and Setup_Relations::updateAll().

◆ setOpaque()

void GuiTable::setOpaque ( Opaque opaque )

inline

Sets the table to be opaque, that is sets the table to display its background.

Parameters

opaque True if the table should be opaque, false otherwise.

Definition at line 137 of file guitable.h.

138 { mOpaque = opaque; }

References mOpaque.

Referenced by Setup_Relations::Setup_Relations().

◆ setSelectableGui()

void GuiTable::setSelectableGui ( bool b )

inline

Definition at line 163 of file guitable.h.

164 { mSelectableGui = b; }

References mSelectableGui.

Referenced by Setup_Relations::Setup_Relations().

◆ setSelected()

void GuiTable::setSelected	(	const int	row,
		const int	column
	)

Definition at line 125 of file guitable.cpp.

 {
     mSelectedColumn = column;
     mSelectedRow = row;
 }

References mSelectedColumn, and mSelectedRow.

Referenced by GuiTableActionListener::action().

◆ setSelectedColumn()

void GuiTable::setSelectedColumn ( const int selected )

Definition at line 180 of file guitable.cpp.

 {
     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;
     }
 }

References TableModel::getColumns(), mModel, mSelectedColumn, and mWrappingEnabled.

Referenced by keyPressed(), and mouseDragged().

◆ setSelectedRow()

void GuiTable::setSelectedRow ( const int selected )

Definition at line 151 of file guitable.cpp.

 {
     if (!mSelectableGui)
     {
         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;
         }
     }
 }

References TableModel::getRows(), mModel, mSelectableGui, mSelectedRow, and mWrappingEnabled.

Referenced by keyPressed(), mouseDragged(), mouseWheelMovedDown(), and mouseWheelMovedUp().

◆ setWrappingEnabled()

void GuiTable::setWrappingEnabled ( bool wrappingEnabled )

inline

Definition at line 94 of file guitable.h.

95 { mWrappingEnabled = wrappingEnabled; }

References mWrappingEnabled.

◆ uninstallActionListeners()

void GuiTable::uninstallActionListeners ( )

protected

Frees all action listeners on inner widgets.

Definition at line 199 of file guitable.cpp.

 {
     delete_all(mActionListeners2);
     mActionListeners2.clear();
 }

References delete_all(), and mActionListeners2.

Referenced by modelUpdated(), setModel(), and ~GuiTable().

Friends And Related Function Documentation

◆ GuiTableActionListener

friend class GuiTableActionListener

friend

Definition at line 55 of file guitable.h.

Referenced by installActionListeners().

Field Documentation

◆ mActionListeners2

std::vector<GuiTableActionListener *> GuiTable::mActionListeners2

private

Vector for compactness; used as a list in practice.

Definition at line 192 of file guitable.h.

Referenced by installActionListeners(), and uninstallActionListeners().

◆ mAlpha

float GuiTable::mAlpha = 1.0

staticprivate

Definition at line 184 of file guitable.h.

Referenced by draw(), and safeDraw().

◆ mHighlightColor

Color GuiTable::mHighlightColor

private

Holds the background color of the table.

Definition at line 197 of file guitable.h.

Referenced by draw(), and safeDraw().

◆ mLinewiseMode

bool GuiTable::mLinewiseMode

private

Definition at line 202 of file guitable.h.

Referenced by draw(), safeDraw(), and setLinewiseSelection().

◆ mModel

TableModel* GuiTable::mModel

private

Definition at line 186 of file guitable.h.

Referenced by draw(), getColumnForX(), getColumnWidth(), getModel(), getRowForY(), getRowHeight(), getWidgetAt(), installActionListeners(), keyPressed(), recomputeDimensions(), safeDraw(), setFocusHandler(), setModel(), setSelectedColumn(), setSelectedRow(), and ~GuiTable().

◆ mOpaque

Opaque GuiTable::mOpaque

private

Definition at line 204 of file guitable.h.

Referenced by draw(), isOpaque(), safeDraw(), and setOpaque().

◆ mSelectableGui

bool GuiTable::mSelectableGui

private

Definition at line 205 of file guitable.h.

Referenced by mousePressed(), recomputeDimensions(), setSelectableGui(), and setSelectedRow().

◆ mSelectedColumn

int GuiTable::mSelectedColumn

private

Definition at line 200 of file guitable.h.

Referenced by draw(), getSelectedColumn(), keyPressed(), mousePressed(), recomputeDimensions(), safeDraw(), setSelected(), and setSelectedColumn().

◆ mSelectedRow

int GuiTable::mSelectedRow

private

Definition at line 199 of file guitable.h.

Referenced by draw(), getSelectedRow(), keyPressed(), mousePressed(), recomputeDimensions(), safeDraw(), setSelected(), and setSelectedRow().

◆ mTopWidget

Widget* GuiTable::mTopWidget

private

If someone moves a fresh widget to the top, we must display it.

Definition at line 189 of file guitable.h.

Referenced by draw(), getWidgetAt(), modelUpdated(), moveToBottom(), moveToTop(), and safeDraw().

◆ mWrappingEnabled

bool GuiTable::mWrappingEnabled

private

Definition at line 203 of file guitable.h.

Referenced by isWrappingEnabled(), mouseWheelMovedUp(), setSelectedColumn(), setSelectedRow(), and setWrappingEnabled().

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

src/gui/widgets/guitable.h (986a3bf)
src/gui/widgets/guitable.cpp (986a3bf)

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GuiTable()

◆ ~GuiTable()

Member Function Documentation

◆ draw()

◆ getChildrenArea()

◆ getColumnForX()

◆ getColumnWidth()

◆ getModel()

◆ getRowForY()

◆ getRowHeight()

◆ getSelectedColumn()

◆ getSelectedRow()

◆ getWidgetAt()

◆ installActionListeners()

◆ isOpaque()

◆ isWrappingEnabled()

◆ keyPressed()

◆ modelUpdated()

◆ mouseDragged()

◆ mousePressed()

◆ mouseWheelMovedDown()

◆ mouseWheelMovedUp()

◆ moveToBottom()

◆ moveToTop()

◆ recomputeDimensions()

◆ requestFocus()

◆ safeDraw()

◆ setFocusHandler()

◆ setLinewiseSelection()

◆ setModel()

◆ setOpaque()

◆ setSelectableGui()

◆ setSelected()

◆ setSelectedColumn()

◆ setSelectedRow()

◆ setWrappingEnabled()

◆ uninstallActionListeners()

Friends And Related Function Documentation

◆ GuiTableActionListener

Field Documentation

◆ mActionListeners2

◆ mAlpha

◆ mHighlightColor

◆ mLinewiseMode

◆ mModel

◆ mOpaque

◆ mSelectableGui

◆ mSelectedColumn

◆ mSelectedRow

◆ mTopWidget

◆ mWrappingEnabled