TGUI
0.9.5
|
#include <TGUI/Container.hpp>
Public Types | |
typedef std::shared_ptr< Container > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const Container > | ConstPtr |
Shared constant widget pointer. | |
Public Types inherited from tgui::Widget | |
typedef std::shared_ptr< Widget > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const Widget > | ConstPtr |
Shared constant widget pointer. | |
Public Member Functions | |
Container (const char *typeName, bool initRenderer) | |
Container (const Container ©) | |
Copy constructor. | |
Container (Container &©) noexcept | |
Move constructor. | |
~Container () | |
Destructor. | |
Container & | operator= (const Container &right) |
Overload of copy assignment operator. | |
Container & | operator= (Container &&right) noexcept |
Overload of move assignment operator. | |
void | setSize (const Layout2d &size) override |
Changes the size of the container. | |
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. | |
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 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. | |
virtual Vector2f | getInnerSize () const |
Returns the space available for widgets inside the container. | |
virtual 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) | |
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) |
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::Widget | |
Widget (const char *typeName, bool initRenderer) | |
Widget (const Widget &) | |
Copy constructor. | |
Widget (Widget &&) | |
Move constructor. | |
virtual | ~Widget () |
Destructor. | |
Widget & | operator= (const Widget &) |
Overload of copy assignment operator. | |
Widget & | operator= (Widget &&) |
Move assignment. | |
void | setRenderer (std::shared_ptr< RendererData > rendererData) |
Sets a new renderer for the widget. The renderer determines how the widget looks. | |
WidgetRenderer * | getSharedRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const WidgetRenderer * | getSharedRenderer () const |
WidgetRenderer * | getRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
const WidgetRenderer * | getRenderer () 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 String & | getWidgetType () const |
Returns the type of the widget. | |
Container * | getParent () const |
Returns a pointer to the parent widget. | |
GuiBase * | getParentGui () 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 > | |
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 Font & | getInheritedFont () 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 Signal & | getSignal (String signalName) |
Retrieves a signal based on its name. | |
virtual bool | isMouseOnWidget (Vector2f pos) const =0 |
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. | |
virtual void | mousePressed (Event::MouseButton button, Vector2f pos) |
virtual void | mouseReleased (Event::MouseButton button, Vector2f pos) |
const Layout2d & | getPositionLayout () const |
const Layout2d & | getSizeLayout () 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. | |
virtual Widget::Ptr | clone () const =0 |
Makes a copy of the widget if you don't know its exact type. | |
Protected Member Functions | |
void | rendererChanged (const String &property) override |
Function called when one of the properties of the renderer is changed. | |
void | draw (BackendRenderTargetBase &target, RenderStates states) const override |
Draw the child widgets to a render target. | |
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 | |
std::vector< Widget::Ptr > | m_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< Vector2f > | m_rotationOrigin |
Optional< Vector2f > | m_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 |
Container * | m_parent = nullptr |
GuiBase * | m_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< WidgetRenderer > | m_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); } |
Friends | |
class | SubwidgetContainer |
Additional Inherited Members | |
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 > > |
Container widget.
Parent class for widgets that contain child widgets.
Signals:
|
virtual |
Adds a widget to the container.
widgetPtr | Pointer to the widget you would like to add |
widgetName | You can give the widget a unique name to retrieve it from the container later |
Reimplemented in tgui::BoxLayout, tgui::BoxLayoutRatios, and tgui::ScrollablePanel.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Draw the child widgets to a render target.
target | Render target to draw to |
states | Current render states |
Implements tgui::Widget.
Reimplemented in tgui::RootContainer, tgui::Group, tgui::Panel, tgui::RadioButtonGroup, and tgui::ScrollablePanel.
bool tgui::Container::focusNextWidget | ( | bool | recursive = true | ) |
Focuses the next widget in this container.
recursive | If the focused widget is a container, should the next widget inside it be focused instead of focusing the sibling of the container? |
bool tgui::Container::focusPreviousWidget | ( | bool | recursive = true | ) |
Focuses the previous widget in this container.
recursive | If the focused widget is a container, should the previous widget inside it be focused instead of focusing the sibling of the container? |
Widget::Ptr tgui::Container::get | ( | const String & | widgetName | ) | const |
Returns a pointer to a widget that was added earlier.
widgetName | The 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.
|
inline |
Returns a pointer to a widget that was added earlier.
widgetName | The 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.
|
inlinevirtual |
Returns the distance between the position of the container and a widget that would be drawn inside this container on relative position (0,0)
Reimplemented in tgui::ChildWindow, tgui::Group, and tgui::Panel.
Widget::Ptr tgui::Container::getFocusedChild | ( | ) | const |
Returns the child widget that is focused inside this container.
If the focused widget is a container then a pointer to that container is returned. If you want to know which widget is focused inside that container (recursively) then you should use the getFocusedLeaf() function.
Widget::Ptr tgui::Container::getFocusedLeaf | ( | ) | const |
Returns the leaf child widget that is focused inside this container.
If the focused widget is a container then the getFocusedLeaf() is recursively called on that container. If you want to limit the search to only direct children of this container then you should use the getFocusedChild() function.
|
virtual |
Returns the space available for widgets inside the container.
Reimplemented in tgui::ChildWindow, tgui::Group, and tgui::Panel.
|
virtual |
Returns the leaf child widget that is located at the given position.
pos | The location where the widget will be searched, relative to the container |
Reimplemented in tgui::ScrollablePanel.
int tgui::Container::getWidgetIndex | ( | const Widget::Ptr & | widget | ) | const |
Returns the current index of a widget in this container.
|
inline |
Returns a list of all the widgets in this container.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Loads the widget from a tree of nodes.
Reimplemented from tgui::Widget.
Reimplemented in tgui::FileDialog, tgui::Grid, tgui::MessageBox, and tgui::ScrollablePanel.
void tgui::Container::loadWidgetsFromFile | ( | const String & | filename, |
bool | replaceExisting = true |
||
) |
Loads the child widgets from a text file.
filename | Filename of the widget file |
replaceExisting | Remove existing widgets first if there are any |
Exception | when file could not be opened or parsing failed |
void tgui::Container::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.
rootNode | Root node of the tree |
replaceExisting | Remove existing widgets first if there are any |
This function is used internally by the other load functions.
void tgui::Container::loadWidgetsFromStream | ( | std::stringstream && | stream, |
bool | replaceExisting = true |
||
) |
Loads the child widgets from a string stream.
stream | stringstream that contains the widget file |
replaceExisting | Remove existing widgets first if there are any |
void tgui::Container::loadWidgetsFromStream | ( | std::stringstream & | stream, |
bool | replaceExisting = true |
||
) |
Loads the child widgets from a string stream.
stream | stringstream that contains the widget file |
replaceExisting | Remove existing widgets first if there are any |
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
std::size_t tgui::Container::moveWidgetBackward | ( | const Widget::Ptr & | widget | ) |
Places a widget one step backward in the z-order.
widget | The widget that should be moved one step backward |
std::size_t tgui::Container::moveWidgetForward | ( | const Widget::Ptr & | widget | ) |
Places a widget one step forward in the z-order.
widget | The widget that should be moved one step forward |
void tgui::Container::moveWidgetToBack | ( | const Widget::Ptr & | widget | ) |
Places a widget behind all other widgets, to the back of the z-order.
widget | The widget that should be moved to the back |
void tgui::Container::moveWidgetToFront | ( | const Widget::Ptr & | widget | ) |
Places a widget before all other widgets, to the front of the z-order.
widget | The widget that should be moved to the front |
bool tgui::Container::processKeyPressEvent | ( | Event::KeyEvent | event | ) |
Inform the container about a key press event.
event | Information on which key was pressed and the state of the modifier keys |
bool tgui::Container::processMouseMoveEvent | ( | Vector2f | pos | ) |
Inform the container about a mouse move event.
pos | Mouse position |
bool tgui::Container::processMousePressEvent | ( | Event::MouseButton | button, |
Vector2f | pos | ||
) |
Inform the container about a mouse press event.
button | Which mouse button has been pressed |
pos | Mouse position |
bool tgui::Container::processMouseReleaseEvent | ( | Event::MouseButton | button, |
Vector2f | pos | ||
) |
Inform the container about a mouse release event.
button | Which mouse button has been released |
pos | Mouse position |
bool tgui::Container::processMouseWheelScrollEvent | ( | float | delta, |
Vector2f | pos | ||
) |
Inform the container about a mouse wheel scroll event.
delta | Wheel offset (positive is up, negative is down). High-precision mice may use non-integral offsets. |
pos | Mouse position |
bool tgui::Container::processTextEnteredEvent | ( | char32_t | key | ) |
Inform the container about a key press event.
key | UTF-32 Unicode value of the character |
|
virtual |
Removes a single widget that was added to the container.
widget | Pointer to the widget to remove |
Reimplemented in tgui::BoxLayout, tgui::BoxLayoutRatios, tgui::Grid, and tgui::ScrollablePanel.
|
virtual |
Removes all widgets that were added to the container.
Reimplemented in tgui::BoxLayoutRatios, tgui::Grid, and tgui::ScrollablePanel.
|
overrideprotectedvirtual |
Function called when one of the properties of the renderer is changed.
property | Name of the property that was changed |
Reimplemented from tgui::Widget.
Reimplemented in tgui::FileDialog, tgui::Group, tgui::MessageBox, tgui::Panel, and tgui::ScrollablePanel.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Saves the widget as a tree node in order to save it to a file.
Reimplemented from tgui::Widget.
Reimplemented in tgui::FileDialog, tgui::Grid, tgui::MessageBox, and tgui::ScrollablePanel.
void tgui::Container::saveWidgetsToFile | ( | const String & | filename | ) |
Saves the child widgets to a text file.
filename | Filename of the widget file |
Exception | when file could not be opened for writing |
std::unique_ptr< DataIO::Node > tgui::Container::saveWidgetsToNodeTree | ( | const String & | rootDirectory = "" | ) | const |
Saves the child widgets to a tree of nodes that contain all information about the widgets.
rootDirectory | Directory to use as root when making paths relative. Empty to skip additional path conversion. |
This function is used internally by the other save functions.
void tgui::Container::saveWidgetsToStream | ( | std::stringstream & | stream, |
const String & | rootDirectory = "" |
||
) | const |
Saves the child widgets to a text file.
stream | stringstream to which the widget file will be added |
rootDirectory | Directory to use as root when making paths relative. Empty to skip additional path conversion. |
|
overridevirtual |
Focus or unfocus the widget.
focused | Is the widget focused? |
When a widget is focused, the previously focused widget will be unfocused.
Reimplemented from tgui::Widget.
Reimplemented in tgui::RootContainer.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
virtual |
Changes the size of the widget.
size | Size of the widget |
Usage examples:
Reimplemented from tgui::Widget.
Reimplemented in tgui::RootContainer, tgui::Grid, tgui::Group, tgui::Panel, tgui::ScrollablePanel, tgui::RootContainer, tgui::Grid, tgui::Group, tgui::Panel, and tgui::ScrollablePanel.
|
overridevirtual |
Changes the size of the container.
size | The new size of the container |
Reimplemented from tgui::Widget.
Reimplemented in tgui::RootContainer, tgui::Grid, tgui::Group, tgui::Panel, tgui::ScrollablePanel, tgui::RootContainer, tgui::Grid, tgui::Group, tgui::Panel, and tgui::ScrollablePanel.
Changes the size of the widget.
width | Width of the widget |
height | Height of the widget |
|
overridevirtual |
Changes the character size of all existing and future child widgets.
size | The new text size |
Reimplemented from tgui::Widget.
Reimplemented in tgui::MessageBox.
bool tgui::Container::setWidgetIndex | ( | const Widget::Ptr & | widget, |
std::size_t | index | ||
) |
Changes the index of a widget in this container.
Widgets are drawn in the order of the list, so overlapping widgets with a higher index will appear on top of others.
widget | Widget that is to be moved to a different index |
index | New index of the widget, corresponding to the widget position after the widget has been moved |
|
inline |
Sorts a list of all the widgets in this container.
function | Comparison function object (i.e. an object that satisfies the requirements of Compare) which returns true if the first argument is less than (i.e. is ordered before) the second. |
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.