TGUI  0.8-dev
tgui::BoxLayoutRatios Class Reference

Abstract class for box layout containers. More...

#include <BoxLayoutRatios.hpp>

Inheritance diagram for tgui::BoxLayoutRatios:
tgui::BoxLayout tgui::Group tgui::Container tgui::Widget tgui::SignalWidgetBase tgui::HorizontalLayout tgui::VerticalLayout

Public Types

typedef std::shared_ptr< BoxLayoutRatiosPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const BoxLayoutRatiosConstPtr
 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

void add (const tgui::Widget::Ptr &widget, const sf::String &widgetName="") override
 Adds a widget at the end of the layout. More...
 
void add (const tgui::Widget::Ptr &widget, float ratio, const sf::String &widgetName="")
 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="") override
 Inserts a widget to the layout. More...
 
void insert (std::size_t index, const tgui::Widget::Ptr &widget, float ratio, const sf::String &widgetName="")
 Inserts a widget to the layout. More...
 
bool remove (std::size_t index) override
 Removes a single widget that was added to the container. More...
 
void removeAllWidgets () override
 Removes all widgets that were added to the container.
 
void addSpace (float ratio)
 Add an extra space after the last widget. More...
 
void insertSpace (std::size_t index, float ratio)
 Insert an extra space between widgets. More...
 
bool setRatio (Widget::Ptr widget, float ratio)
 Changes the ratio of a widget. More...
 
bool setRatio (std::size_t index, float ratio)
 Changes the ratio of a widget at a certain index. More...
 
float getRatio (Widget::Ptr widget) const
 Returns the ratio of a widget at a certain index. More...
 
float getRatio (std::size_t index) const
 Returns the ratio of a widget at a certain index. More...
 
- Public Member Functions inherited from tgui::BoxLayout
BoxLayoutRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
BoxLayoutRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the group. More...
 
bool remove (const tgui::Widget::Ptr &widget) override
 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={"100%", "100%"})
 Default constructor. More...
 
GroupRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
GroupRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the group. More...
 
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...
 
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...
 
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.
 
 Container (Container &&copy)
 Move constructor.
 
 ~Container ()
 Destructor.
 
Containeroperator= (const Container &right)
 Overload of copy assignment operator.
 
Containeroperator= (Container &&right)
 Overload of move assignment operator.
 
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...
 
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 (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
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...
 
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...
 
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. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
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::SignalWidgetBase
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(const Args &...)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, const Args &... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if< std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)>>::value &&!std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)>>::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs>
unsigned int connect (std::initializer_list< std::string > signalNames, Func &&handler, BoundArgs &&... args)
 Connect a signal handler to multiple signals. More...
 
bool disconnect (unsigned int id)
 Disconnects a signal handler. More...
 
void disconnectAll (std::string signalName)
 Disconnects all signal handler from a certain signal. More...
 
void disconnectAll ()
 Disconnects all signal handlers from signals.
 

Additional Inherited Members

- Static Public Member Functions inherited from tgui::Group
static Group::Ptr create (const Layout2d &size={"100%", "100%"})
 Creates a new group. More...
 
static Group::Ptr copy (Group::ConstPtr group)
 Makes a copy of another group. More...
 
- Public Attributes inherited from tgui::Widget
SignalVector2f onPositionChange = {"PositionChanged"}
 The position of the widget changed. Optional parameter: new position.
 
SignalVector2f onSizeChange = {"SizeChanged"}
 The size of the widget changed. Optional parameter: new size.
 
Signal onFocus = {"Focused"}
 The widget was focused.
 
Signal onUnfocus = {"Unfocused"}
 The widget was unfocused.
 
Signal onMouseEnter = {"MouseEntered"}
 The mouse entered the widget.
 
Signal onMouseLeave = {"MouseLeft"}
 The mouse left the widget.
 
- Protected Member Functions inherited from tgui::BoxLayout
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::Group
void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. More...
 
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::Widget
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.
 

Detailed Description

Abstract class for box layout containers.

Member Function Documentation

◆ add() [1/2]

void tgui::BoxLayoutRatios::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 a ratio of 1.

Reimplemented from tgui::BoxLayout.

◆ add() [2/2]

void tgui::BoxLayoutRatios::add ( const tgui::Widget::Ptr widget,
float  ratio,
const sf::String &  widgetName = "" 
)

Adds a widget at the end of the layout.

Parameters
widgetPointer to the widget you would like to add
ratioRatio to determine the size compared to other widgets
widgetNameAn identifier to access to the widget later

◆ addSpace()

void tgui::BoxLayoutRatios::addSpace ( float  ratio)

Add an extra space after the last widget.

Parameters
ratioRatio to determine the size compared to other widgets

The space will act as an invisible non-interactable widget, the ratio will be part of the total ratio of all widgets.

◆ getRatio() [1/2]

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

Returns the ratio of a widget at a certain index.

Parameters
widgetWidget from which the ratio should be returned
Returns
The ratio of the widget or 0 when the widget was not found

◆ getRatio() [2/2]

float tgui::BoxLayoutRatios::getRatio ( std::size_t  index) const

Returns the ratio of a widget at a certain index.

Parameters
indexIndex of the widget from which the ratio should be returned
Returns
The ratio of the widget or 0 when the index was too high

◆ insert() [1/2]

void tgui::BoxLayoutRatios::insert ( std::size_t  index,
const tgui::Widget::Ptr widget,
const sf::String &  widgetName = "" 
)
overridevirtual

Inserts 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 a ratio of 1.

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

Reimplemented from tgui::BoxLayout.

◆ insert() [2/2]

void tgui::BoxLayoutRatios::insert ( std::size_t  index,
const tgui::Widget::Ptr widget,
float  ratio,
const sf::String &  widgetName = "" 
)

Inserts a widget to the layout.

Parameters
indexIndex of the widget in the container
widgetPointer to the widget you would like to add
ratioRatio to determine the size compared to other widgets
widgetNameAn identifier to access to the widget later

The ratio is relative to all other widgets in the layout. If one widget has ratio 10 and the other has ratio 5, the first widget will be twice as large as the second one.

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

◆ insertSpace()

void tgui::BoxLayoutRatios::insertSpace ( std::size_t  index,
float  ratio 
)

Insert an extra space between widgets.

Parameters
indexIndex of the widget in the container
ratioRatio to determine the size compared to other widgets

The space will act as an invisible non-interactable widget, the ratio will be part of the total ratio of all widgets.

◆ remove()

bool tgui::BoxLayoutRatios::remove ( std::size_t  index)
overridevirtual

Removes a single widget that was added to the container.

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

Reimplemented from tgui::BoxLayout.

◆ setRatio() [1/2]

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

Changes the ratio of a widget.

Parameters
widgetWidget from which the ratio should be changed
ratioNew ratio to determine the size compared to other widgets

The ratio is relative to all other widgets in the layout. If one widget has ratio 10 and the other has ratio 5, the first widget will be twice as large as the second one.

Returns
False when the the widget was not found, true when the widget was valid and the ratio was changed

◆ setRatio() [2/2]

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

Changes the ratio of a widget at a certain index.

Parameters
indexIndex of the widget or space
ratioNew ratio to determine the size compared to other widgets

The ratio is relative to all other widgets in the layout. If one widget has ratio 10 and the other has ratio 5, the first widget will be twice as large as the second one.

Returns
False when the index was too high, true when the index was valid and the ratio was changed

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