TGUI  0.8-dev

Container that automatically resizes children to fit the entire available space between children. More...

#include <HorizontalLayout.hpp>

Inheritance diagram for tgui::HorizontalLayout:
tgui::BoxLayout tgui::Group tgui::Container tgui::Widget tgui::Transformable tgui::SignalWidgetBase

Public Types

typedef std::shared_ptr< HorizontalLayoutPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const HorizontalLayoutConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::BoxLayout
typedef std::shared_ptr< BoxLayoutPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const BoxLayoutConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Group
typedef std::shared_ptr< GroupPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const GroupConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Container
typedef std::shared_ptr< ContainerPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ContainerConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

HorizontalLayout::Ptr copy (ConstPtr layout)
 Makes a copy of another layout. More...
 
- Public Member Functions inherited from tgui::BoxLayout
BoxLayoutRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setSize (const Layout2d &size) override
 Changes the size of the group. More...
 
void add (const tgui::Widget::Ptr &widget, const sf::String &widgetName="") override
 Adds a widget at the end of the layout. More...
 
void insert (std::size_t index, const tgui::Widget::Ptr &widget, const sf::String &widgetName="")
 Inserts a widget to the layout. More...
 
bool remove (const tgui::Widget::Ptr &widget) override
 Removes a single widget that was added to the container. More...
 
bool remove (std::size_t index)
 Removes a single widget that was added to the container. More...
 
Widget::Ptr get (std::size_t index) const
 Returns the widget at the given index in the layout. More...
 
- Public Member Functions inherited from tgui::Group
 Group (const Layout2d &size={RelLayout{1}, RelLayout{1}})
 Default constructor. More...
 
GroupRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual sf::Vector2f getContentSize () const override
 Returns the size available for child widgets. More...
 
virtual sf::Vector2f getChildWidgetsOffset () const override
 Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0) More...
 
virtual bool mouseOnWidget (sf::Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
virtual void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the child widgets to a render target. More...
 
- Public Member Functions inherited from tgui::Container
 Container (const Container &copy)
 Copy constructor. More...
 
 ~Container ()
 Destructor.
 
Containeroperator= (const Container &right)
 Overload of assignment operator. More...
 
const std::vector< Widget::Ptr > & getWidgets () const
 Returns a list of all the widgets. More...
 
const std::vector< sf::String > & getWidgetNames () const
 Returns a list of the names of all the widgets. More...
 
Widget::Ptr get (const sf::String &widgetName) const
 Returns a pointer to an earlier created widget. More...
 
template<class T >
T::Ptr get (const sf::String &widgetName) const
 Returns a pointer to an earlier created widget. More...
 
virtual void removeAllWidgets ()
 Removes all widgets that were added to the container.
 
bool setWidgetName (const Widget::Ptr &widget, const std::string &name)
 Changes the name of a widget. More...
 
std::string getWidgetName (const Widget::Ptr &widget) const
 Returns the name of a widget. More...
 
void focusWidget (const Widget::Ptr &widget)
 Focuses a widget. More...
 
void focusNextWidget ()
 Focuses the next widget. More...
 
void focusPreviousWidget ()
 Focuses the previous widget. More...
 
void unfocusWidgets ()
 Unfocuses all the widgets.
 
void uncheckRadioButtons ()
 Unchecks all the radio buttons.
 
void loadWidgetsFromFile (const std::string &filename)
 Loads the child widgets from a text file. More...
 
void saveWidgetsToFile (const std::string &filename)
 Saves the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream)
 Loads the child widgets from a string stream. More...
 
void loadWidgetsFromStream (std::stringstream &&stream)
 Loads the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream) const
 Saves the child widgets to a text file. More...
 
void moveWidgetToFront (const Widget::Ptr &widget)
 Places a widget before all other widgets. More...
 
void moveWidgetToBack (const Widget::Ptr &widget)
 Places a widget behind all other widgets. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (const std::shared_ptr< RendererData > &rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position) override
 sets the position of the widget More...
 
virtual sf::Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
virtual void show ()
 Shows the widget. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hide ()
 Hides the widget. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void enable ()
 Enables the widget. More...
 
virtual void disable ()
 Disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void focus ()
 Focus the widget. More...
 
virtual void unfocus ()
 Unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
virtual void moveToFront ()
 Places the widget before all other widgets.
 
virtual void moveToBack ()
 Places the widget behind all other widgets.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip ()
 Returns the tool tip that is displayed when hovering over the widget. More...
 
- Public Member Functions inherited from tgui::Transformable
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
sf::Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
virtual sf::Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual sf::Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
unsigned int connect (std::string signalName, const Signal::Delegate &handler)
 Connects a signal handler that will be called when this signal is emitted. More...
 
unsigned int connect (std::string signalName, const Signal::DelegateEx &handler)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(Args...)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, Args &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(std::shared_ptr< Widget >, const std::string &, Args...)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, Args &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
bool disconnect (std::string signalName, unsigned int id)
 Disconnects a signal handler. More...
 

Static Public Member Functions

static HorizontalLayout::Ptr create (const Layout2d &size={RelLayout{1}, RelLayout{1}})
 Creates a new horizontal layout widget. More...
 
- Static Public Member Functions inherited from tgui::Group
static Group::Ptr create (const Layout2d &size={RelLayout{1}, RelLayout{1}})
 Creates a new group. More...
 
static Group::Ptr copy (Group::ConstPtr group)
 Makes a copy of another group. More...
 

Protected Member Functions

virtual Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::BoxLayout
virtual void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. More...
 
- Protected Member Functions inherited from tgui::Widget
virtual SignalgetSignal (std::string &&signalName) override
 Retrieves a signal based on its name. More...
 
virtual void mouseEnteredWidget ()
 This function is called when the mouse enters the widget.
 
virtual void mouseLeftWidget ()
 This function is called when the mouse leaves the widget.
 

Additional Inherited Members

- Public Attributes inherited from tgui::Widget
SignalWrapper< SignalVector2f > onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalWrapper< SignalVector2f > onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
SignalWrapper< SignalonFocus = {"Focused"}
 The widget was focused.
 
SignalWrapper< SignalonUnfocus = {"Unfocused"}
 The widget was unfocused.
 
SignalWrapper< SignalonMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
SignalWrapper< SignalonMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 

Detailed Description

Container that automatically resizes children to fit the entire available space between children.

The children are positioned side by side.

Member Function Documentation

◆ clone()

virtual Widget::Ptr tgui::HorizontalLayout::clone ( ) const
inlineoverrideprotectedvirtual

Makes a copy of the widget if you don't know its exact type.

This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.

Returns
Copy of the widget

Reimplemented from tgui::Group.

◆ copy()

HorizontalLayout::Ptr tgui::HorizontalLayout::copy ( ConstPtr  layout)

Makes a copy of another layout.

Parameters
layoutThe other layout
Returns
The new layout

◆ create()

static HorizontalLayout::Ptr tgui::HorizontalLayout::create ( const Layout2d size = {RelLayout{1}, RelLayout{1}})
static

Creates a new horizontal layout widget.

Parameters
sizeSize of the horizontal layout
Returns
The new horizontal layout

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