TGUI  1.1
Loading...
Searching...
No Matches

Group of widgets that has a background color and optional borders. More...

#include <TGUI/Widgets/Panel.hpp>

Inheritance diagram for tgui::Panel:
tgui::Group tgui::Container tgui::Widget tgui::ScrollablePanel tgui::PanelListBox

Public Types

using Ptr = std::shared_ptr< Panel >
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr< const Panel >
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Group
using Ptr = std::shared_ptr< Group >
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr< const Group >
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Container
using Ptr = std::shared_ptr< Container >
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr< const Container >
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
using Ptr = std::shared_ptr< Widget >
 Shared widget pointer.
 
using ConstPtr = std::shared_ptr< const Widget >
 Shared constant widget pointer.
 

Public Member Functions

 Panel (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
TGUI_NODISCARD PanelRenderergetSharedRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
TGUI_NODISCARD const PanelRenderergetSharedRenderer () const override
 
TGUI_NODISCARD PanelRenderergetRenderer () override
 Returns the renderer, which gives access to functions that determine how the widget is displayed.
 
void setSize (const Layout2d &size) override
 Changes the size of the panel.
 
TGUI_NODISCARD Vector2f getInnerSize () const override
 Returns the space available for widgets inside the container.
 
TGUI_NODISCARD 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)
 
TGUI_NODISCARD bool isMouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
 
bool leftMousePressed (Vector2f pos) override
 Called by the parent when the left mouse button goes down on top of the widget.
 
void leftMouseReleased (Vector2f pos) override
 
void rightMousePressed (Vector2f pos) override
 
void rightMouseReleased (Vector2f pos) override
 
void rightMouseButtonNoLongerDown () override
 
void draw (BackendRenderTarget &target, RenderStates states) const override
 Draw the widget 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::Group
 Group (const char *typeName=StaticWidgetType, bool initRenderer=true)
 
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 () override
 Destructor.
 
Containeroperator= (const Container &right)
 Overload of copy assignment operator.
 
Containeroperator= (Container &&right) noexcept
 Overload of move assignment operator.
 
TGUI_NODISCARD 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.
 
virtual void add (const Widget::Ptr &widgetPtr, const String &widgetName="")
 Adds a widget to the container.
 
TGUI_NODISCARD Widget::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier.
 
template<class WidgetType >
TGUI_NODISCARD WidgetType::Ptr get (const String &widgetName) const
 Returns a pointer to a widget that was added earlier.
 
virtual bool remove (const Widget::Ptr &widget)
 Removes a single widget that was added to the container.
 
virtual void removeAllWidgets ()
 Removes all widgets that were added to the container.
 
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.
 
TGUI_NODISCARD 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.
 
virtual bool setWidgetIndex (const Widget::Ptr &widget, std::size_t index)
 Changes the index of a widget in this container.
 
TGUI_NODISCARD int getWidgetIndex (const Widget::Ptr &widget) const
 Returns the current index of a widget in this container.
 
TGUI_NODISCARD Widget::Ptr getFocusedChild () const
 Returns the child widget that is focused inside this container.
 
TGUI_NODISCARD Widget::Ptr getFocusedLeaf () const
 Returns the leaf child widget that is focused inside this container.
 
virtual TGUI_NODISCARD 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 processScrollEvent (float delta, Vector2f pos, bool touch)
 Inform the container about a scroll event (either mouse wheel or two finger scrolling on touchscreen)
 
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 mouseMoved (Vector2f pos) override
 
void keyPressed (const Event::KeyEvent &event) override
 
bool canHandleKeyPress (const Event::KeyEvent &event) override
 Called by the parent of the widget to check if keyPressed would process the event.
 
void textEntered (char32_t key) override
 
bool scrolled (float delta, Vector2f pos, bool touch) override
 Called by the parent on scroll event (either from mouse wheel of from two finger scrolling on a touchscreen)
 
void mouseNoLongerOnWidget () override
 
void leftMouseButtonNoLongerDown () override
 
TGUI_NODISCARD Widget::Ptr askToolTip (Vector2f mousePos) override
 
void setParent (Container *parent) override
 
void setParentGui (BackendGui *gui)
 
void updateChildrenWithAutoLayout ()
 
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 &&) noexcept
 Move constructor.
 
virtual ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&) noexcept
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks.
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Vector2f getSize () const
 Returns the size of the widget.
 
virtual TGUI_NODISCARD Vector2f getFullSize () const
 Returns the entire size that the widget is using.
 
virtual TGUI_NODISCARD Vector2f getAbsolutePosition (Vector2f offset={}) const
 Get the absolute position of the widget instead of the relative position to its parent.
 
virtual TGUI_NODISCARD Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed.
 
void setAutoLayout (AutoLayout layout)
 
TGUI_NODISCARD AutoLayout getAutoLayout () const
 
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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD Vector2f getScale () const
 Returns the scaling to be applied to the widget.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD float getRotation () const
 Returns the rotation to be applied to the widget.
 
TGUI_NODISCARD 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.
 
void moveWithAnimation (Layout2d position, Duration duration)
 Moves the widget from its current position to the given position, over a given duration.
 
void resizeWithAnimation (Layout2d size, Duration duration)
 Resizes the widget from its current size to the given size, over a given duration.
 
virtual void setVisible (bool visible)
 Shows or hides a widget.
 
TGUI_NODISCARD bool isVisible () const
 Returns true when the widget is visible.
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget.
 
TGUI_NODISCARD bool isEnabled () const
 Returns true when the widget is enabled.
 
TGUI_NODISCARD bool isFocused () const
 Returns true when the widget is focused and false otherwise.
 
TGUI_NODISCARD const StringgetWidgetType () const
 Returns the type of the widget.
 
TGUI_NODISCARD ContainergetParent () const
 Returns a pointer to the parent widget.
 
TGUI_NODISCARD BackendGuigetParentGui () const
 Returns a pointer to the gui to which this widget belongs.
 
TGUI_NODISCARD 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 DataType >
TGUI_NODISCARD DataType getUserData () const
 Returns data stored in the widget.
 
TGUI_NODISCARD bool hasUserData () const
 Returns whether 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer.
 
void setTextSize (unsigned int size)
 Changes the character size of text in this widget if it uses text.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD 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.
 
TGUI_NODISCARD bool isFocusable () const
 Returns whether a widget could be focused.
 
void setNavigationUp (const Widget::Ptr &widgetAbove)
 Changes which widget should become focused when navigating upwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationUp () const
 Returns which widget would become focused when navigating upwards from this widget.
 
void setNavigationDown (const Widget::Ptr &widgetBelow)
 Changes which widget should become focused when navigating downwards from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationDown () const
 Returns which widget would become focused when navigating downwards from this widget.
 
void setNavigationLeft (const Widget::Ptr &widgetLeft)
 Changes which widget should become focused when navigating to the left from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationLeft () const
 Returns which widget would become focused when navigating to the left from this widget.
 
void setNavigationRight (const Widget::Ptr &widgetRight)
 Changes which widget should become focused when navigating to the right from this widget.
 
TGUI_NODISCARD Widget::Ptr getNavigationRight () const
 Returns which widget would become focused when navigating to the right from this widget.
 
void finishAllAnimations ()
 Makes all animations of the widget finish immediately.
 
virtual TGUI_NODISCARD bool canGainFocus () const
 Returns whether the widget can currently gain focus.
 
TGUI_NODISCARD bool isContainer () const
 Returns whether the widget is a container widget or not.
 
TGUI_NODISCARD bool isDraggableWidget () const
 Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs)
 
TGUI_NODISCARD bool isMouseDown () const
 Returns whether the left mouse button has been pressed on top of the widget.
 
void setAutoLayoutUpdateEnabled (bool enabled)
 
virtual void mouseReleased (Event::MouseButton button, Vector2f pos)
 
TGUI_NODISCARD const Layout2dgetPositionLayout () const
 
TGUI_NODISCARD const Layout2dgetSizeLayout () const
 
void bindPositionLayout (Layout *layout)
 
void unbindPositionLayout (Layout *layout)
 
void bindSizeLayout (Layout *layout)
 
void unbindSizeLayout (Layout *layout)
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
TGUI_NODISCARD std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
void rendererChangedCallback (const String &property)
 

Static Public Member Functions

static TGUI_NODISCARD Panel::Ptr create (const Layout2d &size={"100%", "100%"})
 Creates a new panel widget.
 
static TGUI_NODISCARD Panel::Ptr copy (const Panel::ConstPtr &panel)
 Makes a copy of another panel.
 
- Static Public Member Functions inherited from tgui::Group
static TGUI_NODISCARD Group::Ptr create (const Layout2d &size={"100%", "100%"})
 Creates a new group.
 
static TGUI_NODISCARD Group::Ptr copy (const Group::ConstPtr &group)
 Makes a copy of another group.
 

Public Attributes

SignalVector2f onMousePress = {"MousePressed"}
 The mouse went down on the panel. Optional parameter: mouse position relative to panel.
 
SignalVector2f onMouseRelease = {"MouseReleased"}
 The mouse was released on top of the panel. Optional parameter: mouse position relative to panel.
 
SignalVector2f onClick = {"Clicked"}
 The panel was clicked. Optional parameter: mouse position relative to panel.
 
SignalVector2f onDoubleClick = {"DoubleClicked"}
 The panel was double clicked. Optional parameter: mouse position relative to panel.
 
SignalVector2f onRightMousePress = {"RightMousePressed"}
 The right mouse button went down on the panel. Optional parameter: mouse position relative to panel.
 
SignalVector2f onRightMouseRelease = {"RightMouseReleased"}
 The right mouse button was released on top of the panel. Optional parameter: mouse position relative to panel.
 
SignalVector2f onRightClick = {"RightClicked"}
 The panel was right clicked. Optional parameter: mouse position relative to panel.
 
- 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 onShowEffectFinish = {"ShowEffectFinished"}
 A show or hide effect finished. Optional parameters: effect type, new widget visibility or both.
 
SignalAnimationType onAnimationFinish = {"AnimationFinished"}
 An animation has finished.
 

Static Public Attributes

static constexpr const char StaticWidgetType [] = "Panel"
 Type name of the widget.
 
- Static Public Attributes inherited from tgui::Group
static constexpr const char StaticWidgetType [] = "Group"
 Type name of the widget.
 

Protected Member Functions

TGUI_NODISCARD SignalgetSignal (String signalName) override
 Retrieves a signal based on its name.
 
void rendererChanged (const String &property) override
 Function called when one of the properties of the renderer is changed.
 
bool updateTime (Duration elapsedTime) override
 
TGUI_NODISCARD 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
TGUI_NODISCARD 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.
 
void updateTextSize () override
 Called when the text size is changed (either by setTextSize or via the renderer)
 
TGUI_NODISCARD Widget::Ptr getWidgetBelowMouse (Vector2f mousePos) const
 
Widget::Ptr updateWidgetBelowMouse (Vector2f mousePos)
 
TGUI_NODISCARD std::size_t getFocusedWidgetIndex () const
 
bool tryFocusWidget (const Widget::Ptr &widget, bool reverseWidgetOrder, bool recursive)
 
TGUI_NODISCARD Vector2f transformMousePos (const Widget::Ptr &widget, Vector2f mousePos) const
 
void widgetAdded (const 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.
 
void recalculateBoundPositionLayouts ()
 Calls recalculateValue() on each layout in m_boundPositionLayouts.
 
void recalculateBoundSizeLayouts ()
 Calls recalculateValue() on each layout in m_boundSizeLayouts.
 

Protected Attributes

Borders m_bordersCached
 
Color m_borderColorCached
 
Color m_backgroundColorCached
 
Sprite m_spriteBackground
 
float m_roundedBorderRadius = 0
 
bool m_rightMouseDown = false
 
bool m_possibleDoubleClick = false
 
- 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
 
bool m_draggingWidget = false
 
Vector2f m_prevInnerSize
 
bool m_isolatedFocus = false
 
- Protected Attributes inherited from tgui::Widget
String m_type
 
String m_name
 
Layout2d m_position
 Stores the position of this widget.
 
Layout2d m_size
 Stores the size of this widget.
 
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
 Stores the flag indicating whether this widget is enabled.
 
bool m_visible = true
 Stores the flag indicating whether this widget is visible.
 
Containerm_parent = nullptr
 
BackendGuim_parentGui = nullptr
 
bool m_mouseHover = false
 
bool m_mouseDown = false
 
bool m_focused = false
 
bool m_focusable = true
 
std::weak_ptr< Widgetm_navWidgetUp
 
std::weak_ptr< Widgetm_navWidgetDown
 
std::weak_ptr< Widgetm_navWidgetRight
 
std::weak_ptr< Widgetm_navWidgetLeft
 
Duration m_animationTimeElapsed
 
bool m_containerWidget = false
 
Widget::Ptr m_toolTip = nullptr
 
aurora::CopiedPtr< WidgetRendererm_renderer = nullptr
 
std::vector< std::unique_ptr< priv::Animation > > m_showAnimations
 
Font m_inheritedFont
 
float m_inheritedOpacity = 1
 
Any m_userData
 
Cursor::Type m_mouseCursor = Cursor::Type::Arrow
 
AutoLayout m_autoLayout = AutoLayout::Manual
 
bool m_autoLayoutUpdateEnabled = true
 
Font m_fontCached = Font::getGlobalFont()
 
float m_opacityCached = 1
 
bool m_transparentTextureCached = false
 
unsigned int m_textSizeCached = 0
 

Additional Inherited Members

- 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

Group of widgets that has a background color and optional borders.

Member Function Documentation

◆ clone()

TGUI_NODISCARD Widget::Ptr tgui::Panel::clone ( ) const
overrideprotectedvirtual

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.

Reimplemented in tgui::PanelListBox, and tgui::ScrollablePanel.

◆ copy()

static TGUI_NODISCARD Panel::Ptr tgui::Panel::copy ( const Panel::ConstPtr panel)
static

Makes a copy of another panel.

Parameters
panelThe other panel
Returns
The new panel

◆ create()

static TGUI_NODISCARD Panel::Ptr tgui::Panel::create ( const Layout2d size = {"100%", "100%"})
static

Creates a new panel widget.

Parameters
sizeSize of the panel
Returns
The new panel

◆ draw()

void tgui::Panel::draw ( BackendRenderTarget target,
RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Reimplemented from tgui::Group.

Reimplemented in tgui::ScrollablePanel.

◆ getChildWidgetsOffset()

TGUI_NODISCARD Vector2f tgui::Panel::getChildWidgetsOffset ( ) const
overridevirtual

Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0)

Returns
Offset of the widgets in the container

Reimplemented from tgui::Group.

◆ getInnerSize()

TGUI_NODISCARD Vector2f tgui::Panel::getInnerSize ( ) const
overridevirtual

Returns the space available for widgets inside the container.

Returns
Size without borders and padding

Reimplemented from tgui::Group.

Reimplemented in tgui::ScrollablePanel.

◆ getRenderer()

TGUI_NODISCARD PanelRenderer * tgui::Panel::getRenderer ( )
overridevirtual

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.

Reimplemented from tgui::Group.

Reimplemented in tgui::PanelListBox, and tgui::ScrollablePanel.

◆ getSharedRenderer() [1/2]

TGUI_NODISCARD const PanelRenderer * tgui::Panel::getSharedRenderer ( ) const
overridevirtual

Reimplemented from tgui::Group.

◆ getSharedRenderer() [2/2]

TGUI_NODISCARD PanelRenderer * tgui::Panel::getSharedRenderer ( )
overridevirtual

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

Reimplemented from tgui::Group.

Reimplemented in tgui::PanelListBox, and tgui::ScrollablePanel.

◆ getSignal()

TGUI_NODISCARD Signal & tgui::Panel::getSignal ( String  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

Reimplemented in tgui::PanelListBox.

◆ isMouseOnWidget()

TGUI_NODISCARD bool tgui::Panel::isMouseOnWidget ( Vector2f  pos) const
overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns
Is the mouse on top of the widget?

Reimplemented from tgui::Group.

◆ leftMousePressed()

bool tgui::Panel::leftMousePressed ( Vector2f  pos)
overridevirtual

Called by the parent when the left mouse button goes down on top of the widget.

Parameters
posMouse position in view coordinates relative to the parent widget
Returns
True if the clicked part of the widget is draggable, i.e. if the widget should continue to receive mouse move events until the mouse is released, even when the mouse leaves the widget. When false is returned, the mouse move events will only be sent to the widget as long as the mouse is on top of the widget.

Reimplemented from tgui::Container.

Reimplemented in tgui::PanelListBox, and tgui::ScrollablePanel.

◆ leftMouseReleased()

void tgui::Panel::leftMouseReleased ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Container.

◆ rendererChanged()

void tgui::Panel::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::Group.

Reimplemented in tgui::PanelListBox, and tgui::ScrollablePanel.

◆ rightMouseButtonNoLongerDown()

void tgui::Panel::rightMouseButtonNoLongerDown ( )
overridevirtual

Reimplemented from tgui::Container.

◆ rightMousePressed()

void tgui::Panel::rightMousePressed ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Container.

◆ rightMouseReleased()

void tgui::Panel::rightMouseReleased ( Vector2f  pos)
overridevirtual

Reimplemented from tgui::Container.

◆ 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::Group.

Reimplemented in tgui::ScrollablePanel, tgui::PanelListBox, tgui::PanelListBox, and tgui::ScrollablePanel.

◆ setSize() [2/3]

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

Changes the size of the panel.

Parameters
sizeThe new size of the panel

Reimplemented from tgui::Group.

Reimplemented in tgui::ScrollablePanel, tgui::PanelListBox, tgui::PanelListBox, and tgui::ScrollablePanel.

◆ 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

◆ updateTime()

bool tgui::Panel::updateTime ( Duration  elapsedTime)
overrideprotectedvirtual

Reimplemented from tgui::Container.


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