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

An area on the window that contains widgets. More...

#include <ui/Area.h>

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

Public Member Functions

 Area (const sf::FloatRect &rectangle)
 Construct an area for a part of the window. More...
 
 Area (float width, float height)
 Construct an area for top-left rectangle in the window. More...
 
void updateLayout ()
 Update the layout of the area and its widgets. More...
 
void onUp ()
 Change the active widget in the up direction. More...
 
void onDown ()
 Change the active widget in the down direction. More...
 
void onLeft ()
 Change the active widget in the left direction. More...
 
void onRight ()
 Change the active widget in the right direction. 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 accept (WidgetVisitor &visitor) override
 Accept the visitor. More...
 
- Public Member Functions inherited from ui::Stack
virtual ~Stack ()
 
void addChild (Widget *widget)
 Add a child to the stack. More...
 
void removeChild ()
 Remove the top child. More...
 
bool hasChildren () const
 Tell whether the stack has children. More...
 
WidgetgetTopChild ()
 Get the top child. 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...
 
- 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

An area on the window that contains widgets.

Constructor & Destructor Documentation

ui::Area::Area ( const sf::FloatRect &  rectangle)

Construct an area for a part of the window.

Parameters
rectanglethe part of the window for the area.
ui::Area::Area ( float  width,
float  height 
)

Construct an area for top-left rectangle in the window.

Parameters
widththe width of the area.
heightthe height of the area.

Member Function Documentation

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

Accept the visitor.

Parameters
visitorthe visitor.

Reimplemented from ui::Stack.

void ui::Area::onDown ( )

Change the active widget in the down direction.

void ui::Area::onLeft ( )

Change the active widget in the left direction.

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

Do something if a primary action has been triggered.

Reimplemented from ui::Widget.

void ui::Area::onRight ( )

Change the active widget in the right direction.

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

Do something if a secondary action has been triggered.

Reimplemented from ui::Widget.

void ui::Area::onUp ( )

Change the active widget in the up direction.

void ui::Area::updateLayout ( )

Update the layout of the area and its widgets.