TGUI  0.9.5
Loading...
Searching...
No Matches

Abstract class for box layout containers. More...

#include <TGUI/Widgets/BoxLayout.hpp>

Inheritance diagram for tgui::BoxLayout:
tgui::Group tgui::Container tgui::Widget tgui::BoxLayoutRatios tgui::HorizontalWrap 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::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

 BoxLayout (const char *typeName, bool initRenderer)
 
BoxLayoutRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const BoxLayoutRenderergetSharedRenderer () const
 
BoxLayoutRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const BoxLayoutRenderergetRenderer () const
 
void setSize (const Layout2d &size) override
 Changes the size of the group.
 
void add (const Widget::Ptr &widget, const String &widgetName="") override
 Adds a widget at the end of the layout.
 
virtual void insert (std::size_t index, const Widget::Ptr &widget, const String &widgetName="")
 Inserts a widget to the layout.
 
bool remove (const Widget::Ptr &widget) override
 Removes a single widget that was added to the container.
 
virtual bool remove (std::size_t index)
 Removes a single widget that was added to the container.
 
Widget::Ptr get (std::size_t index) const
 Returns the widget at the given index in the layout.
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget.
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
Widget::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier.
 
template<class T >
T::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier.
 
- Public Member Functions inherited from tgui::Group
 Group (const char *typeName="Group", bool initRenderer=true)
 
GroupRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const GroupRenderergetSharedRenderer () const
 
GroupRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const GroupRenderergetRenderer () const
 
void setSize (const Layout2d &size) override
 Changes the size of the group.
 
Vector2f getInnerSize () const override
 Returns the space available for widgets inside the container.
 
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)
 
bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
 
void draw (BackendRenderTargetBase &target, RenderStates states) const override
 Draw the child widgets to a render target.
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget.
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
- Public Member Functions inherited from tgui::Container
 Container (const char *typeName, bool initRenderer)
 
 Container (const Container &copy)
 Copy constructor.
 
 Container (Container &&copy) noexcept
 Move constructor.
 
 ~Container ()
 Destructor.
 
Containeroperator= (const Container &right)
 Overload of copy assignment operator.
 
Containeroperator= (Container &&right) noexcept
 Overload of move assignment operator.
 
const std::vector< Widget::Ptr > & getWidgets () const
 Returns a list of all the widgets in this container.
 
template<typename Function >
void sortWidgets (Function &&function)
 Sorts a list of all the widgets in this container.
 
Widget::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier.
 
template<class T >
T::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier.
 
virtual void removeAllWidgets ()
 Removes all widgets that were added to the container.
 
void setTextSize (unsigned int size) override
 Changes the character size of all existing and future child widgets.
 
void loadWidgetsFromFile (const String &filename, bool replaceExisting=true)
 Loads the child widgets from a text file.
 
void saveWidgetsToFile (const String &filename)
 Saves the child widgets to a text file.
 
void loadWidgetsFromStream (std::stringstream &stream, bool replaceExisting=true)
 Loads the child widgets from a string stream.
 
void loadWidgetsFromStream (std::stringstream &&stream, bool replaceExisting=true)
 Loads the child widgets from a string stream.
 
void saveWidgetsToStream (std::stringstream &stream, const String &rootDirectory="") const
 Saves the child widgets to a text file.
 
void loadWidgetsFromNodeTree (const std::unique_ptr< DataIO::Node > &rootNode, bool replaceExisting=true)
 Loads the child widgets from a tree of nodes that contain all information about the widgets.
 
std::unique_ptr< DataIO::Node > saveWidgetsToNodeTree (const String &rootDirectory="") const
 Saves the child widgets to a tree of nodes that contain all information about the widgets.
 
void moveWidgetToFront (const Widget::Ptr &widget)
 Places a widget before all other widgets, to the front of the z-order.
 
void moveWidgetToBack (const Widget::Ptr &widget)
 Places a widget behind all other widgets, to the back of the z-order.
 
std::size_t moveWidgetForward (const Widget::Ptr &widget)
 Places a widget one step forward in the z-order.
 
std::size_t moveWidgetBackward (const Widget::Ptr &widget)
 Places a widget one step backward in the z-order.
 
bool setWidgetIndex (const Widget::Ptr &widget, std::size_t index)
 Changes the index of a widget in this container.
 
int getWidgetIndex (const Widget::Ptr &widget) const
 Returns the current index of a widget in this container.
 
Widget::Ptr getFocusedChild () const
 Returns the child widget that is focused inside this container.
 
Widget::Ptr getFocusedLeaf () const
 Returns the leaf child widget that is focused inside this container.
 
virtual Widget::Ptr getWidgetAtPosition (Vector2f pos) const
 Returns the leaf child widget that is located at the given position.
 
bool focusNextWidget (bool recursive=true)
 Focuses the next widget in this container.
 
bool focusPreviousWidget (bool recursive=true)
 Focuses the previous widget in this container.
 
void setFocused (bool focused) override
 Focus or unfocus the widget.
 
bool processMouseMoveEvent (Vector2f pos)
 Inform the container about a mouse move event.
 
bool processMousePressEvent (Event::MouseButton button, Vector2f pos)
 Inform the container about a mouse press event.
 
bool processMouseReleaseEvent (Event::MouseButton button, Vector2f pos)
 Inform the container about a mouse release event.
 
bool processMouseWheelScrollEvent (float delta, Vector2f pos)
 Inform the container about a mouse wheel scroll event.
 
bool processKeyPressEvent (Event::KeyEvent event)
 Inform the container about a key press event.
 
bool processTextEnteredEvent (char32_t key)
 Inform the container about a key press event.
 
void childWidgetFocused (const Widget::Ptr &child)
 
void leftMousePressed (Vector2f pos) override
 
void rightMousePressed (Vector2f pos) override
 
void leftMouseReleased (Vector2f pos) override
 
void rightMouseReleased (Vector2f pos) override
 
void mouseMoved (Vector2f pos) override
 
void keyPressed (const Event::KeyEvent &event) override
 
void textEntered (char32_t key) override
 
bool mouseWheelScrolled (float delta, Vector2f pos) override
 
void mouseNoLongerOnWidget () override
 
void leftMouseButtonNoLongerDown () override
 
void rightMouseButtonNoLongerDown () override
 
Widget::Ptr askToolTip (Vector2f mousePos) override
 
bool updateTime (Duration elapsedTime) override
 
void setParent (Container *parent) override
 
void setParentGui (GuiBase *gui)
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
- Public Member Functions inherited from tgui::Widget
 Widget (const char *typeName, bool initRenderer)
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
virtual ~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.
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const WidgetRenderergetSharedRenderer () const
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
const WidgetRenderergetRenderer () const
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget.
 
Vector2f getPosition () const
 Gets the position of the widget.
 
void setSize (Layout width, Layout height)
 Changes the size of the widget.
 
void setWidth (Layout width)
 Changes the width of the widget.
 
void setHeight (Layout height)
 Changes the height of the widget.
 
Vector2f getSize () const
 Returns the size of the widget.
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using.
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the top-left point of the widget instead of the relative position to its parent.
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed.
 
void setOrigin (float x, float y)
 Sets the origin point on which the position, scale and rotation is based.
 
void setOrigin (Vector2f origin)
 Sets the origin point on which the position, scale and rotation is based.
 
Vector2f getOrigin () const
 Returns the relative origin point on which the position, scale and rotation is based.
 
void setScale (Vector2f scaleFactors)
 Sets the scaling to be applied to the widget.
 
void setScale (Vector2f scaleFactors, Vector2f origin)
 Sets the scaling to be applied to the widget.
 
void setScale (float scaleFactor)
 Sets the scaling to be applied to the widget.
 
void setScale (float scaleFactor, Vector2f origin)
 Sets the scaling to be applied to the widget.
 
Vector2f getScale () const
 Returns the scaling to be applied to the widget.
 
Vector2f getScaleOrigin () const
 Returns the origin used for scaling.
 
void setRotation (float angle)
 Sets the rotation to be applied to the widget.
 
void setRotation (float angle, Vector2f origin)
 Sets the rotation to be applied to the widget.
 
float getRotation () const
 Returns the rotation to be applied to the widget.
 
Vector2f getRotationOrigin () const
 Returns the origin used for rotations.
 
void showWithEffect (ShowEffectType type, Duration duration)
 Shows the widget by introducing it with an animation.
 
void hideWithEffect (ShowEffectType type, Duration duration)
 Hides the widget by making it leave with an animation.
 
virtual void setVisible (bool visible)
 Shows or hides a widget.
 
bool isVisible () const
 Returns true when the widget is visible.
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget.
 
bool isEnabled () const
 Returns true when the widget is enabled.
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
const StringgetWidgetType () const
 Returns the type of the widget.
 
ContainergetParent () const
 Returns a pointer to the parent widget.
 
GuiBasegetParentGui () const
 Returns a pointer to the gui to which this widget belongs.
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect)
 
void moveToFront ()
 Places the widget before all other widgets.
 
void moveToBack ()
 Places the widget behind all other widgets.
 
void setUserData (Any userData)
 Stores some data into the widget.
 
template<typename T >
getUserData () const
 Returns data stored in the widget.
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer.
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer.
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer.
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
 
virtual unsigned int getTextSize () const
 Returns the character size of text in this widget.
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget.
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget.
 
void setWidgetName (const String &name)
 Changes the name of a widget.
 
String getWidgetName () const
 Returns the name of a widget.
 
void setMouseCursor (Cursor::Type cursor)
 Changes which mouse cursor is shown when hovering over the widget.
 
Cursor::Type getMouseCursor () const
 Returns which mouse cursor is shown when hovering over the widget.
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused.
 
bool isFocusable () const
 Returns whether a widget could be focused.
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus.
 
bool isContainer () const
 Returns whether the widget is a container widget or not.
 
bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)
 
bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget.
 
virtual SignalgetSignal (String signalName)
 Retrieves a signal based on its name.
 
virtual void mousePressed (Event::MouseButton button, Vector2f pos)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
const Layout2dgetPositionLayout () const
 
const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 

Protected Member Functions

void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed.
 
virtual void updateWidgets ()=0
 
- Protected Member Functions inherited from tgui::Group
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed.
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type.
 
- Protected Member Functions inherited from tgui::Container
std::unique_ptr< DataIO::Node > save (SavingRenderersMap &renderers) const override
 Saves the widget as a tree node in order to save it to a file.
 
void load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
 Loads the widget from a tree of nodes.
 
Widget::Ptr getWidgetBelowMouse (Vector2f mousePos) const
 
Widget::Ptr updateWidgetBelowMouse (Vector2f mousePos)
 
std::size_t getFocusedWidgetIndex () const
 
bool tryFocusWidget (const tgui::Widget::Ptr &widget, bool reverseWidgetOrder, bool recursive)
 
Vector2f transformMousePos (const Widget::Ptr &widget, Vector2f mousePos) const
 
void widgetAdded (Widget::Ptr widgetPtr)
 
void injectFormFilePath (const std::unique_ptr< DataIO::Node > &node, const String &path, std::map< String, bool > &checkedFilenames) const
 
void loadWidgetsImpl (const std::unique_ptr< DataIO::Node > &rootNode, bool replaceExisting)
 
- Protected Member Functions inherited from tgui::Widget
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.
 

Protected Attributes

float m_spaceBetweenWidgetsCached = 0
 
- Protected Attributes inherited from tgui::Group
Padding m_paddingCached
 
- Protected Attributes inherited from tgui::Container
std::vector< Widget::Ptrm_widgets
 
Widget::Ptr m_widgetBelowMouse
 
Widget::Ptr m_widgetWithLeftMouseDown
 
Widget::Ptr m_widgetWithRightMouseDown
 
Widget::Ptr m_focusedWidget
 
Vector2f m_prevInnerSize
 
bool m_isolatedFocus = false
 
- Protected Attributes inherited from tgui::Widget
String m_type
 
String m_name
 
Layout2d m_position
 
Layout2d m_size
 
unsigned int m_textSize = 0
 
Vector2f m_origin
 
Optional< Vector2fm_rotationOrigin
 
Optional< Vector2fm_scaleOrigin
 
Vector2f m_scaleFactors = {1, 1}
 
float m_rotationDeg = 0
 
Vector2f m_prevPosition
 
Vector2f m_prevSize
 
std::unordered_set< Layout * > m_boundPositionLayouts
 
std::unordered_set< Layout * > m_boundSizeLayouts
 
bool m_enabled = true
 
bool m_visible = true
 
Containerm_parent = nullptr
 
GuiBasem_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
Duration m_animationTimeElapsed
 
bool m_draggableWidget = false
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::shared_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 
std::function< void(const String &property)> m_rendererChangedCallback = [this](const String& property){ rendererChangedCallback(property); }
 

Additional Inherited Members

- Static Public Member Functions inherited from tgui::Group
static Group::Ptr create (const Layout2d &size={"100%", "100%"})
 Creates a new group.
 
static Group::Ptr copy (Group::ConstPtr group)
 Makes a copy of another group.
 
- 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.
 
SignalShowEffect onAnimationFinish = {"AnimationFinished"}
 
SignalShowEffect onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 
- Protected Types inherited from tgui::Widget
using SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > >
 
using LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > >
 

Detailed Description

Abstract class for box layout containers.

Member Function Documentation

◆ add()

void tgui::BoxLayout::add ( const Widget::Ptr widget,
const 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

Reimplemented from tgui::Container.

Reimplemented in tgui::BoxLayoutRatios.

◆ get() [1/3]

Widget::Ptr tgui::Container::get ( const String widgetName) const

Returns a pointer to a widget that was added earlier.

Parameters
widgetNameThe name that was given to the widget when it was added to the container

The container will first search for widgets that are direct children of it, but when none of the child widgets match the given name, a recursive search will be performed.

Returns
Pointer to the earlier added widget
Warning
This function will return nullptr when an unknown widget name was passed

◆ get() [2/3]

template<class T >
T::Ptr tgui::Container::get ( const String widgetName) const
inline

Returns a pointer to a widget that was added earlier.

Parameters
widgetNameThe name that was given to the widget when it was added to the container
Returns
Pointer to the earlier added widget. The pointer will already be casted to the desired type

The container will first search for widgets that are direct children of it, but when none of the child widgets match the given name, a recursive search will be performed.

Warning
This function will return nullptr when an unknown widget name was passed

◆ get() [3/3]

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

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 if index was too high

◆ getRenderer()

BoxLayoutRenderer * tgui::BoxLayout::getRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer
Warning
After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSharedRenderer()

BoxLayoutRenderer * tgui::BoxLayout::getSharedRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ insert()

virtual void tgui::BoxLayout::insert ( std::size_t  index,
const Widget::Ptr widget,
const String widgetName = "" 
)
virtual

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

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

Reimplemented in tgui::BoxLayoutRatios.

◆ remove() [1/2]

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

Removes a single widget that was added to the container.

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

Reimplemented from tgui::Container.

Reimplemented in tgui::BoxLayoutRatios.

◆ remove() [2/2]

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

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 in tgui::BoxLayoutRatios, and tgui::BoxLayoutRatios.

◆ rendererChanged()

void tgui::BoxLayout::rendererChanged ( const String property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyName of the property that was changed

Reimplemented from tgui::Widget.

◆ setSize() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d size)
virtual

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

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

Changes the size of the group.

Parameters
sizeThe new size of the group

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

void tgui::Widget::setSize ( Layout  width,
Layout  height 
)
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

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