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

A widget with a single child. More...

#include <ui/Bin.h>

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

Public Member Functions

void setChild (Widget *child)
 Set the child of the widget. More...
 
bool hasChild () const
 Tell whether the widget already has a child. More...
 
WidgetgetChild ()
 Get the child of the widget. More...
 
virtual void onPrimaryAction () override
 Do something if a primary action has been triggered. More...
 
virtual void onSecondaryAction () override
 Do something if a secondary action has been triggered. More...
 
virtual void onClick (sf::Mouse::Button button, const sf::Vector2f &mouse) override
 Do something when the widget is clicked. 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::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...
 

Detailed Description

A widget with a single child.

Member Function Documentation

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

Accept the visitor.

Parameters
visitorthe visitor.

Implements ui::Widget.

Widget* ui::Bin::getChild ( )
inline

Get the child of the widget.

Returns
the child of the widget.
bool ui::Bin::hasChild ( ) const
inline

Tell whether the widget already has a child.

Returns
true if the widget has a child.
virtual void ui::Bin::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::Bin::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.

virtual void ui::Bin::onClick ( sf::Mouse::Button  button,
const sf::Vector2f &  mouse 
)
overridevirtual

Do something when the widget is clicked.

Reimplemented from ui::Widget.

virtual void ui::Bin::onPrimaryAction ( )
overridevirtual

Do something if a primary action has been triggered.

Reimplemented from ui::Widget.

virtual void ui::Bin::onSecondaryAction ( )
overridevirtual

Do something if a secondary action has been triggered.

Reimplemented from ui::Widget.

void ui::Bin::setChild ( Widget child)
inline

Set the child of the widget.

Parameters
childthe child of the widget.