TGUI  v0.7.5
tgui::BoxLayout Class Referenceabstract

Abstract class for box layout containers. More...

#include <BoxLayout.hpp>

Inheritance diagram for tgui::BoxLayout:
tgui::Panel tgui::Container tgui::Widget tgui::Transformable tgui::SignalWidgetBase tgui::HorizontalLayout tgui::VerticalLayout

Public Types

typedef std::shared_ptr< BoxLayoutPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const BoxLayoutConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Panel
typedef std::shared_ptr< PanelPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const PanelConstPtr
 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

 BoxLayout ()
 Default constructor.
 
virtual void setSize (const Layout2d &size) override
 Changes the size of the layout. More...
 
virtual void setFont (const Font &font) override
 Changes the font the child widgets. More...
 
bool insert (std::size_t index, const tgui::Widget::Ptr &widget, const sf::String &widgetName="")
 Insert a widget to the layout. More...
 
void add (const tgui::Widget::Ptr &widget, const sf::String &widgetName="") override
 Adds a widget at the end of the layout. More...
 
void addSpace (float ratio=1)
 Adds a space at the end of the layout and immediately set its ratio. More...
 
bool insertSpace (std::size_t index, float ratio=1)
 Insert a space to the layout and immediately set its ratio. 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)
 Returns the widget at the given index in the layout. More...
 
bool setRatio (const Widget::Ptr &widget, float ratio)
 Change the ratio of a widget. More...
 
bool setRatio (std::size_t index, float ratio)
 Change the ratio of a widget. The ratio is the size that will have a widget relatively to others. By default, the ratio is equal to 1. So setting a ratio to 2 means that the widget will be 2 times larger than others. More...
 
float getRatio (const Widget::Ptr &widget)
 Returns the ratio of a widget. More...
 
float getRatio (std::size_t index)
 Returns the ratio of a widget. More...
 
bool setFixedSize (const Widget::Ptr &widget, float size)
 Set the size of a widget to a constant value. More...
 
bool setFixedSize (std::size_t index, float size)
 Set the size of a widget to a constant value. More...
 
float getFixedSize (const Widget::Ptr &widget)
 Returns the size of a widget when it has a constant value. More...
 
float getFixedSize (std::size_t index)
 Returns the size of a widget when it has a constant value. More...
 
void removeAllWidgets () override
 Removes all widgets that were added to the container.
 
- Public Member Functions inherited from tgui::Panel
 Panel (const Layout2d &size={100, 100})
 Default constructor. More...
 
 Panel (const Layout &width, const Layout &height)
 Constructor. More...
 
std::shared_ptr< PanelRenderergetRenderer () const
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setBackgroundColor (const Color &backgroundColor)
 Changes the background color of the panel. More...
 
const sf::Color & getBackgroundColor () const
 Returns the background color of the panel. More...
 
- Public Member Functions inherited from tgui::Container
 Container (const Container &copy)
 Copy constructor. More...
 
Containeroperator= (const Container &right)
 Overload of assignment operator. More...
 
const std::vector< Widget::Ptr > & getWidgets ()
 Returns a list of all the widgets. More...
 
const std::vector< sf::String > & getWidgetNames ()
 Returns a list of the names of all the widgets. More...
 
Widget::Ptr get (const sf::String &widgetName, bool recursive=false) const
 Returns a pointer to an earlier created widget. More...
 
template<class T >
T::Ptr get (const sf::String &widgetName, bool recursive=false) const
 Returns a pointer to an earlier created widget. More...
 
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 focusWidget (Widget *const widget)
 Focuses a widget. More...
 
void focusNextWidget ()
 Focuses the next widget. More...
 
void focusPreviousWidget ()
 Focuses the previous widget. More...
 
void unfocusWidgets ()
 Unfocus all the widgets.
 
void uncheckRadioButtons ()
 Uncheck all the radio buttons.
 
virtual void setOpacity (float opacity) override
 Changes the opacity of the container and all its child widgets. More...
 
virtual sf::Vector2f getChildWidgetsOffset () const
 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...
 
void loadWidgetsFromFile (const std::string &filename)
 Load the child widgets from a text file. More...
 
void saveWidgetsToFile (const std::string &filename)
 Save the child widgets to a text file. More...
 
void loadWidgetsFromStream (std::stringstream &stream)
 Load the child widgets from a string stream. More...
 
void saveWidgetsToStream (std::stringstream &stream)
 Save the child widgets to a text file. More...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &copy)
 Copy constructor. More...
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &right)
 Overload of assignment operator. More...
 
std::shared_ptr< 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
 set 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 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 (bool blockMouseEvents=true)
 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...
 
float getOpacity () const
 Returns the opacity of the 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...
 
std::shared_ptr< sf::Font > getFont () const
 Returns the font associated with the widget (if any) More...
 
void detachTheme ()
 Detach the theme from the widget. More...
 
std::shared_ptr< BaseThemegetTheme () const
 Returns the theme to which the widget is currently connected. More...
 
std::string getPrimaryLoadingParameter () const
 Returns the primary parameter that was passed to the loader to load this widget. More...
 
std::string getSecondaryLoadingParameter () const
 Returns the secondary parameter that was passed to the loader to load this widget. More...
 
virtual sf::Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
- Public Member Functions inherited from tgui::Transformable
virtual ~Transformable ()=default
 Virtual destructor.
 
void setPosition (const Layout &x, const Layout &y)
 set the position of the widget More...
 
sf::Vector2f getPosition () const
 get the position of the widget More...
 
void move (const Layout2d &offset)
 Move the widget by a given offset. More...
 
void move (const Layout &x, const Layout &y)
 Move the widget by a given offset. More...
 
void setSize (const Layout &width, const 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...
 
void scale (const Layout2d &factors)
 Scale the widget. More...
 
void scale (const Layout &x, const Layout &y)
 Scale the widget. More...
 
- Public Member Functions inherited from tgui::SignalWidgetBase
 SignalWidgetBase ()=default
 Default constructor.
 
 SignalWidgetBase (const SignalWidgetBase &copy)
 Copy constructor. More...
 
SignalWidgetBaseoperator= (const SignalWidgetBase &right)
 Overload of assignment operator. More...
 
template<typename Func , typename... Args>
unsigned int connect (const std::string &signalNames, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
template<typename Func , typename... Args>
unsigned int connectEx (const std::string &signalName, Func func, Args... args)
 Connects a signal handler function to one or more signals. More...
 
void disconnect (unsigned int id)
 Disconnects a connection. More...
 
void disconnectAll (const std::string &signalName)
 Disconnect all connections from a certain signal. More...
 
void disconnectAll ()
 Disconnect all connections from a all signals.
 

Protected Attributes

std::vector< float > m_widgetsRatio
 The ratio of each widget.
 
std::vector< float > m_widgetsFixedSizes
 The fixed size for each widget. 0 means a variable size.
 

Additional Inherited Members

- Static Public Member Functions inherited from tgui::Panel
static Panel::Ptr create (Layout2d size={100, 100})
 Creates a new panel widget. More...
 
static Panel::Ptr copy (Panel::ConstPtr panel)
 Makes a copy of another panel. More...
 
- Protected Member Functions inherited from tgui::Panel
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::Container
void moveWidgetToFront (Widget *const widget)
 Places a widget before all other widgets. More...
 
void moveWidgetToBack (Widget *const widget)
 Places a widget behind all other widgets. More...
 
- Protected Member Functions inherited from tgui::Widget
void attachTheme (std::shared_ptr< BaseTheme > theme)
 Attach a theme to the widget. More...
 
virtual void reload (const std::string &primary="", const std::string &secondary="", bool force=false)
 Reload the widget. More...
 

Detailed Description

Abstract class for box layout containers.

Member Function Documentation

◆ add()

void tgui::BoxLayout::add ( const tgui::Widget::Ptr widget,
const sf::String &  widgetName = "" 
)
overridevirtual

Adds a widget at the end of the layout.

Parameters
widgetPointer to the widget you would like to add
widgetNameAn identifier to access to the widget later

The widget will have ratio 1.

Reimplemented from tgui::Container.

◆ addSpace()

void tgui::BoxLayout::addSpace ( float  ratio = 1)

Adds a space at the end of the layout and immediately set its ratio.

Parameters
ratioRatio for the space

◆ get()

Widget::Ptr tgui::BoxLayout::get ( std::size_t  index)

Returns the widget at the given index in the layout.

Parameters
indexIndex of the widget in the layout
Returns
Widget of given index, or nullptr when index was too high

◆ getFixedSize() [1/2]

float tgui::BoxLayout::getFixedSize ( const Widget::Ptr widget)

Returns the size of a widget when it has a constant value.

Having a fixed size cancel the effect of the ratio. When 0 is returned then the size of the widget is variable and determined by the ratio.

Parameters
widgetPointer to the widget
Returns
Fixed size of the widget or 0 when size is variable

◆ getFixedSize() [2/2]

float tgui::BoxLayout::getFixedSize ( std::size_t  index)

Returns the size of a widget when it has a constant value.

Having a fixed size cancel the effect of the ratio. When 0 is returned then the size of the widget is variable and determined by the ratio.

Parameters
indexIndex of the widget in the layout
Returns
Fixed size of the widget or 0 when size is variable or index is too high

◆ getRatio() [1/2]

float tgui::BoxLayout::getRatio ( const Widget::Ptr widget)

Returns the ratio of a widget.

The ratio is the size that will have a widget relatively to others. By default, the ratio is equal to 1. So setting a ratio to 2 means that the widget will be 2 times larger than others.

Parameters
widgetPointer to the widget
Returns
Ratio given to the widget

◆ getRatio() [2/2]

float tgui::BoxLayout::getRatio ( std::size_t  index)

Returns the ratio of a widget.

The ratio is the size that will have a widget relatively to others. By default, the ratio is equal to 1. So setting a ratio to 2 means that the widget will be 2 times larger than others.

Parameters
indexIndex of the widget in the layout
Returns
Ratio given to the widget or 0 when when the index was too high

◆ insert()

bool tgui::BoxLayout::insert ( std::size_t  index,
const tgui::Widget::Ptr widget,
const sf::String &  widgetName = "" 
)

Insert a widget to the layout.

Parameters
widgetPointer to the widget you would like to add
indexIndex of the widget in the container
widgetNameAn identifier to access to the widget later

The widget will have ratio 1.

If the index is too high, the widget will simply be added at the end of the list.

Returns
False when the index was too high

◆ insertSpace()

bool tgui::BoxLayout::insertSpace ( std::size_t  index,
float  ratio = 1 
)

Insert a space to the layout and immediately set its ratio.

Parameters
indexIndex of the space in the container
ratioRatio for the space

If the index is too high, the space will simply be added at the end of the list.

Returns
False when the index was too high

◆ remove() [1/2]

bool tgui::BoxLayout::remove ( const tgui::Widget::Ptr widget)
overridevirtual

Removes a single widget that was added to the container.

Parameters
widgetPointer to the widget to remove
Returns
True when widget is removed, false when widget was not found

Reimplemented from tgui::Container.

◆ remove() [2/2]

bool tgui::BoxLayout::remove ( std::size_t  index)

Removes a single widget that was added to the container.

Parameters
indexIndex in the layout of the widget to remove
Returns
False when the index was too high

◆ setFixedSize() [1/2]

bool tgui::BoxLayout::setFixedSize ( const Widget::Ptr widget,
float  size 
)

Set the size of a widget to a constant value.

Setting a fixed size cancel the effect of the ratio. If you want to get a variable size again for a widget, set the fixed size to 0.

Parameters
widgetPointer to the widget
sizeNew fixed size of the widget
Returns
False when the widget was not found

◆ setFixedSize() [2/2]

bool tgui::BoxLayout::setFixedSize ( std::size_t  index,
float  size 
)

Set the size of a widget to a constant value.

Setting a fixed size cancel the effect of the ratio. If you want to get a variable size again for a widget, set the fixed size to 0.

Parameters
indexIndex of the widget in the layout
sizeNew fixed size of the widget
Returns
False when the index was too high

◆ setFont()

virtual void tgui::BoxLayout::setFont ( const Font font)
overridevirtual

Changes the font the child widgets.

Parameters
fontThe new font.

When you don't call this function then the font from the parent widget will be used.

Reimplemented from tgui::Container.

◆ setRatio() [1/2]

bool tgui::BoxLayout::setRatio ( const Widget::Ptr widget,
float  ratio 
)

Change the ratio of a widget.

The ratio is the size that will have a widget relatively to others. By default, the ratio is equal to 1. So setting a ratio to 2 means that the widget will be 2 times larger than others.

Parameters
widgetPointer to the widget
ratioNew ratio to set to the widget
Returns
True when the ratio was changed, false when the widget was not found

◆ setRatio() [2/2]

bool tgui::BoxLayout::setRatio ( std::size_t  index,
float  ratio 
)

Change the ratio of a widget. The ratio is the size that will have a widget relatively to others. By default, the ratio is equal to 1. So setting a ratio to 2 means that the widget will be 2 times larger than others.

Parameters
indexIndex of the widget in the layout
ratioNew ratio to set to the widget

If the index was too high then no change will be made

Returns
False when the index was too high

◆ setSize()

virtual void tgui::BoxLayout::setSize ( const Layout2d size)
overridevirtual

Changes the size of the layout.

Parameters
sizeThe new size of the layout

Reimplemented from tgui::Widget.


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