libsuit  0.1.1
SFML User Interface Toolkit
Public Types | Public Member Functions | List of all members
ui::Table Class Reference

A table widget. More...

#include <ui/Table.h>

Inheritance diagram for ui::Table:
Inheritance graph
[legend]

Public Types

typedef Container::size_type size_type
 
- Public Types inherited from ui::Container
typedef std::vector< Widget * >
::size_type 
size_type
 
typedef std::vector< Widget * >
::iterator 
iterator
 

Public Member Functions

 Table (size_type cols, size_type rows)
 Construct a table widget with a specified number of columns and rows. More...
 
size_type getColumnsCount () const
 Get the number of columns. More...
 
size_type getRowsCount () const
 Get the number of rows. More...
 
void setHorizontalGap (float gap)
 Set the horizontal gap between columns. More...
 
float getHorizontalGap () const
 Get the horizontal gap between columns. More...
 
void setVerticalGap (float gap)
 Set the vertical gap between rows. More...
 
float getVerticalGap () const
 Get the vertical gap between rows. More...
 
virtual void layoutRequest () override
 Compute the size hint of the widget. More...
 
virtual void layoutAllocation () override
 Compute the size of the widget. More...
 
virtual void accept (WidgetVisitor &visitor) override
 Accept the visitor. More...
 
- Public Member Functions inherited from ui::Container
virtual ~Container ()
 Destroy the container. More...
 
bool hasChildren () const
 Tell whether the container has children. More...
 
void addChild (Widget *widget)
 Add a child to the container. More...
 
size_type getChildrenCount () const
 Get the number of children of the container. More...
 
WidgetithChild (size_type i)
 Return the ith child of the container. More...
 
iterator begin ()
 Get the beginning of the container. More...
 
iterator end ()
 Get the end of the container. More...
 
virtual void onClick (sf::Mouse::Button button, const sf::Vector2f &mouse) override
 Do something when the widget is clicked. More...
 
- Public Member Functions inherited from ui::Widget
 Widget ()
 Construct a widget. More...
 
 Widget (const Widget &)=delete
 
Widgetoperator= (const Widget &)=delete
 
 Widget (Widget &&)=delete
 
Widgetoperator= (Widget &&)=delete
 
virtual ~Widget ()
 Destroy a widget. More...
 
void setSizeHint (float width, float height)
 Set the size hint of the widget. More...
 
sf::Vector2f getSizeHint () const
 Get the size hint of the widget. More...
 
void setHorizontalPolicy (SizePolicy policy)
 Set the horizontal size policy. More...
 
void setVerticalPolicy (SizePolicy policy)
 Set the vertical size policy. More...
 
void setSizePolicy (SizePolicy horizontal, SizePolicy vertical)
 Set the size policy. More...
 
void setHorizontalAlignment (Alignment alignment)
 Set the horizontal alignment policy. More...
 
void setVerticalAlignment (Alignment alignment)
 Set the vertical alignment policy. More...
 
const GeometrygetHorizontalGeometry () const
 Get the horizontal geometry. More...
 
GeometrygetHorizontalGeometry ()
 Get the horizontal geometry. More...
 
const GeometrygetVerticalGeometry () const
 Get the vertical geometry. More...
 
GeometrygetVerticalGeometry ()
 Get the vertical geometry. More...
 
void setGeometry (const sf::FloatRect &geometry)
 Set the vertical geometry thanks to a rectangle. More...
 
const sf::FloatRect getGeometry () const
 Get the geometry of the widget. More...
 
sf::Vector2f getCenter () const
 Get the center of the widget. More...
 
virtual void onPrimaryAction ()
 Do something if a primary action has been triggered. More...
 
virtual void onSecondaryAction ()
 Do something if a secondary action has been triggered. More...
 

Detailed Description

A table widget.

A table widget is a widget that organizes a collection of widgets in columns and rows.

Member Typedef Documentation

Constructor & Destructor Documentation

ui::Table::Table ( size_type  cols,
size_type  rows 
)
inline

Construct a table widget with a specified number of columns and rows.

Parameters
colsthe number of columns
rowsthe number of rows

Member Function Documentation

virtual void ui::Table::accept ( WidgetVisitor visitor)
overridevirtual

Accept the visitor.

Parameters
visitorthe visitor.

Implements ui::Widget.

Reimplemented in ui::Form, ui::HBox, and ui::VBox.

size_type ui::Table::getColumnsCount ( ) const
inline

Get the number of columns.

Returns
the number of columns
float ui::Table::getHorizontalGap ( ) const
inline

Get the horizontal gap between columns.

Returns
the horizontal gap
size_type ui::Table::getRowsCount ( ) const
inline

Get the number of rows.

Returns
the number of rows
float ui::Table::getVerticalGap ( ) const
inline

Get the vertical gap between rows.

Returns
the vertical gap
virtual void ui::Table::layoutAllocation ( )
overridevirtual

Compute the size of the widget.

The computation of the size takes into account the size of the parent of the widget. This is a top-down process.

Implements ui::Widget.

virtual void ui::Table::layoutRequest ( )
overridevirtual

Compute the size hint of the widget.

The computation of the size hint takes into account the size of the children of the widget. This is a bottom-up process.

Implements ui::Widget.

void ui::Table::setHorizontalGap ( float  gap)
inline

Set the horizontal gap between columns.

Parameters
gapthe gap (in pixels)
void ui::Table::setVerticalGap ( float  gap)
inline

Set the vertical gap between rows.

Parameters
gapthe gap (in pixels)